Aws/sagemaker
@swamp/aws/sagemakerv2026.10.25.1
01README
AWS SAGEMAKER infrastructure models
02Release Notes
- Updated: cluster, code_repository, compute_quota, device, domain, feature_group, model_card, monitoring_schedule, user_profile
03Behaviors
action.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ActionName | string | The name of the action. Must be unique to your account in an AWS Region. |
| ActionType | string | The action type. |
| Source? | object | The URI of the source. |
| Description? | string | The description of the action. |
| Status? | enum | The status of the action. |
| Properties? | record | A list of properties to add to the action. |
| MetadataProperties? | object | The commit ID. |
| Tags? | array | A list of tags to apply to the action. |
fn create()
Create a SageMaker Action
fn get(identifier: string)
Get a SageMaker Action
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Action |
fn update()
Update a SageMaker Action
fn delete(identifier: string)
Delete a SageMaker Action
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Action |
fn sync()
Sync SageMaker Action state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Action resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Action resource state
aiworkload_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AIWorkloadConfigName | string | The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted. |
| DatasetConfig? | object | An array of input data channel configurations for the workload. |
| AIWorkloadConfigs? | object | The workload specification that defines benchmark parameters. |
| Tags? | array | The metadata that you apply to the AI workload configuration to help you categorize and organize it. |
fn create()
Create a SageMaker AIWorkloadConfig
fn get(identifier: string)
Get a SageMaker AIWorkloadConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker AIWorkloadConfig |
fn update()
Update a SageMaker AIWorkloadConfig
fn delete(identifier: string)
Delete a SageMaker AIWorkloadConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker AIWorkloadConfig |
fn sync()
Sync SageMaker AIWorkloadConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker AIWorkloadConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker AIWorkloadConfig resource state
algorithm.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AlgorithmName | string | The name of the algorithm. |
| AlgorithmDescription? | string | A description of the algorithm. |
| TrainingSpecification? | object | |
| InferenceSpecification? | object | |
| CertifyForMarketplace? | boolean | Whether to certify the algorithm so that it can be listed in AWS Marketplace. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker Algorithm
fn get(identifier: string)
Get a SageMaker Algorithm
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Algorithm |
fn update()
Update a SageMaker Algorithm
fn delete(identifier: string)
Delete a SageMaker Algorithm
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Algorithm |
fn sync()
Sync SageMaker Algorithm state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Algorithm resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Algorithm resource state
app.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AppName | string | The name of the app. |
| AppType | enum | The type of app. |
| DomainId | string | The domain ID. |
| ResourceSpec? | object | The instance type that the image version runs on. |
| Tags? | array | A list of tags to apply to the app. |
| UserProfileName | string | The user profile name. |
| RecoveryMode? | boolean | Indicates whether the application is launched in recovery mode. |
fn create()
Create a SageMaker App
fn get(identifier: string)
Get a SageMaker App
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker App |
fn update()
Update a SageMaker App
fn delete(identifier: string)
Delete a SageMaker App
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker App |
fn sync()
Sync SageMaker App state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker App resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker App resource state
app_image_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AppImageConfigName | string | The Name of the AppImageConfig. |
| KernelGatewayImageConfig? | object | The Amazon Elastic File System (EFS) storage configuration for a SageMaker image. |
| JupyterLabAppImageConfig? | object | The container configuration for a SageMaker image. |
| CodeEditorAppImageConfig? | object | The container configuration for a SageMaker image. |
| Tags? | array | A list of tags to apply to the AppImageConfig. |
fn create()
Create a SageMaker AppImageConfig
fn get(identifier: string)
Get a SageMaker AppImageConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker AppImageConfig |
fn update()
Update a SageMaker AppImageConfig
fn delete(identifier: string)
Delete a SageMaker AppImageConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker AppImageConfig |
fn sync()
Sync SageMaker AppImageConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker AppImageConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker AppImageConfig resource state
artifact.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ArtifactName? | string | The name of the artifact. Must be unique to your account in an AWS Region. |
| ArtifactType | string | The artifact type. |
| Source? | object | The URI of the source. |
| Properties? | record | A list of properties to add to the artifact. |
| MetadataProperties? | object | The commit ID. |
| Tags? | array | A list of tags to apply to the artifact. |
fn create()
Create a SageMaker Artifact
fn get(identifier: string)
Get a SageMaker Artifact
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Artifact |
fn update()
Update a SageMaker Artifact
fn delete(identifier: string)
Delete a SageMaker Artifact
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Artifact |
fn sync()
Sync SageMaker Artifact state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Artifact resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Artifact resource state
cluster.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| VpcConfig? | object | The ID of the subnets in the VPC to which you want to connect your training job or model. |
| NodeRecovery? | enum | If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected. |
| InstanceGroups? | array | The instance groups of the SageMaker HyperPod cluster. |
| RestrictedInstanceGroups? | array | The restricted instance groups of the SageMaker HyperPod cluster. |
| Orchestrator? | record | Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster or Slurm configuration. |
| ClusterRole? | string | The cluster role for the autoscaler to assume. |
| RestrictedInstanceGroupsConfig? | object | The shared environment configuration for restricted instance groups that use cluster-level shared FSx Lustre storage. |
| NodeProvisioningMode? | enum | Determines the scaling strategy for the SageMaker HyperPod cluster. When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release. |
| ClusterName? | string | The name of the HyperPod Cluster. |
| AutoScaling? | object | The auto-scaling mode for the cluster |
| Tags? | array | Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging. |
| TieredStorageConfig? | object | The mode of tiered storage. |
fn create()
Create a SageMaker Cluster
fn get(identifier: string)
Get a SageMaker Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Cluster |
fn update()
Update a SageMaker Cluster
fn delete(identifier: string)
Delete a SageMaker Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Cluster |
fn sync()
Sync SageMaker Cluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Cluster resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Cluster resource state
cluster_scheduler_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | Name for the cluster policy. |
| ClusterArn | string | ARN of the cluster. |
| Description? | string | Description of the cluster policy. |
| SchedulerConfig? | object | List of priority class configurations. |
| Tags? | array | Tags of the cluster policy. |
fn create()
Create a SageMaker ClusterSchedulerConfig
fn get(identifier: string)
Get a SageMaker ClusterSchedulerConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ClusterSchedulerConfig |
fn update()
Update a SageMaker ClusterSchedulerConfig
fn delete(identifier: string)
Delete a SageMaker ClusterSchedulerConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ClusterSchedulerConfig |
fn sync()
Sync SageMaker ClusterSchedulerConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ClusterSchedulerConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ClusterSchedulerConfig resource state
code_repository.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| GitConfig? | object | The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. |
| CodeRepositoryName? | string | The name of the Git repository. |
| Tags? | array | An array of key-value pairs. |
fn create()
Create a SageMaker CodeRepository
fn get(identifier: string)
Get a SageMaker CodeRepository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker CodeRepository |
fn update()
Update a SageMaker CodeRepository
fn delete(identifier: string)
Delete a SageMaker CodeRepository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker CodeRepository |
fn sync()
Sync SageMaker CodeRepository state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker CodeRepository resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker CodeRepository resource state
compute_quota.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the compute allocation definition. |
| Description? | string | A free-form description of the compute allocation definition. |
| ClusterArn | string | The ARN of the EKS-orchestrated SageMaker HyperPod cluster the compute allocation definition is bound to. Slurm-orchestrated clusters are rejected by the service. |
| ComputeQuotaConfig? | object | Per-instance-type compute quotas for the team. When VCpu / MemoryInGiB / Accelerators are partially specified, SageMaker auto-fills the remaining fields ratio-proportionally to the underlying instance — Read may return values the customer did not supply (drift may flag this). |
| ComputeQuotaTarget? | object | The name of the team. Materialized as Kubernetes namespace 'hyperpod-ns-' on the EKS cluster, so the value must satisfy RFC 1123 namespace constraints. Reassignment is not supported (createOnly). |
| ActivationState? | enum | Whether the compute allocation rule is active. Defaults service-side to 'Enabled' when omitted on Create. |
| Tags? | array | Tags to associate with the compute allocation definition. |
fn create()
Create a SageMaker ComputeQuota
fn get(identifier: string)
Get a SageMaker ComputeQuota
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ComputeQuota |
fn update()
Update a SageMaker ComputeQuota
fn delete(identifier: string)
Delete a SageMaker ComputeQuota
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ComputeQuota |
fn sync()
Sync SageMaker ComputeQuota state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ComputeQuota resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ComputeQuota resource state
context.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ContextName | string | The name of the context. Must be unique to your account in an AWS Region. |
| ContextType | string | The context type. |
| Description? | string | The description of the context. |
| Source? | object | The URI of the source. |
| Properties? | record | A list of properties to add to the context. |
| Tags? | array | The tag key. |
fn create()
Create a SageMaker Context
fn get(identifier: string)
Get a SageMaker Context
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Context |
fn update()
Update a SageMaker Context
fn delete(identifier: string)
Delete a SageMaker Context
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Context |
fn sync()
Sync SageMaker Context state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Context resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Context resource state
data_quality_job_definition.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| JobDefinitionName? | string | The name of the job definition. |
| DataQualityBaselineConfig? | object | The name of a processing job |
| DataQualityAppSpecification? | object | An array of arguments for the container used to run the monitoring job. |
| DataQualityJobInput? | object | The endpoint for a monitoring job. |
| DataQualityJobOutputConfig? | object | The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. |
| JobResources | object | Configuration for the cluster used to run model monitoring jobs. |
| NetworkConfig? | object | Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. |
| EndpointName? | string | The name of the endpoint used to run the monitoring job. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
| StoppingCondition? | object | The maximum runtime allowed in seconds. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker DataQualityJobDefinition
fn get(identifier: string)
Get a SageMaker DataQualityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker DataQualityJobDefinition |
fn delete(identifier: string)
Delete a SageMaker DataQualityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker DataQualityJobDefinition |
fn sync()
Sync SageMaker DataQualityJobDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker DataQualityJobDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker DataQualityJobDefinition resource state
device.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DeviceFleetName | string | The name of the edge device fleet |
| Device? | object | Description of the device |
| Tags? | array | Associate tags with the resource |
fn create()
Create a SageMaker Device
fn get(identifier: string)
Get a SageMaker Device
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Device |
fn update()
Update a SageMaker Device
fn delete(identifier: string)
Delete a SageMaker Device
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Device |
fn sync()
Sync SageMaker Device state from AWS
Resources
state(infinite)— SageMaker Device resource state
device_fleet.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | Description for the edge device fleet |
| DeviceFleetName | string | The name of the edge device fleet |
| OutputConfig? | object | The Amazon Simple Storage (S3) bucket URI |
| RoleArn | string | Role associated with the device fleet |
| Tags? | array | Associate tags with the resource |
fn create()
Create a SageMaker DeviceFleet
fn get(identifier: string)
Get a SageMaker DeviceFleet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker DeviceFleet |
fn update()
Update a SageMaker DeviceFleet
fn delete(identifier: string)
Delete a SageMaker DeviceFleet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker DeviceFleet |
fn sync()
Sync SageMaker DeviceFleet state from AWS
Resources
state(infinite)— SageMaker DeviceFleet resource state
domain.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AppNetworkAccessType? | enum | Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. |
| AuthMode | enum | The mode of authentication that members use to access the domain. |
| DefaultUserSettings? | object | The execution role for the user. |
| DefaultSpaceSettings? | object | The execution role for the space. |
| DomainName | string | A name for the domain. |
| KmsKeyId? | string | SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. |
| SubnetIds? | array | The VPC subnets that Studio uses for communication. |
| Tags? | array | A list of tags to apply to the user profile. |
| VpcId? | string | The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. |
| DomainSettings? | object | The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. |
| AppSecurityGroupManagement? | enum | The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. |
| TagPropagation? | enum | Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources. |
| HomeEfsFileSystemCreation? | enum | Indicates whether a home EFS file system is created for the domain. Set to Disabled to skip EFS creation and reduce domain creation time. |
fn create()
Create a SageMaker Domain
fn get(identifier: string)
Get a SageMaker Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Domain |
fn update()
Update a SageMaker Domain
fn delete(identifier: string)
Delete a SageMaker Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Domain |
fn sync()
Sync SageMaker Domain state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Domain resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Domain resource state
endpoint.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DeploymentConfig? | object | Configuration for automatic rollback if an error occurs during deployment. |
| EndpointConfigName | string | The name of the endpoint configuration for the SageMaker endpoint. This is a required property. |
| EndpointName? | string | The name of the SageMaker endpoint. This name must be unique within an AWS Region. |
| ExcludeRetainedVariantProperties? | array | Specifies a list of variant properties that you want to exclude when updating an endpoint. |
| RetainAllVariantProperties? | boolean | When set to true, retains all variant properties for an endpoint when it is updated. |
| RetainDeploymentConfig? | boolean | When set to true, retains the deployment configuration during endpoint updates. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker Endpoint
fn get(identifier: string)
Get a SageMaker Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Endpoint |
fn update()
Update a SageMaker Endpoint
fn delete(identifier: string)
Delete a SageMaker Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Endpoint |
fn sync()
Sync SageMaker Endpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Endpoint resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Endpoint resource state
endpoint_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ProductionVariants | array | A list of ProductionVariant objects, one for each model that you want to host at this endpoint. |
| KmsKeyId? | string | The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. |
| VpcConfig? | object | The ID of the subnets in the VPC to which you want to connect your training job or model. |
| EndpointConfigName? | string | The name of the endpoint configuration. |
| ExplainerConfig? | object | A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer. |
| MetricsConfig? | object | Specifies whether to enable enhanced metrics for the endpoint. Enhanced metrics provide utilization and invocation data at instance and container granularity. |
| ShadowProductionVariants? | array | Array of ProductionVariant objects. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants. |
| DataCaptureConfig? | object | Specifies whether the endpoint captures input data to your model, output data from your model, or both. |
| ExecutionRoleArn? | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. |
| EnableNetworkIsolation? | boolean | Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers. |
| AsyncInferenceConfig? | object | Specifies the configuration for asynchronous inference invocation outputs. |
| Tags? | array | A list of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker EndpointConfig
fn get(identifier: string)
Get a SageMaker EndpointConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker EndpointConfig |
fn update()
Update a SageMaker EndpointConfig
fn delete(identifier: string)
Delete a SageMaker EndpointConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker EndpointConfig |
fn sync()
Sync SageMaker EndpointConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker EndpointConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker EndpointConfig resource state
experiment.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ExperimentName | string | The name of the experiment. Must be unique in your AWS account and is not case-sensitive. |
| DisplayName? | string | The name of the experiment as displayed. The name does not need to be unique. |
| Description? | string | The description of the experiment. |
| Tags? | array | The tag key. |
fn create()
Create a SageMaker Experiment
fn get(identifier: string)
Get a SageMaker Experiment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Experiment |
fn update()
Update a SageMaker Experiment
fn delete(identifier: string)
Delete a SageMaker Experiment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Experiment |
fn sync()
Sync SageMaker Experiment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Experiment resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Experiment resource state
feature_group.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| FeatureGroupName | string | The Name of the FeatureGroup. |
| RecordIdentifierFeatureName | string | The Record Identifier Feature Name. |
| EventTimeFeatureName | string | The Event Time Feature Name. |
| FeatureDefinitions | array | An Array of Feature Definition |
| OnlineStoreConfig? | object | TTL configuration of the feature group |
| OfflineStoreConfig? | object | Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores. |
| ThroughputConfig? | object | Throughput mode configuration of the feature group |
| RoleArn? | string | Role Arn |
| Description? | string | Description about the FeatureGroup. |
| Tags? | array | An array of key-value pair to apply to this resource. |
fn create()
Create a SageMaker FeatureGroup
fn get(identifier: string)
Get a SageMaker FeatureGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker FeatureGroup |
fn update()
Update a SageMaker FeatureGroup
fn delete(identifier: string)
Delete a SageMaker FeatureGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker FeatureGroup |
fn sync()
Sync SageMaker FeatureGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker FeatureGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker FeatureGroup resource state
hub.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| HubName | string | The name of the hub. |
| HubDescription | string | A description of the hub. |
| HubDisplayName? | string | The display name of the hub. |
| HubSearchKeywords? | array | The searchable keywords for the hub. |
| S3StorageConfig? | object | The Amazon S3 bucket prefix for hosting hub content. |
| Tags? | array | Tags to associate with the hub. |
fn create()
Create a SageMaker Hub
fn get(identifier: string)
Get a SageMaker Hub
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Hub |
fn update()
Update a SageMaker Hub
fn delete(identifier: string)
Delete a SageMaker Hub
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Hub |
fn sync()
Sync SageMaker Hub state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Hub resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Hub resource state
human_task_ui.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| HumanTaskUiName | string | The name of the human task user interface. |
| UiTemplate? | object | The content of the Liquid template for the worker user interface. |
| Tags? | array | An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. |
fn create()
Create a SageMaker HumanTaskUi
fn get(identifier: string)
Get a SageMaker HumanTaskUi
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker HumanTaskUi |
fn update()
Update a SageMaker HumanTaskUi
fn delete(identifier: string)
Delete a SageMaker HumanTaskUi
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker HumanTaskUi |
fn sync()
Sync SageMaker HumanTaskUi state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker HumanTaskUi resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker HumanTaskUi resource state
image.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ImageName | string | The name of the image. |
| ImageRoleArn | string | The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. |
| ImageDisplayName? | string | The display name of the image. |
| ImageDescription? | string | A description of the image. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker Image
fn get(identifier: string)
Get a SageMaker Image
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Image |
fn update()
Update a SageMaker Image
fn delete(identifier: string)
Delete a SageMaker Image
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Image |
fn sync()
Sync SageMaker Image state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Image resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Image resource state
image_version.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ImageName | string | The name of the image this version belongs to. |
| BaseImage | string | The registry path of the container image on which this image version is based. |
| Alias? | string | The alias of the image version. |
| Aliases? | array | List of aliases for the image version. |
| VendorGuidance? | enum | The availability of the image version specified by the maintainer. |
| JobType? | enum | Indicates SageMaker job type compatibility. |
| MLFramework? | string | The machine learning framework vended in the image version. |
| ProgrammingLang? | string | The supported programming language and its version. |
| Processor? | enum | Indicates CPU or GPU compatibility. |
| Horovod? | boolean | Indicates Horovod compatibility. |
| ReleaseNotes? | string | The maintainer description of the image version. |
fn create()
Create a SageMaker ImageVersion
fn get(identifier: string)
Get a SageMaker ImageVersion
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ImageVersion |
fn update()
Update a SageMaker ImageVersion
fn delete(identifier: string)
Delete a SageMaker ImageVersion
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ImageVersion |
fn sync()
Sync SageMaker ImageVersion state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ImageVersion resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ImageVersion resource state
inference_component.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| InferenceComponentName? | string | The name of the inference component |
| EndpointArn? | string | The Amazon Resource Name (ARN) of the endpoint the inference component is associated with |
| EndpointName | string | The name of the endpoint the inference component is associated with |
| VariantName? | string | The name of the endpoint variant the inference component is associated with |
| Specification? | object | The name of the model to use with the inference component |
| Specifications? | array | A list of specification objects for the inference component, one per instance type. The service requires at least two entries; use the singular Specification for a single instance type. |
| RuntimeConfig? | object | The number of copies for the inference component |
| DeploymentConfig? | object | The rolling update policy for the inference component |
| Tags? | array | An array of tags to apply to the resource |
fn create()
Create a SageMaker InferenceComponent
fn get(identifier: string)
Get a SageMaker InferenceComponent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker InferenceComponent |
fn update()
Update a SageMaker InferenceComponent
fn delete(identifier: string)
Delete a SageMaker InferenceComponent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker InferenceComponent |
fn sync()
Sync SageMaker InferenceComponent state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker InferenceComponent resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker InferenceComponent resource state
inference_experiment.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name for the inference experiment. |
| Type | enum | The type of the inference experiment that you want to run. |
| Description? | string | The description of the inference experiment. |
| RoleArn | string | The 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. |
| EndpointName | string | The name of the endpoint used to run the inference experiment. |
| EndpointMetadata? | object | The name of the endpoint used to run the inference experiment. |
| Schedule? | object | The timestamp at which the inference experiment started or will start. |
| KmsKey? | string | The 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. |
| DataStorageConfig? | object | The Amazon S3 bucket where the inference request and response data is stored. |
| ModelVariants | array | An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant. |
| ShadowModeConfig? | object | The name of the production variant, which takes all the inference requests. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| StatusReason? | string | The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment. |
| DesiredState? | enum | The desired state of the experiment after starting or stopping operation. |
fn create()
Create a SageMaker InferenceExperiment
fn get(identifier: string)
Get a SageMaker InferenceExperiment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker InferenceExperiment |
fn update()
Update a SageMaker InferenceExperiment
fn delete(identifier: string)
Delete a SageMaker InferenceExperiment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker InferenceExperiment |
fn sync()
Sync SageMaker InferenceExperiment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker InferenceExperiment resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker InferenceExperiment resource state
mlflow_app.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the MLflow App. |
| ArtifactStoreUri | string | The S3 URI for a general purpose bucket to use as the MLflow App artifact store. |
| RoleArn | string | The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. |
| ModelRegistrationMode? | enum | Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. |
| WeeklyMaintenanceWindowStart? | string | The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: Tue:03:30. |
| Tags? | array | Tags to associate with the MLflow App. |
fn create()
Create a SageMaker MlflowApp
fn get(identifier: string)
Get a SageMaker MlflowApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MlflowApp |
fn update()
Update a SageMaker MlflowApp
fn delete(identifier: string)
Delete a SageMaker MlflowApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MlflowApp |
fn sync()
Sync SageMaker MlflowApp state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker MlflowApp resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker MlflowApp resource state
mlflow_tracking_server.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| TrackingServerName | string | The name of the MLFlow Tracking Server. |
| TrackingServerSize? | enum | The size of the MLFlow Tracking Server. |
| MlflowVersion? | string | The MLFlow Version used on the MLFlow Tracking Server. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. |
| ArtifactStoreUri | string | The Amazon S3 URI for MLFlow Tracking Server artifacts. |
| AutomaticModelRegistration? | boolean | A flag to enable Automatic SageMaker Model Registration. |
| WeeklyMaintenanceWindowStart? | string | The start of the time window for maintenance of the MLFlow Tracking Server in UTC time. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker MlflowTrackingServer
fn get(identifier: string)
Get a SageMaker MlflowTrackingServer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MlflowTrackingServer |
fn update()
Update a SageMaker MlflowTrackingServer
fn delete(identifier: string)
Delete a SageMaker MlflowTrackingServer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MlflowTrackingServer |
fn sync()
Sync SageMaker MlflowTrackingServer state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker MlflowTrackingServer resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker MlflowTrackingServer resource state
model.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Containers? | array | Specifies the containers in the inference pipeline. |
| EnableNetworkIsolation? | boolean | Isolates the model container. No inbound or outbound network calls can be made to or from the model container. |
| ExecutionRoleArn? | string | The Amazon Resource Name (ARN) of the IAM role that you specified for the model. |
| InferenceExecutionConfig? | object | How containers in a multi-container are run. |
| ModelName? | string | The name of the new model. |
| PrimaryContainer? | object | This parameter is ignored for models that contain only a PrimaryContainer. When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see [Use Logs and Metrics to Monitor an Inference Pipeline](https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html). If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. |
| Tags? | array | An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). |
| VpcConfig? | object | The VPC security group IDs, in the form `sg-xxxxxxxx`. Specify the security groups for the VPC that is specified in the `Subnets` field. |
fn create()
Create a SageMaker Model
fn get(identifier: string)
Get a SageMaker Model
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Model |
fn update()
Update a SageMaker Model
fn delete(identifier: string)
Delete a SageMaker Model
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Model |
fn sync()
Sync SageMaker Model state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Model resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Model resource state
model_bias_job_definition.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| JobDefinitionName? | string | The name of the job definition. |
| ModelBiasBaselineConfig? | object | The name of a processing job |
| ModelBiasAppSpecification? | object | The container image to be run by the monitoring job. |
| ModelBiasJobInput? | object | The endpoint for a monitoring job. |
| ModelBiasJobOutputConfig? | object | The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. |
| JobResources | object | Configuration for the cluster used to run model monitoring jobs. |
| NetworkConfig? | object | Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. |
| EndpointName? | string | The name of the endpoint used to run the monitoring job. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
| StoppingCondition? | object | The maximum runtime allowed in seconds. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker ModelBiasJobDefinition
fn get(identifier: string)
Get a SageMaker ModelBiasJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelBiasJobDefinition |
fn delete(identifier: string)
Delete a SageMaker ModelBiasJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelBiasJobDefinition |
fn sync()
Sync SageMaker ModelBiasJobDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelBiasJobDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelBiasJobDefinition resource state
model_card.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ModelCardName | string | The unique name of the model card. |
| SecurityConfig? | object | A Key Management Service key ID to use for encrypting a model card. |
| ModelCardStatus | enum | The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. |
| Content? | object | Overview about the model. |
| Tags? | array | Key-value pairs used to manage metadata for model cards. |
fn create()
Create a SageMaker ModelCard
fn get(identifier: string)
Get a SageMaker ModelCard
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelCard |
fn update()
Update a SageMaker ModelCard
fn delete(identifier: string)
Delete a SageMaker ModelCard
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelCard |
fn sync()
Sync SageMaker ModelCard state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelCard resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelCard resource state
model_explainability_job_definition.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| JobDefinitionName? | string | The name of the job definition. |
| ModelExplainabilityBaselineConfig? | object | The name of a processing job |
| ModelExplainabilityAppSpecification? | object | The container image to be run by the monitoring job. |
| ModelExplainabilityJobInput? | object | The endpoint for a monitoring job. |
| ModelExplainabilityJobOutputConfig? | object | The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. |
| JobResources | object | Configuration for the cluster used to run model monitoring jobs. |
| NetworkConfig? | object | Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. |
| EndpointName? | string | The name of the endpoint used to run the monitoring job. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
| StoppingCondition? | object | The maximum runtime allowed in seconds. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker ModelExplainabilityJobDefinition
fn get(identifier: string)
Get a SageMaker ModelExplainabilityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelExplainabilityJobDefinition |
fn delete(identifier: string)
Delete a SageMaker ModelExplainabilityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelExplainabilityJobDefinition |
fn sync()
Sync SageMaker ModelExplainabilityJobDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelExplainabilityJobDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelExplainabilityJobDefinition resource state
model_package.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| AdditionalInferenceSpecifications? | array | An array of additional Inference Specification objects. |
| CertifyForMarketplace? | boolean | Whether to certify the model package for listing on AWS Marketplace. |
| ClientToken? | string | A unique token that guarantees that the call to this API is idempotent. |
| CustomerMetadataProperties? | record | The metadata properties associated with the model package versions. |
| Domain? | string | The machine learning domain of the model package you specified. |
| DriftCheckBaselines? | object | Represents the drift check bias baselines that can be used when the model monitor is set using the model package. |
| InferenceSpecification? | object | The Amazon ECR registry path of the Docker image that contains the inference code. |
| MetadataProperties? | object | The commit ID. |
| ModelApprovalStatus? | enum | The approval status of the model package. |
| ModelMetrics? | object | Contains bias metrics for a model. |
| ModelPackageDescription? | string | The description of the model package. |
| ModelPackageGroupName? | string | The name of the model package group. |
| ModelPackageName? | string | The name or arn of the model package. |
| SamplePayloadUrl? | string | The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive. |
| SkipModelValidation? | enum | Indicates if you want to skip model validation. |
| SourceAlgorithmSpecification? | object | A list of algorithms that were used to create a model package. |
| Task? | string | The machine learning task your model package accomplishes. |
| ValidationSpecification? | object | The IAM roles to be used for the validation of the model package. |
| ApprovalDescription? | string | A description provided for the model approval. |
| ModelPackageVersion? | number | The version of the model package. |
| AdditionalInferenceSpecificationsToAdd? | array | An array of additional Inference Specification objects. |
| ModelPackageStatusDetails? | object | Details about the current status of the model package. |
| SourceUri? | string | The URI of the source for the model package. |
| ModelCard? | object | The content of the model card. |
| SecurityConfig? | object | The AWS KMS Key ID (KMSKeyId) used for encryption of model package information. |
fn create()
Create a SageMaker ModelPackage
fn get(identifier: string)
Get a SageMaker ModelPackage
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelPackage |
fn update()
Update a SageMaker ModelPackage
fn delete(identifier: string)
Delete a SageMaker ModelPackage
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelPackage |
fn sync()
Sync SageMaker ModelPackage state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelPackage resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelPackage resource state
model_package_group.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| ModelPackageGroupName | string | The name of the model package group. |
| ModelPackageGroupDescription? | string | The description of the model package group. |
| ModelPackageGroupPolicy? | record |
fn create()
Create a SageMaker ModelPackageGroup
fn get(identifier: string)
Get a SageMaker ModelPackageGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelPackageGroup |
fn update()
Update a SageMaker ModelPackageGroup
fn delete(identifier: string)
Delete a SageMaker ModelPackageGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelPackageGroup |
fn sync()
Sync SageMaker ModelPackageGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelPackageGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelPackageGroup resource state
model_quality_job_definition.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| JobDefinitionName? | string | The name of the job definition. |
| ModelQualityBaselineConfig? | object | The name of a processing job |
| ModelQualityAppSpecification? | object | An array of arguments for the container used to run the monitoring job. |
| ModelQualityJobInput? | object | The endpoint for a monitoring job. |
| ModelQualityJobOutputConfig? | object | The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. |
| JobResources | object | Configuration for the cluster used to run model monitoring jobs. |
| NetworkConfig? | object | Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. |
| EndpointName? | string | The name of the endpoint used to run the monitoring job. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
| StoppingCondition? | object | The maximum runtime allowed in seconds. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker ModelQualityJobDefinition
fn get(identifier: string)
Get a SageMaker ModelQualityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelQualityJobDefinition |
fn delete(identifier: string)
Delete a SageMaker ModelQualityJobDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ModelQualityJobDefinition |
fn sync()
Sync SageMaker ModelQualityJobDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ModelQualityJobDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ModelQualityJobDefinition resource state
monitoring_schedule.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| MonitoringScheduleName | string | The name of the monitoring schedule. |
| MonitoringScheduleConfig? | object | Defines the monitoring job. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| EndpointName? | string | The name of the endpoint used to run the monitoring job. |
| FailureReason? | string | Contains the reason a monitoring job failed, if it failed. |
| LastMonitoringExecutionSummary? | object | The time at which the monitoring job was created. |
| MonitoringScheduleStatus? | enum | The status of a schedule job. |
fn create()
Create a SageMaker MonitoringSchedule
fn get(identifier: string)
Get a SageMaker MonitoringSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MonitoringSchedule |
fn update()
Update a SageMaker MonitoringSchedule
fn delete(identifier: string)
Delete a SageMaker MonitoringSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker MonitoringSchedule |
fn sync()
Sync SageMaker MonitoringSchedule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker MonitoringSchedule resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker MonitoringSchedule resource state
notebook_instance.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AcceleratorTypes? | array | A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. |
| AdditionalCodeRepositories? | array | An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. |
| DefaultCodeRepository? | string | The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. |
| DirectInternetAccess? | string | Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter. |
| InstanceMetadataServiceConfiguration? | object | Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default. |
| InstanceType | string | The type of ML compute instance to launch for the notebook instance. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it. |
| KmsKeyId? | string | The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. |
| LifecycleConfigName? | string | The name of a lifecycle configuration to associate with the notebook instance. |
| NotebookInstanceName? | string | The name of the new notebook instance. |
| PlatformIdentifier? | string | The platform identifier of the notebook instance runtime environment. The default value is notebook-al2023-v1. |
| RoleArn | string | When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission. |
| RootAccess? | string | Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users. |
| SubnetId? | string | The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. |
| SecurityGroupIds? | array | The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. |
| Tags? | array | A list of key-value pairs to apply to this resource. |
| VolumeSizeInGB? | number | The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it. |
fn create()
Create a SageMaker NotebookInstance
fn get(identifier: string)
Get a SageMaker NotebookInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker NotebookInstance |
fn update()
Update a SageMaker NotebookInstance
fn delete(identifier: string)
Delete a SageMaker NotebookInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker NotebookInstance |
fn sync()
Sync SageMaker NotebookInstance state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker NotebookInstance resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker NotebookInstance resource state
notebook_instance_lifecycle_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| OnStart? | array | A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string. |
| NotebookInstanceLifecycleConfigName? | string | The name of the lifecycle configuration. |
| OnCreate? | array | A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a SageMaker NotebookInstanceLifecycleConfig
fn get(identifier: string)
Get a SageMaker NotebookInstanceLifecycleConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker NotebookInstanceLifecycleConfig |
fn update()
Update a SageMaker NotebookInstanceLifecycleConfig
fn delete(identifier: string)
Delete a SageMaker NotebookInstanceLifecycleConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker NotebookInstanceLifecycleConfig |
fn sync()
Sync SageMaker NotebookInstanceLifecycleConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker NotebookInstanceLifecycleConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker NotebookInstanceLifecycleConfig resource state
partner_app.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | A name for the PartnerApp. |
| Type | enum | The type of PartnerApp. |
| ExecutionRoleArn | string | The execution role for the user. |
| KmsKeyId? | string | The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp. |
| Tier | string | The tier of the PartnerApp. |
| EnableIamSessionBasedIdentity? | boolean | Enables IAM Session based Identity for PartnerApp. |
| EnableAutoMinorVersionUpgrade? | boolean | Enables automatic minor version upgrades for the PartnerApp. |
| AppVersion? | string | The version of the PartnerApp. |
| ApplicationConfig? | object | A list of users with administrator privileges for the PartnerApp. |
| AuthType | enum | The Auth type of PartnerApp. |
| MaintenanceConfig? | object | The maintenance window start day and time for the PartnerApp. |
| ClientToken? | string | The client token for the PartnerApp. |
| Tags? | array | A list of tags to apply to the PartnerApp. |
fn create()
Create a SageMaker PartnerApp
fn get(identifier: string)
Get a SageMaker PartnerApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker PartnerApp |
fn update()
Update a SageMaker PartnerApp
fn delete(identifier: string)
Delete a SageMaker PartnerApp
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker PartnerApp |
fn sync()
Sync SageMaker PartnerApp state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker PartnerApp resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker PartnerApp resource state
pipeline.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| PipelineName | string | The name of the Pipeline. |
| PipelineDisplayName? | string | The display name of the Pipeline. |
| PipelineDescription? | string | The description of the Pipeline. |
| PipelineDefinition | record | |
| RoleArn | string | Role Arn |
| Tags? | array | |
| ParallelismConfiguration? | object | Maximum parallel execution steps |
fn create()
Create a SageMaker Pipeline
fn get(identifier: string)
Get a SageMaker Pipeline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Pipeline |
fn update()
Update a SageMaker Pipeline
fn delete(identifier: string)
Delete a SageMaker Pipeline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Pipeline |
fn sync()
Sync SageMaker Pipeline state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Pipeline resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Pipeline resource state
processing_job.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AppSpecification? | object | The arguments for a container used to run a processing job. |
| Environment? | record | Sets the environment variables in the Docker container |
| ExperimentConfig? | object | The name of an existing experiment to associate with the trial component. |
| NetworkConfig? | object | Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. |
| ProcessingInputs? | array | An array of inputs configuring the data to download into the processing container. |
| ProcessingJobName? | string | The name of the processing job. The name must be unique within an AWS Region in the AWS account. |
| ProcessingOutputConfig? | object | The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs. |
| ProcessingResources | object | Configuration for the cluster used to run a processing job. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
| StoppingCondition? | object | Specifies the maximum runtime in seconds. |
| Tags? | array | (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the AWS Billing and Cost Management User Guide. |
fn create()
Create a SageMaker ProcessingJob
fn get(identifier: string)
Get a SageMaker ProcessingJob
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ProcessingJob |
fn delete(identifier: string)
Delete a SageMaker ProcessingJob
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker ProcessingJob |
fn sync()
Sync SageMaker ProcessingJob state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker ProcessingJob resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker ProcessingJob resource state
project.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| ProjectName | string | The name of the project. |
| ProjectDescription? | string | The description of the project. |
| ServiceCatalogProvisioningDetails? | object | Service Catalog product identifier. |
| ServiceCatalogProvisionedProductDetails? | object | The identifier of the provisioning artifact (also known as a version). |
| TemplateProviderDetails? | array | An array of template providers associated with the project. |
fn create()
Create a SageMaker Project
fn get(identifier: string)
Get a SageMaker Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Project |
fn update()
Update a SageMaker Project
fn delete(identifier: string)
Delete a SageMaker Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Project |
fn sync()
Sync SageMaker Project state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Project resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Project resource state
space.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainId | string | The ID of the associated Domain. |
| SpaceName | string | A name for the Space. |
| SpaceSettings? | object | The Jupyter server's app settings. |
| Tags? | array | A list of tags to apply to the space. |
| OwnershipSettings? | object | |
| SpaceSharingSettings? | object | |
| SpaceDisplayName? | string |
fn create()
Create a SageMaker Space
fn get(identifier: string)
Get a SageMaker Space
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Space |
fn update()
Update a SageMaker Space
fn delete(identifier: string)
Delete a SageMaker Space
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Space |
fn sync()
Sync SageMaker Space state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Space resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Space resource state
studio_lifecycle_config.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| StudioLifecycleConfigAppType | enum | The App type that the Lifecycle Configuration is attached to. |
| StudioLifecycleConfigContent | string | The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded. |
| StudioLifecycleConfigName | string | The name of the Amazon SageMaker Studio Lifecycle Configuration. |
| Tags? | array | Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. |
fn create()
Create a SageMaker StudioLifecycleConfig
fn get(identifier: string)
Get a SageMaker StudioLifecycleConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker StudioLifecycleConfig |
fn delete(identifier: string)
Delete a SageMaker StudioLifecycleConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker StudioLifecycleConfig |
fn sync()
Sync SageMaker StudioLifecycleConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker StudioLifecycleConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker StudioLifecycleConfig resource state
trial_component.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| TrialComponentName | string | The name of the trial component. Must be unique in your AWS account and is not case-sensitive. |
| DisplayName? | string | The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed. |
| Status? | object | The status of the trial component. |
| Parameters? | record | The hyperparameters for the component. |
| InputArtifacts? | record | The input artifacts for the component. |
| OutputArtifacts? | record | The output artifacts for the component. |
| MetadataProperties? | object | The commit ID. |
| Tags? | array | The tag key. |
fn create()
Create a SageMaker TrialComponent
fn get(identifier: string)
Get a SageMaker TrialComponent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker TrialComponent |
fn update()
Update a SageMaker TrialComponent
fn delete(identifier: string)
Delete a SageMaker TrialComponent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker TrialComponent |
fn sync()
Sync SageMaker TrialComponent state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker TrialComponent resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker TrialComponent resource state
user_profile.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainId | string | The ID of the associated Domain. |
| SingleSignOnUserIdentifier? | string | A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. |
| SingleSignOnUserValue? | string | The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified. |
| UserProfileName | string | A name for the UserProfile. |
| UserSettings? | object | The user profile Amazon Resource Name (ARN). |
| Tags? | array | A list of tags to apply to the user profile. |
fn create()
Create a SageMaker UserProfile
fn get(identifier: string)
Get a SageMaker UserProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker UserProfile |
fn update()
Update a SageMaker UserProfile
fn delete(identifier: string)
Delete a SageMaker UserProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker UserProfile |
fn sync()
Sync SageMaker UserProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker UserProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker UserProfile resource state
workforce.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| WorkforceName | string | The name of the private workforce. |
| CognitoConfig? | object | The client ID for your Amazon Cognito user pool. |
| OidcConfig? | object | A string to string map of identifiers specific to the custom identity provider (IdP) being used. |
| SourceIpConfig? | object | A list of one to ten Classless Inter-Domain Routing (CIDR) values. |
| WorkforceVpcConfig? | object | The VPC security group IDs. |
| IpAddressType? | enum | The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6). |
| Tags? | array | An array of key-value pairs. |
fn create()
Create a SageMaker Workforce
fn get(identifier: string)
Get a SageMaker Workforce
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Workforce |
fn update()
Update a SageMaker Workforce
fn delete(identifier: string)
Delete a SageMaker Workforce
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Workforce |
fn sync()
Sync SageMaker Workforce state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Workforce resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Workforce resource state
workteam.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description | string | A description of the work team. |
| WorkforceName? | string | The name of the Workforce |
| WorkteamName? | string | The name of the work team. |
| NotificationConfiguration? | object | The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications should be published. |
| MemberDefinitions | array | A list of MemberDefinition objects that contains objects that identify the workers that make up the work team. |
| Tags? | array | An array of key-value pairs. |
fn create()
Create a SageMaker Workteam
fn get(identifier: string)
Get a SageMaker Workteam
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Workteam |
fn update()
Update a SageMaker Workteam
fn delete(identifier: string)
Delete a SageMaker Workteam
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SageMaker Workteam |
fn sync()
Sync SageMaker Workteam state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SageMaker Workteam resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— SageMaker Workteam resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: aiworkload_config, action, algorithm, app, app_image_config, artifact, cluster, cluster_scheduler_config, code_repository, compute_quota, context, data_quality_job_definition, device, device_fleet, domain, endpoint, endpoint_config, experiment, feature_group, hub, human_task_ui, image, image_version, inference_component, inference_experiment, mlflow_app, mlflow_tracking_server, model, model_bias_job_definition, model_card, model_explainability_job_definition, model_package, model_package_group, model_quality_job_definition, monitoring_schedule, notebook_instance, notebook_instance_lifecycle_config, partner_app, pipeline, processing_job, project, space, studio_lifecycle_config, trial_component, user_profile, workforce, workteam
2026.10.20.1AGPL-3.0-or-later
- Updated: cluster, model_package
2026.10.18.1AGPL-3.0-or-later(was none)
- Added: compute_quota
2026.10.13.1
- Updated: aiworkload_config, action, algorithm, app, app_image_config, artifact, cluster, cluster_scheduler_config, code_repository, context, data_quality_job_definition, device, device_fleet, domain, endpoint, endpoint_config, experiment, feature_group, hub, human_task_ui, image, image_version, inference_component, inference_experiment, mlflow_app, mlflow_tracking_server, model, model_bias_job_definition, model_card, model_explainability_job_definition, model_package, model_package_group, model_quality_job_definition, monitoring_schedule, notebook_instance, notebook_instance_lifecycle_config, partner_app, pipeline, processing_job, project, space, studio_lifecycle_config, trial_component, user_profile, workforce, workteam
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
- Added: workteam
2026.09.24.1
2026.09.23.1
05Stats
A
100 / 100
Downloads
150
Archive size
9.5 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels