Skip to content

list_edge_deployment_plans async

list_edge_deployment_plans(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[ListMaxResults] = 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,
    device_fleet_name_contains: Optional[NameContains] = None,
    sort_by: Optional[ListEdgeDeploymentPlansSortBy] = None,
    sort_order: Optional[SortOrder] = None,
) -> ListEdgeDeploymentPlansResponse

Lists all edge deployment plans.

Parameters:

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

    The response from the last list when returning a list large enough to need tokening.

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

    The maximum number of results to select (50 by default).

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

    Selects edge deployment plans created after this time.

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

    Selects edge deployment plans created before this time.

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

    Selects edge deployment plans that were last updated after this time.

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

    Selects edge deployment plans that were last updated before this time.

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

    Selects edge deployment plans with names containing this name.

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

    Selects edge deployment plans with a device fleet name containing this name.

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

    The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

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

    The direction of the sorting (ascending or descending).

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_edge_deployment_plans(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_sagemaker.types.list_max_results.ListMaxResults"
    ] = 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,
    device_fleet_name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.list_edge_deployment_plans_sort_by.ListEdgeDeploymentPlansSortBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
) -> "capo_sagemaker.types.list_edge_deployment_plans_response.ListEdgeDeploymentPlansResponse":
    """<p>Lists all edge deployment plans.</p>

    Args:
        next_token: <p>The response from the last list when returning a list large enough to need tokening.</p>
        max_results: <p>The maximum number of results to select (50 by default).</p>
        creation_time_after: <p>Selects edge deployment plans created after this time.</p>
        creation_time_before: <p>Selects edge deployment plans created before this time.</p>
        last_modified_time_after: <p>Selects edge deployment plans that were last updated after this time.</p>
        last_modified_time_before: <p>Selects edge deployment plans that were last updated before this time.</p>
        name_contains: <p>Selects edge deployment plans with names containing this name.</p>
        device_fleet_name_contains: <p>Selects edge deployment plans with a device fleet name containing this name.</p>
        sort_by: <p>The column by which to sort the edge deployment plans. Can be one of <code>NAME</code>, <code>DEVICEFLEETNAME</code>, <code>CREATIONTIME</code>, <code>LASTMODIFIEDTIME</code>.</p>
        sort_order: <p>The direction of the sorting (ascending or descending).</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_edge_deployment_plans_request.ListEdgeDeploymentPlansRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_edge_deployment_plans_response.ListEdgeDeploymentPlansResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_edge_deployment_plans

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEdgeDeploymentPlans")
    )
    input_: capo_sagemaker.types.list_edge_deployment_plans_request.ListEdgeDeploymentPlansRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    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 device_fleet_name_contains is not None:
        input_["device_fleet_name_contains"] = device_fleet_name_contains
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

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