Skip to content

get_automated_reasoning_policy_build_workflow

Operation

get_automated_reasoning_policy_build_workflow

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyBuildWorkflowInput | GetAutomatedReasoningPolicyBuildWorkflowInputDict | 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[GetAutomatedReasoningPolicyBuildWorkflowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyBuildWorkflowOutput

An instance of GetAutomatedReasoningPolicyBuildWorkflowOutput.

get_automated_reasoning_policy_build_workflow async

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyBuildWorkflowInput | GetAutomatedReasoningPolicyBuildWorkflowInputDict | 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[GetAutomatedReasoningPolicyBuildWorkflowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyBuildWorkflowOutput

An instance of GetAutomatedReasoningPolicyBuildWorkflowOutput.

Input

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

GetAutomatedReasoningPolicyBuildWorkflowInputDict

Bases: TypedDict

Dictionary form of GetAutomatedReasoningPolicyBuildWorkflowInput.

Attributes

build_workflow_id instance-attribute
build_workflow_id: Required[str]

The unique identifier of the build workflow to retrieve.

policy_arn instance-attribute
policy_arn: Required[str]

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

GetAutomatedReasoningPolicyBuildWorkflowInput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyBuildWorkflowInput structure.

Attributes

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

The unique identifier of the build workflow to retrieve.

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

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

Output

GetAutomatedReasoningPolicyBuildWorkflowOutput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyBuildWorkflowOutput structure.

Attributes

build_workflow_id instance-attribute
build_workflow_id: str

The unique identifier of the build workflow.

build_workflow_type instance-attribute
build_workflow_type: str

The type of build workflow being executed (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).

created_at instance-attribute
created_at: datetime

The timestamp when the build workflow was created.

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

The content type of the source document (e.g., text/plain, application/pdf).

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

A detailed description of the document's content and how it should be used in the policy generation process.

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

The name of the source document used in the build workflow.

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.

status instance-attribute
status: str

The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).

updated_at instance-attribute
updated_at: datetime

The timestamp when the build workflow was last updated.