detach_principal_policy(
policy_name: PolicyName,
principal: Principal,
*,
config_overrides: Optional[AsyncIoTClientConfig] = None,
) -> None
Removes the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
Parameters:
-
policy_name
(PolicyName)
–
The name of the policy to detach.
-
principal
(Principal)
–
The principal.
Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
Raises:
Source code in docs_src/capo_iot/_services/async_io_t.py
| async def detach_principal_policy(
self,
policy_name: "capo_iot.types.policy_name.PolicyName",
principal: "capo_iot.types.principal.Principal",
*,
config_overrides: Optional[AsyncIoTClientConfig] = None,
) -> None:
"""<p>Removes the specified policy from the specified certificate.</p> <p> <b>Note:</b> This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use <a>DetachPolicy</a> instead.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachPrincipalPolicy</a> action.</p>
Args:
policy_name: <p>The name of the policy to detach.</p>
principal: <p>The principal.</p> <p>Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iot.types.detach_principal_policy_request.DetachPrincipalPolicyRequest]",
) -> AsyncOperationResponse[None]:
import capo_iot._operations.aws_iot_service.detach_principal_policy
(
output,
http_response,
) = await capo_iot._operations.aws_iot_service.detach_principal_policy.async_detach_principal_policy(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DetachPrincipalPolicy")
)
input_: capo_iot.types.detach_principal_policy_request.DetachPrincipalPolicyRequest = {
"policy_name": policy_name,
"principal": principal,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|