describe_jobs ¶

def describe_jobs(
    self,
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    filters: Optional[
        "capo_mgn.types.describe_jobs_request_filters.DescribeJobsRequestFilters"
    ] = None,
    max_results: Optional["capo_mgn.types.max_results_type.MaxResultsType"] = None,
    next_token: Optional["capo_mgn.types.pagination_token.PaginationToken"] = None,
    account_id: Optional["capo_mgn.types.account_id.AccountID"] = None,
) -> "capo_mgn.types.describe_jobs_response.DescribeJobsResponse":
    """<p>Returns a list of Jobs. Use the jobIDs and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDateTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.</p>

    Args:
        filters: <p>Request to describe Job log filters.</p>
        max_results: <p>Request to describe job log items by max results.</p>
        next_token: <p>Request to describe job log items by next token.</p>
        account_id: <p>Request to describe job log items by Account ID.</p>

    Raises:
        capo_mgn.errors.uninitialized_account_exception.UninitializedAccountException: <p>Uninitialized account exception.</p>
        capo_mgn.errors.validation_exception.ValidationException: <p>Validate exception.</p>
        capo_mgn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mgn.types.describe_jobs_request.DescribeJobsRequest]",
    ) -> OperationResponse[
        "capo_mgn.types.describe_jobs_response.DescribeJobsResponse"
    ]:
        import capo_mgn._operations.application_migration_service.describe_jobs

        output, http_response = (
            capo_mgn._operations.application_migration_service.describe_jobs.describe_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mgn.types.describe_jobs_response.DescribeJobsResponse",
    ) -> dict[str, Any]:
        import capo_mgn.types.describe_jobs_response

        return capo_mgn.types.describe_jobs_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeJobs", redact_output=_redact_output),
    )
    input_: capo_mgn.types.describe_jobs_request.DescribeJobsRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if account_id is not None:
        input_["account_id"] = account_id

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