ai_workload_configs

Creates, updates, deletes, gets or lists an ai_workload_configs resource.

Overview

Name	ai_workload_configs
Type	Resource
Id	aws.sagemaker.ai_workload_configs

Fields

The following fields are returned by SELECT queries:

describe_ai_workload_config

Name	Datatype	Description
ai_workload_config_arn	string	The Amazon Resource Name (ARN) of the AI workload configuration. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:ai-workload-config/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
ai_workload_config_name	string	The name of the AI workload configuration. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
ai_workload_configs	object	The benchmark tool configuration and workload specification.
creation_time	string (date-time)	A timestamp that indicates when the AI workload configuration was created.
dataset_config	object	The dataset configuration for the workload.
tags	array	The tags associated with the AI workload configuration.

list_ai_workload_configs

Name	Datatype	Description
ai_workload_config_arn	string	The Amazon Resource Name (ARN) of the AI workload configuration. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:ai-workload-config/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
ai_workload_config_name	string	The name of the AI workload configuration. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
creation_time	string (date-time)	A timestamp that indicates when the configuration was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ai_workload_config	select	region		Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.
list_ai_workload_configs	select	region		Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.
create_ai_workload_config	insert	region, AIWorkloadConfigName		Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.
delete_ai_workload_config	delete	region		Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by an active benchmark job.

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_ai_workload_config

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

SELECT
ai_workload_config_arn,
ai_workload_config_name,
ai_workload_configs,
creation_time,
dataset_config,
tags
FROM aws.sagemaker.ai_workload_configs
WHERE region = '{{ region }}' -- required
;

list_ai_workload_configs

Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.

SELECT
ai_workload_config_arn,
ai_workload_config_name,
creation_time
FROM aws.sagemaker.ai_workload_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_ai_workload_config

Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.

INSERT INTO aws.sagemaker.ai_workload_configs (
AIWorkloadConfigName,
DatasetConfig,
AIWorkloadConfigs,
Tags,
region
)
SELECT 
'{{ AIWorkloadConfigName }}' /* required */,
'{{ DatasetConfig }}',
'{{ AIWorkloadConfigs }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
ai_workload_config_arn
;

Manifest

# Description fields are for documentation purposes
- name: ai_workload_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ai_workload_configs resource.
  - name: AIWorkloadConfigName
    value: "{{ AIWorkloadConfigName }}"
    description: |
      The name of the AI workload configuration. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.
  - name: DatasetConfig
    description: |
      The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    value:
      InputDataConfig:
        - ChannelName: "{{ ChannelName }}"
          DataSource:
            S3DataSource:
              S3Uri: "{{ S3Uri }}"
  - name: AIWorkloadConfigs
    description: |
      The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.
    value:
      WorkloadSpec:
        Inline: "{{ Inline }}"
  - name: Tags
    description: |
      The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_ai_workload_config

Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by an active benchmark job.

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