start_automated_reasoning_policy_build_workflow¶
Operation¶
start_automated_reasoning_policy_build_workflow
¶
start_automated_reasoning_policy_build_workflow(request: StartAutomatedReasoningPolicyBuildWorkflowInput | StartAutomatedReasoningPolicyBuildWorkflowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartAutomatedReasoningPolicyBuildWorkflowInputDict]) -> StartAutomatedReasoningPolicyBuildWorkflowOutput
Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartAutomatedReasoningPolicyBuildWorkflowInput | StartAutomatedReasoningPolicyBuildWorkflowInputDict | 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[StartAutomatedReasoningPolicyBuildWorkflowInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartAutomatedReasoningPolicyBuildWorkflowOutput
|
An instance of |
start_automated_reasoning_policy_build_workflow
async
¶
start_automated_reasoning_policy_build_workflow(request: StartAutomatedReasoningPolicyBuildWorkflowInput | StartAutomatedReasoningPolicyBuildWorkflowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartAutomatedReasoningPolicyBuildWorkflowInputDict]) -> StartAutomatedReasoningPolicyBuildWorkflowOutput
Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartAutomatedReasoningPolicyBuildWorkflowInput | StartAutomatedReasoningPolicyBuildWorkflowInputDict | 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[StartAutomatedReasoningPolicyBuildWorkflowInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartAutomatedReasoningPolicyBuildWorkflowOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StartAutomatedReasoningPolicyBuildWorkflowInputDict
¶
Bases: TypedDict
Dictionary form of StartAutomatedReasoningPolicyBuildWorkflowInput.
Attributes¶
build_workflow_type
instance-attribute
¶
The type of build workflow to start (e.g., DOCUMENT_INGESTION for processing new documents, POLICY_REPAIR for fixing existing policies).
client_request_token
instance-attribute
¶
client_request_token: str | None
A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
This field is autopopulated if not provided.
policy_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.
source_content
instance-attribute
¶
source_content: Required[AutomatedReasoningPolicyBuildWorkflowSource | AutomatedReasoningPolicyBuildWorkflowSourceDict]
The source content for the build workflow, such as documents to analyze or repair instructions for existing policies.
StartAutomatedReasoningPolicyBuildWorkflowInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartAutomatedReasoningPolicyBuildWorkflowInput structure.
Attributes¶
build_workflow_type
class-attribute
instance-attribute
¶
build_workflow_type: str | None = ...
The type of build workflow to start (e.g., DOCUMENT_INGESTION for processing new documents, POLICY_REPAIR for fixing existing policies).
client_request_token
class-attribute
instance-attribute
¶
client_request_token: str | None = ...
A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
This field is autopopulated if not provided.
policy_arn
class-attribute
instance-attribute
¶
policy_arn: str | None = ...
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.
source_content
class-attribute
instance-attribute
¶
source_content: AutomatedReasoningPolicyBuildWorkflowSource | None = ...
The source content for the build workflow, such as documents to analyze or repair instructions for existing policies.
Output¶
StartAutomatedReasoningPolicyBuildWorkflowOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartAutomatedReasoningPolicyBuildWorkflowOutput structure.
Attributes¶
build_workflow_id
instance-attribute
¶
build_workflow_id: str
The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results.
policy_arn
instance-attribute
¶
policy_arn: str
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
response_metadata
class-attribute
instance-attribute
¶
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.