detach_object ¶

def detach_object(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    parent_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    link_name: "capo_clouddirectory.types.link_name.LinkName",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
) -> "capo_clouddirectory.types.detach_object_response.DetachObjectResponse":
    """<p>Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.</p>

    Args:
        directory_arn: <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>
        parent_reference: <p>The parent reference from which the object with the specified link name is detached.</p>
        link_name: <p>The link name associated with the object that needs to 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_node_exception.NotNodeException: <p>Occurs when any invalid operations are performed on an object that is not a node, such as calling <code>ListObjectChildren</code> for a leaf node object.</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 an object from its parent object

        >>> client.detach_object(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', parent_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw'}, link_name='link2')
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.detach_object_request.DetachObjectRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.detach_object_response.DetachObjectResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.detach_object

        output, http_response = (
            capo_clouddirectory._operations.amazon_cloud_directory_20170111.detach_object.detach_object(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DetachObject")
    )
    input_: capo_clouddirectory.types.detach_object_request.DetachObjectRequest = {
        "directory_arn": directory_arn,
        "parent_reference": parent_reference,
        "link_name": link_name,
    }

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