list_attached_indices ¶

def list_attached_indices(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    target_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
    next_token: Optional["capo_clouddirectory.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_clouddirectory.types.number_results.NumberResults"
    ] = None,
    consistency_level: Optional[
        "capo_clouddirectory.types.consistency_level.ConsistencyLevel"
    ] = None,
) -> "capo_clouddirectory.types.list_attached_indices_response.ListAttachedIndicesResponse":
    """<p>Lists indices attached to the specified object.</p>

    Args:
        directory_arn: <p>The ARN of the directory.</p>
        target_reference: <p>A reference to the object that has indices attached.</p>
        next_token: <p>The pagination token.</p>
        max_results: <p>The maximum number of results to retrieve.</p>
        consistency_level: <p>The consistency level to use for this operation.</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.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 list the indices attached to an object

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

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.list_attached_indices_request.ListAttachedIndicesRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.list_attached_indices_response.ListAttachedIndicesResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_attached_indices

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAttachedIndices")
    )
    input_: capo_clouddirectory.types.list_attached_indices_request.ListAttachedIndicesRequest = {
        "directory_arn": directory_arn,
        "target_reference": target_reference,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if consistency_level is not None:
        input_["consistency_level"] = consistency_level

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