delete_policy `async` ¶

delete_policy(
    policy_store_id: PolicyStoreId,
    policy_id: PolicyId,
    *,
    config_overrides: Optional[AsyncVerifiedPermissionsClientConfig] = None,
) -> DeletePolicyOutput

Deletes the specified policy from the policy store.

This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful HTTP 200 status code.

Parameters:

policy_store_id (PolicyStoreId) –
Specifies the ID of the policy store that contains the policy that you want to delete.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:
- ID: PSEXAMPLEabcdefg111111
- Alias name: policy-store-alias/example-policy-store
To view aliases, use ListPolicyStoreAliases.
policy_id (PolicyId) –
Specifies the ID of the policy that you want to delete.

You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:
- ID: SPEXAMPLEabcdefg111111
- Name: name/example-policy

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action.
InternalServerException –

The request failed because of an internal error. Try your request again later
ThrottlingException –

The request failed because it exceeded a throttling quota.
ValidationException –
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.

The possible reasons include the following:
- UnrecognizedEntityType
  
  The policy includes an entity type that isn't found in the schema.
- UnrecognizedActionId
  
  The policy includes an action id that isn't found in the schema.
- InvalidActionApplication
  
  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
- UnexpectedType
  
  The policy included an operand that isn't a valid type for the specified operation.
- IncompatibleTypes
  
  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.
- MissingAttribute
  
  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 has (presence of attribute test) operator in the Cedar Policy Language Guide.
- UnsafeOptionalAttributeAccess
  
  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 has (presence of attribute test) operator in the Cedar Policy Language Guide.
- ImpossiblePolicy
  
  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.
- WrongNumberArguments
  
  The policy references an extension type with the wrong number of arguments.
- FunctionArgumentValidationError
  
  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.
ConflictException –

The request failed because another request to modify a resource occurred at the same time.
ResourceNotFoundException –

The request failed because it references a resource that doesn't exist.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a policy The following example deletes the specified policy from its policy store.

>>> await client.delete_policy(policy_id='9wYxMpljbbZQb5fcZHyJhY', policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')

Source code in docs_src/capo_verifiedpermissions/_services/async_verified_permissions.py

async def delete_policy(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    policy_id: "capo_verifiedpermissions.types.policy_id.PolicyId",
    *,
    config_overrides: Optional[AsyncVerifiedPermissionsClientConfig] = None,
) -> "capo_verifiedpermissions.types.delete_policy_output.DeletePolicyOutput":
    """<p>Deletes the specified policy from the policy store.</p> <p>This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful <code>HTTP 200</code> status code.</p>

    Args:
        policy_store_id: <p>Specifies the ID of the policy store that contains the policy that you want to delete.</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_id: <p>Specifies the ID of the policy that you want to delete.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</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.conflict_exception.ConflictException: <p>The request failed because another request to modify a resource occurred at the same time.</p>
        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:
        To delete a policy
        The following example deletes the specified policy from its policy store.

        >>> await client.delete_policy(policy_id='9wYxMpljbbZQb5fcZHyJhY', policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_verifiedpermissions.types.delete_policy_input.DeletePolicyInput]",
    ) -> AsyncOperationResponse[
        "capo_verifiedpermissions.types.delete_policy_output.DeletePolicyOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.delete_policy

        (
            output,
            http_response,
        ) = await capo_verifiedpermissions._operations.verified_permissions.delete_policy.async_delete_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePolicy")
    )
    input_: capo_verifiedpermissions.types.delete_policy_input.DeletePolicyInput = {
        "policy_store_id": policy_store_id,
        "policy_id": policy_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_policy async ¶

delete_policy `async` ¶