describe_image `async` ¶

describe_image(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    image_name: Optional[ImageName] = None,
) -> DescribeImageResponse

Describes a SageMaker AI image.

Parameters:

image_name (Optional[ImageName], default: None ) –

The name of the image to describe.

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_image(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    image_name: Optional["capo_sagemaker.types.image_name.ImageName"] = None,
) -> "capo_sagemaker.types.describe_image_response.DescribeImageResponse":
    """<p>Describes a SageMaker AI image.</p>

    Args:
        image_name: <p>The name of the image to describe.</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_image_request.DescribeImageRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_image_response.DescribeImageResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_image

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImage")
    )
    input_: capo_sagemaker.types.describe_image_request.DescribeImageRequest = {}
    if image_name is not None:
        input_["image_name"] = image_name

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

describe_image async ¶

describe_image `async` ¶