Detaches a policy from an object.
Parameters:
-
directory_arn
(Arn)
–
The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.
-
policy_reference
(ObjectReference)
–
Reference that identifies the policy object.
-
object_reference
(ObjectReference)
–
Reference that identifies the object whose policy object will be detached.
Raises:
-
AccessDeniedException
–
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
-
DirectoryNotEnabledException
–
Operations are only permitted on enabled directories.
-
InternalServiceException
–
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
-
InvalidArnException
–
Indicates that the provided ARN value is not valid.
-
LimitExceededException
–
Indicates that limits are exceeded. See Limits for more information.
-
NotPolicyException
–
Indicates that the requested operation can only operate on policy objects.
-
ResourceNotFoundException
–
The specified resource could not be found.
-
RetryableConflictException
–
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
-
ValidationException
–
Indicates that your request is malformed in some manner. See the exception message.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
To detach a policy from an object
>>> client.detach_policy(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', policy_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew'}, object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw'})
Source code in docs_src/capo_clouddirectory/_services/cloud_directory.py
| def detach_policy(
self,
directory_arn: "capo_clouddirectory.types.arn.Arn",
policy_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
object_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
*,
config_overrides: Optional[CloudDirectoryClientConfig] = None,
) -> "capo_clouddirectory.types.detach_policy_response.DetachPolicyResponse":
"""<p>Detaches a policy from an object.</p>
Args:
directory_arn: <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>
policy_reference: <p>Reference that identifies the policy object.</p>
object_reference: <p>Reference that identifies the object whose policy object will be detached.</p>
Raises:
capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
capo_clouddirectory.errors.directory_not_enabled_exception.DirectoryNotEnabledException: <p>Operations are only permitted on enabled directories.</p>
capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
capo_clouddirectory.errors.not_policy_exception.NotPolicyException: <p>Indicates that the requested operation can only operate on policy objects.</p>
capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To detach a policy from an object
>>> client.detach_policy(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', policy_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew'}, object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw'})
"""
def _handler(
req: "OperationRequest[capo_clouddirectory.types.detach_policy_request.DetachPolicyRequest]",
) -> OperationResponse[
"capo_clouddirectory.types.detach_policy_response.DetachPolicyResponse"
]:
import capo_clouddirectory._operations.amazon_cloud_directory_20170111.detach_policy
output, http_response = (
capo_clouddirectory._operations.amazon_cloud_directory_20170111.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_clouddirectory.types.detach_policy_request.DetachPolicyRequest = {
"directory_arn": directory_arn,
"policy_reference": policy_reference,
"object_reference": object_reference,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|