get_read_set_metadata ¶

get_read_set_metadata(
    id: ReadSetId,
    sequence_store_id: SequenceStoreId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> GetReadSetMetadataResponse

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Parameters:

id (ReadSetId) –

The read set's ID.
sequence_store_id (SequenceStoreId) –

The read set's sequence store ID.

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 get_read_set_metadata(
    self,
    id: "capo_omics.types.read_set_id.ReadSetId",
    sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> "capo_omics.types.get_read_set_metadata_response.GetReadSetMetadataResponse":
    """<p>Retrieves the metadata for a read set from a sequence store in JSON format. 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 read set's ID.</p>
        sequence_store_id: <p>The read set's sequence 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_read_set_metadata_request.GetReadSetMetadataRequest]",
    ) -> OperationResponse[
        "capo_omics.types.get_read_set_metadata_response.GetReadSetMetadataResponse"
    ]:
        import capo_omics._operations.omics.get_read_set_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetReadSetMetadata")
    )
    input_: capo_omics.types.get_read_set_metadata_request.GetReadSetMetadataRequest = {
        "id": id,
        "sequence_store_id": sequence_store_id,
    }

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