Skip to main content

inference_experiments_list_only

Lists inference_experiments in a region or regions, for all properties use inference_experiments

Overview

Nameinference_experiments_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Idaws.sagemaker.inference_experiments_list_only

Fields

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the inference experiment.
namestringThe name for the inference experiment.
typestringThe type of the inference experiment that you want to run.
descriptionstringThe description of the inference experiment.
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
endpoint_namestringThe name of the endpoint used to run the monitoring job.
endpoint_metadataobjectThe metadata of the endpoint on which the inference experiment ran.
scheduleobjectThe duration for which you want the inference experiment to run.
kms_keystringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
data_storage_configobjectThe Amazon S3 location and configuration for storing inference request and response data.
model_variantsarrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
shadow_mode_configobjectThe configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe timestamp at which you created the inference experiment.
last_modified_timestringThe timestamp at which you last modified the inference experiment.
statusstringThe status of the inference experiment.
status_reasonstringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
desired_statestringThe desired state of the experiment after starting or stopping operation.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all inference_experiments in a region.

SELECT
region,
name
FROM aws.sagemaker.inference_experiments_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the inference_experiments_list_only resource, see inference_experiments