Skip to content

get_policy_engine

Operation

get_policy_engine

get_policy_engine(request: GetPolicyEngineInput | GetPolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyEngineInputDict]) -> GetPolicyEngineOutput

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

Parameters:

Name Type Description Default
request GetPolicyEngineInput | GetPolicyEngineInputDict | 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[GetPolicyEngineInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyEngineOutput

An instance of GetPolicyEngineOutput.

get_policy_engine async

get_policy_engine(request: GetPolicyEngineInput | GetPolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyEngineInputDict]) -> GetPolicyEngineOutput

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

Parameters:

Name Type Description Default
request GetPolicyEngineInput | GetPolicyEngineInputDict | 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[GetPolicyEngineInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyEngineOutput

An instance of GetPolicyEngineOutput.

Input

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

GetPolicyEngineInputDict

Bases: TypedDict

Dictionary form of GetPolicyEngineInput.

Attributes

policy_engine_id instance-attribute
policy_engine_id: Required[str]

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

GetPolicyEngineInput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyEngineInput structure.

Attributes

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

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

Output

GetPolicyEngineOutput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyEngineOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the policy engine was originally created.

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

The human-readable description of the policy engine's purpose and scope. This helps administrators understand the policy engine's role in governance.

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

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

name instance-attribute
name: str

The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.

policy_engine_arn instance-attribute
policy_engine_arn: str

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

policy_engine_id instance-attribute
policy_engine_id: str

The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.

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 policy engine.

status_reasons instance-attribute
status_reasons: list[str]

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.

updated_at instance-attribute
updated_at: datetime

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.