Skip to content

list_annotation_import_jobs

list_annotation_import_jobs(
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    ids: Optional[IdList] = None,
    next_token: Optional[str] = None,
    filter: Optional[ListAnnotationImportJobsFilter] = None,
) -> ListAnnotationImportJobsResponse

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change.

Retrieves a list of annotation import jobs.

Parameters:

  • max_results (Optional[int], default: None ) –

    The maximum number of jobs to return in one page of results.

  • ids (Optional[IdList], default: None ) –

    IDs of annotation import jobs to retrieve.

  • next_token (Optional[str], default: None ) –

    Specifies the pagination token from a previous request to retrieve the next page of results.

  • filter (Optional[ListAnnotationImportJobsFilter], default: None ) –

    A filter to apply to the list.

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def list_annotation_import_jobs(
    self,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    ids: Optional["capo_omics.types.id_list.IdList"] = None,
    next_token: Optional[str] = None,
    filter: Optional[
        "capo_omics.types.list_annotation_import_jobs_filter.ListAnnotationImportJobsFilter"
    ] = None,
) -> "capo_omics.types.list_annotation_import_jobs_response.ListAnnotationImportJobsResponse":
    """<important> <p>Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html"> Amazon Web Services HealthOmics variant store and annotation store availability change</a>.</p> </important> <p>Retrieves a list of annotation import jobs.</p>

    Args:
        max_results: <p>The maximum number of jobs to return in one page of results.</p>
        ids: <p>IDs of annotation import jobs to retrieve.</p>
        next_token: <p>Specifies 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.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_annotation_import_jobs_request.ListAnnotationImportJobsRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_annotation_import_jobs_response.ListAnnotationImportJobsResponse"
    ]:
        import capo_omics._operations.omics.list_annotation_import_jobs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAnnotationImportJobs")
    )
    input_: capo_omics.types.list_annotation_import_jobs_request.ListAnnotationImportJobsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if ids is not None:
        input_["ids"] = ids
    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