model_explainability_job_definitions

Creates, updates, deletes, gets or lists a model_explainability_job_definitions resource.

Overview

Name	model_explainability_job_definitions
Type	Resource
Id	aws.sagemaker.model_explainability_job_definitions

Fields

The following fields are returned by SELECT queries:

describe_model_explainability_job_definition

Name	Datatype	Description
creation_time	string (date-time)	The time at which the model explainability job was created.
job_definition_arn	string	The Amazon Resource Name (ARN) of the model explainability job. (pattern: <code>.*</code>)
job_definition_name	string	The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
job_resources	object	Identifies the resources to deploy for a monitoring job.
model_explainability_app_specification	object	Configures the model explainability job to run a specified Docker container image.
model_explainability_baseline_config	object	The baseline configuration for a model explainability job.
model_explainability_job_input	object	Inputs for the model explainability job.
model_explainability_job_output_config	object	The output configuration for monitoring jobs.
network_config	object	Networking options for a model explainability job.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
stopping_condition	object	A time limit for how long the monitoring job is allowed to run before stopping.

list_model_explainability_job_definitions

Name	Datatype	Description
creation_time	string (date-time)	The time that the monitoring job was created.
endpoint_name	string	The name of the endpoint that the job monitors. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
monitoring_job_definition_arn	string	The Amazon Resource Name (ARN) of the monitoring job. (pattern: <code>.*</code>)
monitoring_job_definition_name	string	The name of the monitoring job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_model_explainability_job_definition	select	region		Returns a description of a model explainability job definition.
list_model_explainability_job_definitions	select	region		Lists model explainability job definitions that satisfy various filters.
create_model_explainability_job_definition	insert	region, JobDefinitionName, ModelExplainabilityAppSpecification, ModelExplainabilityJobInput, ModelExplainabilityJobOutputConfig, JobResources, RoleArn		Creates the definition for a model explainability job.
delete_model_explainability_job_definition	delete	region		Deletes an Amazon SageMaker AI model explainability job definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_model_explainability_job_definition

Returns a description of a model explainability job definition.

SELECT
creation_time,
job_definition_arn,
job_definition_name,
job_resources,
model_explainability_app_specification,
model_explainability_baseline_config,
model_explainability_job_input,
model_explainability_job_output_config,
network_config,
role_arn,
stopping_condition
FROM aws.sagemaker.model_explainability_job_definitions
WHERE region = '{{ region }}' -- required
;

list_model_explainability_job_definitions

Lists model explainability job definitions that satisfy various filters.

SELECT
creation_time,
endpoint_name,
monitoring_job_definition_arn,
monitoring_job_definition_name
FROM aws.sagemaker.model_explainability_job_definitions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_model_explainability_job_definition

Creates the definition for a model explainability job.

INSERT INTO aws.sagemaker.model_explainability_job_definitions (
JobDefinitionName,
ModelExplainabilityBaselineConfig,
ModelExplainabilityAppSpecification,
ModelExplainabilityJobInput,
ModelExplainabilityJobOutputConfig,
JobResources,
NetworkConfig,
RoleArn,
StoppingCondition,
Tags,
region
)
SELECT 
'{{ JobDefinitionName }}' /* required */,
'{{ ModelExplainabilityBaselineConfig }}',
'{{ ModelExplainabilityAppSpecification }}' /* required */,
'{{ ModelExplainabilityJobInput }}' /* required */,
'{{ ModelExplainabilityJobOutputConfig }}' /* required */,
'{{ JobResources }}' /* required */,
'{{ NetworkConfig }}',
'{{ RoleArn }}' /* required */,
'{{ StoppingCondition }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
job_definition_arn
;

Manifest

# Description fields are for documentation purposes
- name: model_explainability_job_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the model_explainability_job_definitions resource.
  - name: JobDefinitionName
    value: "{{ JobDefinitionName }}"
    description: |
      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.
  - name: ModelExplainabilityBaselineConfig
    description: |
      The baseline configuration for a model explainability job.
    value:
      BaseliningJobName: "{{ BaseliningJobName }}"
      ConstraintsResource:
        S3Uri: "{{ S3Uri }}"
  - name: ModelExplainabilityAppSpecification
    description: |
      Configures the model explainability job to run a specified Docker container image.
    value:
      ImageUri: "{{ ImageUri }}"
      ConfigUri: "{{ ConfigUri }}"
      Environment: "{{ Environment }}"
  - name: ModelExplainabilityJobInput
    description: |
      Inputs for the model explainability job.
    value:
      EndpointInput:
        EndpointName: "{{ EndpointName }}"
        LocalPath: "{{ LocalPath }}"
        S3InputMode: "{{ S3InputMode }}"
        S3DataDistributionType: "{{ S3DataDistributionType }}"
        FeaturesAttribute: "{{ FeaturesAttribute }}"
        InferenceAttribute: "{{ InferenceAttribute }}"
        ProbabilityAttribute: "{{ ProbabilityAttribute }}"
        ProbabilityThresholdAttribute: {{ ProbabilityThresholdAttribute }}
        StartTimeOffset: "{{ StartTimeOffset }}"
        EndTimeOffset: "{{ EndTimeOffset }}"
        ExcludeFeaturesAttribute: "{{ ExcludeFeaturesAttribute }}"
      BatchTransformInput:
        DataCapturedDestinationS3Uri: "{{ DataCapturedDestinationS3Uri }}"
        DatasetFormat:
          Csv:
            Header: {{ Header }}
          Json:
            Line: {{ Line }}
          Parquet: "{{ Parquet }}"
        LocalPath: "{{ LocalPath }}"
        S3InputMode: "{{ S3InputMode }}"
        S3DataDistributionType: "{{ S3DataDistributionType }}"
        FeaturesAttribute: "{{ FeaturesAttribute }}"
        InferenceAttribute: "{{ InferenceAttribute }}"
        ProbabilityAttribute: "{{ ProbabilityAttribute }}"
        ProbabilityThresholdAttribute: {{ ProbabilityThresholdAttribute }}
        StartTimeOffset: "{{ StartTimeOffset }}"
        EndTimeOffset: "{{ EndTimeOffset }}"
        ExcludeFeaturesAttribute: "{{ ExcludeFeaturesAttribute }}"
  - name: ModelExplainabilityJobOutputConfig
    description: |
      The output configuration for monitoring jobs.
    value:
      MonitoringOutputs:
        - S3Output:
            S3Uri: "{{ S3Uri }}"
            LocalPath: "{{ LocalPath }}"
            S3UploadMode: "{{ S3UploadMode }}"
      KmsKeyId: "{{ KmsKeyId }}"
  - name: JobResources
    description: |
      Identifies the resources to deploy for a monitoring job.
    value:
      ClusterConfig:
        InstanceCount: {{ InstanceCount }}
        InstanceType: "{{ InstanceType }}"
        VolumeSizeInGB: {{ VolumeSizeInGB }}
        VolumeKmsKeyId: "{{ VolumeKmsKeyId }}"
  - name: NetworkConfig
    description: |
      Networking options for a model explainability job.
    value:
      EnableInterContainerTrafficEncryption: {{ EnableInterContainerTrafficEncryption }}
      EnableNetworkIsolation: {{ EnableNetworkIsolation }}
      VpcConfig:
        SecurityGroupIds:
          - "{{ SecurityGroupIds }}"
        Subnets:
          - "{{ Subnets }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
  - name: StoppingCondition
    description: |
      A time limit for how long the monitoring job is allowed to run before stopping.
    value:
      MaxRuntimeInSeconds: {{ MaxRuntimeInSeconds }}
  - name: Tags
    description: |
      (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_model_explainability_job_definition

Deletes an Amazon SageMaker AI model explainability job definition.

DELETE FROM aws.sagemaker.model_explainability_job_definitions
WHERE region = '{{ region }}' --required
;