Activates an archived read set and returns its metadata in a JSON formatted output. Amazon Web Services HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation.
To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.
Parameters:
Raises:
Source code in docs_src/capo_omics/_services/omics.py
| def start_read_set_activation_job(
self,
sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId",
sources: "capo_omics.types.start_read_set_activation_job_source_list.StartReadSetActivationJobSourceList",
*,
config_overrides: Optional[OmicsClientConfig] = None,
client_token: Optional["capo_omics.types.client_token.ClientToken"] = None,
) -> "capo_omics.types.start_read_set_activation_job_response.StartReadSetActivationJobResponse":
"""<p>Activates an archived read set and returns its metadata in a JSON formatted output. Amazon Web Services HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the <code>GetReadSetActivationJob</code> operation.</p> <p>To learn more, see <a href="https://docs.aws.amazon.com/omics/latest/dev/activating-read-sets.html">Activating read sets</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
Args:
sequence_store_id: <p>The read set's sequence store ID.</p>
client_token: <p>To ensure that jobs don't run multiple times, specify a unique token for each job.</p>
sources: <p>The job's source files.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</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.start_read_set_activation_job_request.StartReadSetActivationJobRequest]",
) -> OperationResponse[
"capo_omics.types.start_read_set_activation_job_response.StartReadSetActivationJobResponse"
]:
import capo_omics._operations.omics.start_read_set_activation_job
output, http_response = (
capo_omics._operations.omics.start_read_set_activation_job.start_read_set_activation_job(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StartReadSetActivationJob")
)
input_: capo_omics.types.start_read_set_activation_job_request.StartReadSetActivationJobRequest = {
"sequence_store_id": sequence_store_id,
"sources": sources,
}
if client_token is not None:
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|