Skip to content

get_automated_reasoning_policy_annotations

Operation

get_automated_reasoning_policy_annotations

Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyAnnotationsInput | GetAutomatedReasoningPolicyAnnotationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAutomatedReasoningPolicyAnnotationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyAnnotationsOutput

An instance of GetAutomatedReasoningPolicyAnnotationsOutput.

get_automated_reasoning_policy_annotations async

Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyAnnotationsInput | GetAutomatedReasoningPolicyAnnotationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAutomatedReasoningPolicyAnnotationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyAnnotationsOutput

An instance of GetAutomatedReasoningPolicyAnnotationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAutomatedReasoningPolicyAnnotationsInputDict

Bases: TypedDict

Dictionary form of GetAutomatedReasoningPolicyAnnotationsInput.

Attributes

build_workflow_id instance-attribute
build_workflow_id: Required[str]

The unique identifier of the build workflow whose annotations you want to retrieve.

policy_arn instance-attribute
policy_arn: Required[str]

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.

GetAutomatedReasoningPolicyAnnotationsInput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyAnnotationsInput structure.

Attributes

build_workflow_id class-attribute instance-attribute
build_workflow_id: str | None = ...

The unique identifier of the build workflow whose annotations you want to retrieve.

policy_arn class-attribute instance-attribute
policy_arn: str | None = ...

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.

Output

GetAutomatedReasoningPolicyAnnotationsOutput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyAnnotationsOutput structure.

Attributes

annotation_set_hash instance-attribute
annotation_set_hash: str

A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations.

annotations instance-attribute

The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy.

build_workflow_id instance-attribute
build_workflow_id: str

The unique identifier of the build workflow.

name instance-attribute
name: str

The name of the Automated Reasoning policy.

policy_arn instance-attribute
policy_arn: str

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

updated_at instance-attribute
updated_at: datetime

The timestamp when the annotations were last updated.