get_policy_template ¶

def get_policy_template(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    policy_template_id: "capo_verifiedpermissions.types.policy_template_id.PolicyTemplateId",
    *,
    config_overrides: Optional[VerifiedPermissionsClientConfig] = None,
) -> "capo_verifiedpermissions.types.get_policy_template_output.GetPolicyTemplateOutput":
    """<p>Retrieve the details for the specified policy template in the specified policy store.</p>

    Args:
        policy_store_id: <p>Specifies the ID of the policy store that contains the policy template that you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
        policy_template_id: <p>Specifies the ID of the policy template that you want information about.</p> <p>You can use the policy template name in place of the policy template ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>PTEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy-template</code> </p> </li> </ul>

    Raises:
        capo_verifiedpermissions.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_verifiedpermissions.errors.internal_server_exception.InternalServerException: <p>The request failed because of an internal error. Try your request again later</p>
        capo_verifiedpermissions.errors.throttling_exception.ThrottlingException: <p>The request failed because it exceeded a throttling quota.</p>
        capo_verifiedpermissions.errors.validation_exception.ValidationException: <p>The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.</p> </li> </ul>
        capo_verifiedpermissions.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request failed because it references a resource that doesn't exist.</p>
        capo_verifiedpermissions.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        GetPolicyTemplate
        The following example displays the details of the specified policy template.

        >>> client.get_policy_template(policy_store_id='C7v5xMplfFH3i3e4Jrzb1a', policy_template_id='PTEXAMPLEabcdefg111111')
        To retrieve a policy template by name
        The following example retrieves the details of a policy template using its name instead of its ID.

        >>> client.get_policy_template(policy_store_id='C7v5xMplfFH3i3e4Jrzb1a', policy_template_id='name/example-policy-template')
    """

    def _handler(
        req: "OperationRequest[capo_verifiedpermissions.types.get_policy_template_input.GetPolicyTemplateInput]",
    ) -> OperationResponse[
        "capo_verifiedpermissions.types.get_policy_template_output.GetPolicyTemplateOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.get_policy_template

        output, http_response = (
            capo_verifiedpermissions._operations.verified_permissions.get_policy_template.get_policy_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_verifiedpermissions.types.get_policy_template_output.GetPolicyTemplateOutput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.get_policy_template_output

        return capo_verifiedpermissions.types.get_policy_template_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetPolicyTemplate", redact_output=_redact_output),
    )
    input_: capo_verifiedpermissions.types.get_policy_template_input.GetPolicyTemplateInput = {
        "policy_store_id": policy_store_id,
        "policy_template_id": policy_template_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output