Skip to content

describe_ai_workload_config async

describe_ai_workload_config(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    ai_workload_config_name: Optional[AIEntityName] = None,
) -> DescribeAIWorkloadConfigResponse

Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.

Parameters:

  • ai_workload_config_name (Optional[AIEntityName], default: None ) –

    The name of the AI workload configuration to describe.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_ai_workload_config(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    ai_workload_config_name: Optional[
        "capo_sagemaker.types.ai_entity_name.AIEntityName"
    ] = None,
) -> "capo_sagemaker.types.describe_ai_workload_config_response.DescribeAIWorkloadConfigResponse":
    """<p>Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.</p>

    Args:
        ai_workload_config_name: <p>The name of the AI workload configuration 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_ai_workload_config_request.DescribeAIWorkloadConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_ai_workload_config_response.DescribeAIWorkloadConfigResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_ai_workload_config

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAIWorkloadConfig")
    )
    input_: capo_sagemaker.types.describe_ai_workload_config_request.DescribeAIWorkloadConfigRequest = {}
    if ai_workload_config_name is not None:
        input_["ai_workload_config_name"] = ai_workload_config_name

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