Skip to content

detach_policy

detach_policy(
    policy_name: PolicyName,
    target: PolicyTarget,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> None

Detaches a policy from the specified target.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DetachPolicy action.

Parameters:

  • policy_name (PolicyName) –

    The policy to detach.

  • target (PolicyTarget) –

    The target from which the policy will be detached.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def detach_policy(
    self,
    policy_name: "capo_iot.types.policy_name.PolicyName",
    target: "capo_iot.types.policy_target.PolicyTarget",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> None:
    """<p>Detaches a policy from the specified target.</p> <note> <p>Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.</p> </note> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachPolicy</a> action.</p>

    Args:
        policy_name: <p>The policy to detach.</p>
        target: <p>The target from which the policy will be detached.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.limit_exceeded_exception.LimitExceededException: <p>A limit has been exceeded.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.detach_policy_request.DetachPolicyRequest]",
    ) -> OperationResponse[None]:
        import capo_iot._operations.aws_iot_service.detach_policy

        output, http_response = (
            capo_iot._operations.aws_iot_service.detach_policy.detach_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DetachPolicy")
    )
    input_: capo_iot.types.detach_policy_request.DetachPolicyRequest = {
        "policy_name": policy_name,
        "target": target,
    }

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