start_jobs_query ¶

def start_jobs_query(
    self,
    *,
    config_overrides: Optional[MediaConvertClientConfig] = None,
    filter_list: Optional[
        "capo_mediaconvert.types.__list_of_jobs_query_filter.__listOfJobsQueryFilter"
    ] = None,
    max_results: Optional[
        "capo_mediaconvert.types.__integer_min1_max20.__integerMin1Max20"
    ] = None,
    next_token: Optional["capo_mediaconvert.types.__string.__string"] = None,
    order: Optional["capo_mediaconvert.types.order.Order"] = None,
) -> "capo_mediaconvert.types.start_jobs_query_response.StartJobsQueryResponse":
    """Start an asynchronous jobs query using the provided filters. To receive the list of jobs that match your query, call the GetJobsQueryResults API using the query ID returned by this API.

    Args:
        filter_list: Optional. Provide an array of JobsQueryFilters for your StartJobsQuery request.
        max_results: Optional. Number of jobs, up to twenty, that will be included in the jobs query.
        next_token: Use this string to request the next batch of jobs matched by a jobs query.
        order: Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

    Raises:
        capo_mediaconvert.errors.bad_request_exception.BadRequestException: The service can't process your request because of a problem in the request. Please check your request form and syntax.
        capo_mediaconvert.errors.conflict_exception.ConflictException: The service couldn't complete your request because there is a conflict with the current state of the resource.
        capo_mediaconvert.errors.forbidden_exception.ForbiddenException: You don't have permissions for this action with the credentials you sent.
        capo_mediaconvert.errors.internal_server_error_exception.InternalServerErrorException: The service encountered an unexpected condition and can't fulfill your request.
        capo_mediaconvert.errors.not_found_exception.NotFoundException: The resource you requested doesn't exist.
        capo_mediaconvert.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: You attempted to create more resources than the service allows based on service quotas.
        capo_mediaconvert.errors.too_many_requests_exception.TooManyRequestsException: Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.
        capo_mediaconvert.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediaconvert.types.start_jobs_query_request.StartJobsQueryRequest]",
    ) -> OperationResponse[
        "capo_mediaconvert.types.start_jobs_query_response.StartJobsQueryResponse"
    ]:
        import capo_mediaconvert._operations.media_convert.start_jobs_query

        output, http_response = (
            capo_mediaconvert._operations.media_convert.start_jobs_query.start_jobs_query(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartJobsQuery")
    )
    input_: capo_mediaconvert.types.start_jobs_query_request.StartJobsQueryRequest = {}
    if filter_list is not None:
        input_["filter_list"] = filter_list
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if order is not None:
        input_["order"] = order

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