list_references ¶

list_references(
    reference_store_id: ReferenceStoreId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
    filter: Optional[ReferenceFilter] = None,
) -> ListReferencesResponse

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Parameters:

reference_store_id (ReferenceStoreId) –

The references' reference store ID.
max_results (Optional[int], default: None ) –

The maximum number of references to return in one page of results.
next_token (Optional[NextToken], default: None ) –

Specify the pagination token from a previous request to retrieve the next page of results.
filter (Optional[ReferenceFilter], default: None ) –

A filter to apply to the list.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

An unexpected error occurred. Try the request again.
RequestTimeoutException –

The request timed out.
ResourceNotFoundException –

The target resource was not found in the current Region.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_omics/_services/omics.py

def list_references(
    self,
    reference_store_id: "capo_omics.types.reference_store_id.ReferenceStoreId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_omics.types.next_token.NextToken"] = None,
    filter: Optional["capo_omics.types.reference_filter.ReferenceFilter"] = None,
) -> "capo_omics.types.list_references_response.ListReferencesResponse":
    """<p>Retrieves the metadata of one or more reference genomes in a reference store.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html">Creating a reference store</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        reference_store_id: <p>The references' reference store ID.</p>
        max_results: <p>The maximum number of references to return in one page of results.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        filter: <p>A filter to apply to the list.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.list_references_request.ListReferencesRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_references_response.ListReferencesResponse"
    ]:
        import capo_omics._operations.omics.list_references

        output, http_response = (
            capo_omics._operations.omics.list_references.list_references(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReferences")
    )
    input_: capo_omics.types.list_references_request.ListReferencesRequest = {
        "reference_store_id": reference_store_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filter is not None:
        input_["filter"] = filter

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