attach_to_index ¶

def attach_to_index(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    index_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    target_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
) -> "capo_clouddirectory.types.attach_to_index_response.AttachToIndexResponse":
    """<p>Attaches the specified object to the specified index.</p>

    Args:
        directory_arn: <p>The Amazon Resource Name (ARN) of the directory where the object and index exist.</p>
        index_reference: <p>A reference to the index that you are attaching the object to.</p>
        target_reference: <p>A reference to the object that you are attaching to the index.</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.indexed_attribute_missing_exception.IndexedAttributeMissingException: <p>An object has been attempted to be attached to an object that does not have the appropriate attribute value.</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.invalid_attachment_exception.InvalidAttachmentException: <p>Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.</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.link_name_already_in_use_exception.LinkNameAlreadyInUseException: <p>Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.</p>
        capo_clouddirectory.errors.not_index_exception.NotIndexException: <p>Indicates that the requested operation can only operate on index 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 attach a index to an object

        >>> client.attach_to_index(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', index_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q'}, target_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw'})
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.attach_to_index_request.AttachToIndexRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.attach_to_index_response.AttachToIndexResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.attach_to_index

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AttachToIndex")
    )
    input_: capo_clouddirectory.types.attach_to_index_request.AttachToIndexRequest = {
        "directory_arn": directory_arn,
        "index_reference": index_reference,
        "target_reference": target_reference,
    }

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