create-ai-workload-config¶
Description¶
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.
See also: AWS API Documentation
Synopsis¶
create-ai-workload-config
--ai-workload-config-name <value>
[--dataset-config <value>]
[--ai-workload-configs <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
Options¶
--ai-workload-config-name (string) [required]
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.
Constraints:
- min:
1- max:
63- pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
--dataset-config (tagged union structure)
The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:InputDataConfig.InputDataConfig -> (list)
An array of input data channel configurations for the workload.
(structure)
A channel of input data for an AI workload configuration. Each channel has a name and a data source.
ChannelName -> (string) [required]
The logical name for the data channel.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z0-9\.\-_]+DataSource -> (structure) [required]
The data source for this channel.
S3DataSource -> (structure)
The Amazon S3 data source configuration.
S3Uri -> (string) [required]
The Amazon S3 URI of the data.
Constraints:
- min:
0- max:
1024- pattern:
(https|s3)://([^/]+)/?(.*)
JSON Syntax:
{
"InputDataConfig": [
{
"ChannelName": "string",
"DataSource": {
"S3DataSource": {
"S3Uri": "string"
}
}
}
...
]
}
--ai-workload-configs (structure)
The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.
WorkloadSpec -> (tagged union structure) [required]
The workload specification that defines benchmark parameters.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Inline.Inline -> (string)
An inline YAML or JSON string that defines benchmark parameters.
Shorthand Syntax:
WorkloadSpec={Inline=string}
JSON Syntax:
{
"WorkloadSpec": {
"Inline": "string"
}
}
--tags (list)
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.
Constraints:
- min:
0- max:
50(structure)
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .
Key -> (string) [required]
The tag key. Tag keys must be unique per resource.
Constraints:
- min:
1- max:
128- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value -> (string) [required]
The tag value.
Constraints:
- min:
0- max:
256- pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
- off
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
- legacy
- json
- yaml
- text
- table
- enhanced
Output¶
AIWorkloadConfigArn -> (string)
The Amazon Resource Name (ARN) of the created AI workload configuration.
Constraints:
- min:
0- max:
256- pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:ai-workload-config/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}