Skip to content

create_edge_deployment_plan

create_edge_deployment_plan(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    edge_deployment_plan_name: Optional[EntityName] = None,
    model_configs: Optional[EdgeDeploymentModelConfigs] = None,
    device_fleet_name: Optional[EntityName] = None,
    stages: Optional[DeploymentStages] = None,
    tags: Optional[TagList] = None,
) -> CreateEdgeDeploymentPlanResponse

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

Parameters:

  • edge_deployment_plan_name (Optional[EntityName], default: None ) –

    The name of the edge deployment plan.

  • model_configs (Optional[EdgeDeploymentModelConfigs], default: None ) –

    List of models associated with the edge deployment plan.

  • device_fleet_name (Optional[EntityName], default: None ) –

    The device fleet used for this edge deployment plan.

  • stages (Optional[DeploymentStages], default: None ) –

    List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

  • tags (Optional[TagList], default: None ) –

    List of tags with which to tag the edge deployment plan.

Raises:

  • ResourceLimitExceeded –

    You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def create_edge_deployment_plan(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    edge_deployment_plan_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    model_configs: Optional[
        "capo_sagemaker.types.edge_deployment_model_configs.EdgeDeploymentModelConfigs"
    ] = None,
    device_fleet_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    stages: Optional[
        "capo_sagemaker.types.deployment_stages.DeploymentStages"
    ] = None,
    tags: Optional["capo_sagemaker.types.tag_list.TagList"] = None,
) -> "capo_sagemaker.types.create_edge_deployment_plan_response.CreateEdgeDeploymentPlanResponse":
    """<p>Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.</p>

    Args:
        edge_deployment_plan_name: <p>The name of the edge deployment plan.</p>
        model_configs: <p>List of models associated with the edge deployment plan.</p>
        device_fleet_name: <p>The device fleet used for this edge deployment plan.</p>
        stages: <p>List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.</p>
        tags: <p>List of tags with which to tag the edge deployment plan.</p>

    Raises:
        capo_sagemaker.errors.resource_limit_exceeded.ResourceLimitExceeded: <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.create_edge_deployment_plan_request.CreateEdgeDeploymentPlanRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.create_edge_deployment_plan_response.CreateEdgeDeploymentPlanResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.create_edge_deployment_plan

        output, http_response = (
            capo_sagemaker._operations.sage_maker.create_edge_deployment_plan.create_edge_deployment_plan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateEdgeDeploymentPlan")
    )
    input_: capo_sagemaker.types.create_edge_deployment_plan_request.CreateEdgeDeploymentPlanRequest = {}
    if edge_deployment_plan_name is not None:
        input_["edge_deployment_plan_name"] = edge_deployment_plan_name
    if model_configs is not None:
        input_["model_configs"] = model_configs
    if device_fleet_name is not None:
        input_["device_fleet_name"] = device_fleet_name
    if stages is not None:
        input_["stages"] = stages
    if tags is not None:
        input_["tags"] = tags

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