Skip to content

list_transform_jobs async

list_transform_jobs(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    last_modified_time_after: Optional[Timestamp] = None,
    last_modified_time_before: Optional[Timestamp] = None,
    name_contains: Optional[NameContains] = None,
    status_equals: Optional[TransformJobStatus] = None,
    sort_by: Optional[SortBy] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListTransformJobsResponse

Lists transform jobs.

Parameters:

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

    A filter that returns only transform jobs created after the specified time.

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

    A filter that returns only transform jobs created before the specified time.

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

    A filter that returns only transform jobs modified after the specified time.

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

    A filter that returns only transform jobs modified before the specified time.

  • name_contains (Optional[NameContains], default: None ) –

    A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

  • status_equals (Optional[TransformJobStatus], default: None ) –

    A filter that retrieves only transform jobs with a specific status.

  • sort_by (Optional[SortBy], default: None ) –

    The field to sort results by. The default is CreationTime.

  • sort_order (Optional[SortOrder], default: None ) –

    The sort order for results. The default is Descending.

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

    If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

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

    The maximum number of transform jobs to return in the response. The default value is 10.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_transform_jobs(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.transform_job_status.TransformJobStatus"
    ] = None,
    sort_by: Optional["capo_sagemaker.types.sort_by.SortBy"] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_transform_jobs_response.ListTransformJobsResponse":
    """<p>Lists transform jobs.</p>

    Args:
        creation_time_after: <p>A filter that returns only transform jobs created after the specified time.</p>
        creation_time_before: <p>A filter that returns only transform jobs created before the specified time.</p>
        last_modified_time_after: <p>A filter that returns only transform jobs modified after the specified time.</p>
        last_modified_time_before: <p>A filter that returns only transform jobs modified before the specified time.</p>
        name_contains: <p>A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.</p>
        status_equals: <p>A filter that retrieves only transform jobs with a specific status.</p>
        sort_by: <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for results. The default is <code>Descending</code>.</p>
        next_token: <p>If the result of the previous <code>ListTransformJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of transform jobs, use the token in the next request.</p>
        max_results: <p>The maximum number of transform jobs to return in the response. The default value is <code>10</code>.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.list_transform_jobs_request.ListTransformJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_transform_jobs_response.ListTransformJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_transform_jobs

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.list_transform_jobs.async_list_transform_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTransformJobs")
    )
    input_: capo_sagemaker.types.list_transform_jobs_request.ListTransformJobsRequest = {}
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if last_modified_time_after is not None:
        input_["last_modified_time_after"] = last_modified_time_after
    if last_modified_time_before is not None:
        input_["last_modified_time_before"] = last_modified_time_before
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if status_equals is not None:
        input_["status_equals"] = status_equals
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output