Skip to content

list_batch_job_executions

list_batch_job_executions(
    application_id: Identifier,
    *,
    config_overrides: Optional[m2ClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    execution_ids: Optional[IdentifierList] = None,
    job_name: Optional[String100] = None,
    status: Optional[BatchJobExecutionStatus] = None,
    started_after: Optional[Timestamp] = None,
    started_before: Optional[Timestamp] = None,
) -> ListBatchJobExecutionsResponse

Lists historical, current, and scheduled batch job executions for a specific application.

Parameters:

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

    A pagination token to control the number of batch job executions displayed in the list.

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

    The maximum number of batch job executions to return.

  • application_id (Identifier) –

    The unique identifier of the application.

  • execution_ids (Optional[IdentifierList], default: None ) –

    The unique identifier of each batch job execution.

  • job_name (Optional[String100], default: None ) –

    The name of each batch job execution.

  • status (Optional[BatchJobExecutionStatus], default: None ) –

    The status of the batch job executions.

  • started_after (Optional[Timestamp], default: None ) –

    The time after which the batch job executions started.

  • started_before (Optional[Timestamp], default: None ) –

    The time before the batch job executions started.

Raises:

Source code in docs_src/capo_m2/_services/m2.py
def list_batch_job_executions(
    self,
    application_id: "capo_m2.types.identifier.Identifier",
    *,
    config_overrides: Optional[m2ClientConfig] = None,
    next_token: Optional["capo_m2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_m2.types.max_results.MaxResults"] = None,
    execution_ids: Optional["capo_m2.types.identifier_list.IdentifierList"] = None,
    job_name: Optional["capo_m2.types.string100.String100"] = None,
    status: Optional[
        "capo_m2.types.batch_job_execution_status.BatchJobExecutionStatus"
    ] = None,
    started_after: Optional["capo_m2.types.timestamp.Timestamp"] = None,
    started_before: Optional["capo_m2.types.timestamp.Timestamp"] = None,
) -> "capo_m2.types.list_batch_job_executions_response.ListBatchJobExecutionsResponse":
    """<p>Lists historical, current, and scheduled batch job executions for a specific application.</p>

    Args:
        next_token: <p>A pagination token to control the number of batch job executions displayed in the list.</p>
        max_results: <p>The maximum number of batch job executions to return.</p>
        application_id: <p>The unique identifier of the application.</p>
        execution_ids: <p>The unique identifier of each batch job execution.</p>
        job_name: <p>The name of each batch job execution.</p>
        status: <p>The status of the batch job executions.</p>
        started_after: <p>The time after which the batch job executions started.</p>
        started_before: <p>The time before the batch job executions started.</p>

    Raises:
        capo_m2.errors.access_denied_exception.AccessDeniedException: <p>The account or role doesn't have the right permissions to make the request.</p>
        capo_m2.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_m2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_m2.errors.throttling_exception.ThrottlingException: <p>The number of requests made exceeds the limit.</p>
        capo_m2.errors.validation_exception.ValidationException: <p>One or more parameters provided in the request is not valid.</p>
        capo_m2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_m2.types.list_batch_job_executions_request.ListBatchJobExecutionsRequest]",
    ) -> OperationResponse[
        "capo_m2.types.list_batch_job_executions_response.ListBatchJobExecutionsResponse"
    ]:
        import capo_m2._operations.aws_supernova_control_plane_service.list_batch_job_executions

        output, http_response = (
            capo_m2._operations.aws_supernova_control_plane_service.list_batch_job_executions.list_batch_job_executions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBatchJobExecutions")
    )
    input_: capo_m2.types.list_batch_job_executions_request.ListBatchJobExecutionsRequest = {
        "application_id": application_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if execution_ids is not None:
        input_["execution_ids"] = execution_ids
    if job_name is not None:
        input_["job_name"] = job_name
    if status is not None:
        input_["status"] = status
    if started_after is not None:
        input_["started_after"] = started_after
    if started_before is not None:
        input_["started_before"] = started_before

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