Skip to content

get_automated_reasoning_policy

Operation

get_automated_reasoning_policy

get_automated_reasoning_policy(request: GetAutomatedReasoningPolicyInput | GetAutomatedReasoningPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAutomatedReasoningPolicyInputDict]) -> GetAutomatedReasoningPolicyOutput

Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyInput | GetAutomatedReasoningPolicyInputDict | 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[GetAutomatedReasoningPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyOutput

An instance of GetAutomatedReasoningPolicyOutput.

get_automated_reasoning_policy async

get_automated_reasoning_policy(request: GetAutomatedReasoningPolicyInput | GetAutomatedReasoningPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAutomatedReasoningPolicyInputDict]) -> GetAutomatedReasoningPolicyOutput

Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.

Parameters:

Name Type Description Default
request GetAutomatedReasoningPolicyInput | GetAutomatedReasoningPolicyInputDict | 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[GetAutomatedReasoningPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAutomatedReasoningPolicyOutput

An instance of GetAutomatedReasoningPolicyOutput.

Input

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

GetAutomatedReasoningPolicyInputDict

Bases: TypedDict

Dictionary form of GetAutomatedReasoningPolicyInput.

Attributes

policy_arn instance-attribute
policy_arn: Required[str]

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

GetAutomatedReasoningPolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyInput structure.

Attributes

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

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

Output

GetAutomatedReasoningPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for GetAutomatedReasoningPolicyOutput structure.

Attributes

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The timestamp when the policy was created.

definition_hash instance-attribute
definition_hash: str

The hash of the policy definition used as a concurrency token.

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

The description of the policy.

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

The Amazon Resource Name (ARN) of the KMS key used to encrypt the automated reasoning policy and its associated artifacts. If a KMS key is not provided during the initial CreateAutomatedReasoningPolicyRequest, the kmsKeyArn won't be included in the GetAutomatedReasoningPolicyResponse.

name instance-attribute
name: str

The name of the policy.

policy_arn instance-attribute
policy_arn: str

The Amazon Resource Name (ARN) of the policy.

policy_id instance-attribute
policy_id: str

The unique identifier of the 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 policy was last updated.

version instance-attribute
version: str

The version of the policy.