describe_edge_deployment_plan `async` ¶

describe_edge_deployment_plan(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    edge_deployment_plan_name: Optional[EntityName] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[DeploymentStageMaxResults] = None,
) -> DescribeEdgeDeploymentPlanResponse

Describes an edge deployment plan with deployment status per stage.

Parameters:

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

The name of the deployment plan to describe.
next_token (Optional[NextToken], default: None ) –

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
max_results (Optional[DeploymentStageMaxResults], default: None ) –

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

Raises:

ResourceNotFound –

Resource being access is not found.
UnknownServiceError –

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

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py

async def describe_edge_deployment_plan(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    edge_deployment_plan_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_sagemaker.types.deployment_stage_max_results.DeploymentStageMaxResults"
    ] = None,
) -> "capo_sagemaker.types.describe_edge_deployment_plan_response.DescribeEdgeDeploymentPlanResponse":
    """<p>Describes an edge deployment plan with deployment status per stage.</p>

    Args:
        edge_deployment_plan_name: <p>The name of the deployment plan to describe.</p>
        next_token: <p>If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.</p>
        max_results: <p>The maximum number of results to select (50 by default).</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_edge_deployment_plan_request.DescribeEdgeDeploymentPlanRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_edge_deployment_plan_response.DescribeEdgeDeploymentPlanResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_edge_deployment_plan

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEdgeDeploymentPlan")
    )
    input_: capo_sagemaker.types.describe_edge_deployment_plan_request.DescribeEdgeDeploymentPlanRequest = {}
    if edge_deployment_plan_name is not None:
        input_["edge_deployment_plan_name"] = edge_deployment_plan_name
    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

describe_edge_deployment_plan async ¶

describe_edge_deployment_plan `async` ¶