Skip to content

get_reference_metadata

get_reference_metadata(
    id: ReferenceId,
    reference_store_id: ReferenceStoreId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> GetReferenceMetadataResponse

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def get_reference_metadata(
    self,
    id: "capo_omics.types.reference_id.ReferenceId",
    reference_store_id: "capo_omics.types.reference_store_id.ReferenceStoreId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> (
    "capo_omics.types.get_reference_metadata_response.GetReferenceMetadataResponse"
):
    """<p>Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the <code>ListTagsForResource</code> API operation.</p>

    Args:
        id: <p>The reference's ID.</p>
        reference_store_id: <p>The reference's reference store ID.</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.get_reference_metadata_request.GetReferenceMetadataRequest]",
    ) -> OperationResponse[
        "capo_omics.types.get_reference_metadata_response.GetReferenceMetadataResponse"
    ]:
        import capo_omics._operations.omics.get_reference_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetReferenceMetadata")
    )
    input_: capo_omics.types.get_reference_metadata_request.GetReferenceMetadataRequest = {
        "id": id,
        "reference_store_id": reference_store_id,
    }

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