Skip to content

create_model_explainability_job_definition async

create_model_explainability_job_definition(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    job_definition_name: Optional[MonitoringJobDefinitionName] = None,
    model_explainability_baseline_config: Optional[
        ModelExplainabilityBaselineConfig
    ] = None,
    model_explainability_app_specification: Optional[
        ModelExplainabilityAppSpecification
    ] = None,
    model_explainability_job_input: Optional[ModelExplainabilityJobInput] = None,
    model_explainability_job_output_config: Optional[MonitoringOutputConfig] = None,
    job_resources: Optional[MonitoringResources] = None,
    network_config: Optional[MonitoringNetworkConfig] = None,
    role_arn: Optional[RoleArn] = None,
    stopping_condition: Optional[MonitoringStoppingCondition] = None,
    tags: Optional[TagList] = None,
) -> CreateModelExplainabilityJobDefinitionResponse

Creates the definition for a model explainability job.

Parameters:

Raises:

  • ResourceInUse –

    Resource being accessed is in use.

  • 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/async_sage_maker.py
async def create_model_explainability_job_definition(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    job_definition_name: Optional[
        "capo_sagemaker.types.monitoring_job_definition_name.MonitoringJobDefinitionName"
    ] = None,
    model_explainability_baseline_config: Optional[
        "capo_sagemaker.types.model_explainability_baseline_config.ModelExplainabilityBaselineConfig"
    ] = None,
    model_explainability_app_specification: Optional[
        "capo_sagemaker.types.model_explainability_app_specification.ModelExplainabilityAppSpecification"
    ] = None,
    model_explainability_job_input: Optional[
        "capo_sagemaker.types.model_explainability_job_input.ModelExplainabilityJobInput"
    ] = None,
    model_explainability_job_output_config: Optional[
        "capo_sagemaker.types.monitoring_output_config.MonitoringOutputConfig"
    ] = None,
    job_resources: Optional[
        "capo_sagemaker.types.monitoring_resources.MonitoringResources"
    ] = None,
    network_config: Optional[
        "capo_sagemaker.types.monitoring_network_config.MonitoringNetworkConfig"
    ] = None,
    role_arn: Optional["capo_sagemaker.types.role_arn.RoleArn"] = None,
    stopping_condition: Optional[
        "capo_sagemaker.types.monitoring_stopping_condition.MonitoringStoppingCondition"
    ] = None,
    tags: Optional["capo_sagemaker.types.tag_list.TagList"] = None,
) -> "capo_sagemaker.types.create_model_explainability_job_definition_response.CreateModelExplainabilityJobDefinitionResponse":
    """<p>Creates the definition for a model explainability job.</p>

    Args:
        job_definition_name: <p> The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
        model_explainability_baseline_config: <p>The baseline configuration for a model explainability job.</p>
        model_explainability_app_specification: <p>Configures the model explainability job to run a specified Docker container image.</p>
        model_explainability_job_input: <p>Inputs for the model explainability job.</p>
        network_config: <p>Networking options for a model explainability job.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>
        tags: <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL"> Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p>

    Raises:
        capo_sagemaker.errors.resource_in_use.ResourceInUse: <p>Resource being accessed is in use.</p>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.create_model_explainability_job_definition_request.CreateModelExplainabilityJobDefinitionRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.create_model_explainability_job_definition_response.CreateModelExplainabilityJobDefinitionResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.create_model_explainability_job_definition

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateModelExplainabilityJobDefinition")
    )
    input_: capo_sagemaker.types.create_model_explainability_job_definition_request.CreateModelExplainabilityJobDefinitionRequest = {}
    if job_definition_name is not None:
        input_["job_definition_name"] = job_definition_name
    if model_explainability_baseline_config is not None:
        input_["model_explainability_baseline_config"] = (
            model_explainability_baseline_config
        )
    if model_explainability_app_specification is not None:
        input_["model_explainability_app_specification"] = (
            model_explainability_app_specification
        )
    if model_explainability_job_input is not None:
        input_["model_explainability_job_input"] = model_explainability_job_input
    if model_explainability_job_output_config is not None:
        input_["model_explainability_job_output_config"] = (
            model_explainability_job_output_config
        )
    if job_resources is not None:
        input_["job_resources"] = job_resources
    if network_config is not None:
        input_["network_config"] = network_config
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if stopping_condition is not None:
        input_["stopping_condition"] = stopping_condition
    if tags is not None:
        input_["tags"] = tags

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