AddAssociation

$result = $client->addAssociation([/* ... */]);
$promise = $client->addAssociationAsync([/* ... */]);

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

Parameter Syntax

$result = $client->addAssociation([
    'AssociationType' => 'ContributedTo|AssociatedWith|DerivedFrom|Produced|SameAs',
    'DestinationArn' => '<string>', // REQUIRED
    'SourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DestinationArn' => '<string>',
    'SourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFound:

Resource being access is not found.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Parameter Syntax

$result = $client->addTags([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

AssociateTrialComponent

$result = $client->associateTrialComponent([/* ... */]);
$promise = $client->associateTrialComponentAsync([/* ... */]);

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Parameter Syntax

$result = $client->associateTrialComponent([
    'TrialComponentName' => '<string>', // REQUIRED
    'TrialName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TrialArn' => '<string>',
    'TrialComponentArn' => '<string>',
]

Result Details

Errors

ResourceNotFound:

Resource being access is not found.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

BatchDeleteClusterNodes

$result = $client->batchDeleteClusterNodes([/* ... */]);
$promise = $client->batchDeleteClusterNodesAsync([/* ... */]);

Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.

Parameter Syntax

$result = $client->batchDeleteClusterNodes([
    'ClusterName' => '<string>', // REQUIRED
    'NodeIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Failed' => [
        [
            'Code' => 'NodeIdNotFound|InvalidNodeStatus|NodeIdInUse',
            'Message' => '<string>',
            'NodeId' => '<string>',
        ],
        // ...
    ],
    'Successful' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFound:

Resource being access is not found.

BatchDescribeModelPackage

$result = $client->batchDescribeModelPackage([/* ... */]);
$promise = $client->batchDescribeModelPackageAsync([/* ... */]);

This action batch describes a list of versioned model packages

Parameter Syntax

$result = $client->batchDescribeModelPackage([
    'ModelPackageArnList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BatchDescribeModelPackageErrorMap' => [
        '<ModelPackageArn>' => [
            'ErrorCode' => '<string>',
            'ErrorResponse' => '<string>',
        ],
        // ...
    ],
    'ModelPackageSummaries' => [
        '<ModelPackageArn>' => [
            'CreationTime' => <DateTime>,
            'InferenceSpecification' => [
                'Containers' => [
                    [
                        'AdditionalS3DataSource' => [
                            'CompressionType' => 'None|Gzip',
                            'S3DataType' => 'S3Object|S3Prefix',
                            'S3Uri' => '<string>',
                        ],
                        'ContainerHostname' => '<string>',
                        'Environment' => ['<string>', ...],
                        'Framework' => '<string>',
                        'FrameworkVersion' => '<string>',
                        'Image' => '<string>',
                        'ImageDigest' => '<string>',
                        'ModelDataSource' => [
                            'S3DataSource' => [
                                'CompressionType' => 'None|Gzip',
                                'HubAccessConfig' => [
                                    'HubContentArn' => '<string>',
                                ],
                                'ManifestS3Uri' => '<string>',
                                'ModelAccessConfig' => [
                                    'AcceptEula' => true || false,
                                ],
                                'S3DataType' => 'S3Prefix|S3Object',
                                'S3Uri' => '<string>',
                            ],
                        ],
                        'ModelDataUrl' => '<string>',
                        'ModelInput' => [
                            'DataInputConfig' => '<string>',
                        ],
                        'NearestModelName' => '<string>',
                        'ProductId' => '<string>',
                    ],
                    // ...
                ],
                'SupportedContentTypes' => ['<string>', ...],
                'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...],
                'SupportedResponseMIMETypes' => ['<string>', ...],
                'SupportedTransformInstanceTypes' => ['<string>', ...],
            ],
            'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
            'ModelPackageArn' => '<string>',
            'ModelPackageDescription' => '<string>',
            'ModelPackageGroupName' => '<string>',
            'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
            'ModelPackageVersion' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

CreateAction

$result = $client->createAction([/* ... */]);
$promise = $client->createActionAsync([/* ... */]);

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

Parameter Syntax

$result = $client->createAction([
    'ActionName' => '<string>', // REQUIRED
    'ActionType' => '<string>', // REQUIRED
    'Description' => '<string>',
    'MetadataProperties' => [
        'CommitId' => '<string>',
        'GeneratedBy' => '<string>',
        'ProjectId' => '<string>',
        'Repository' => '<string>',
    ],
    'Properties' => ['<string>', ...],
    'Source' => [ // REQUIRED
        'SourceId' => '<string>',
        'SourceType' => '<string>',
        'SourceUri' => '<string>', // REQUIRED
    ],
    'Status' => 'Unknown|InProgress|Completed|Failed|Stopping|Stopped',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ActionArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateAlgorithm

$result = $client->createAlgorithm([/* ... */]);
$promise = $client->createAlgorithmAsync([/* ... */]);

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

Parameter Syntax

$result = $client->createAlgorithm([
    'AlgorithmDescription' => '<string>',
    'AlgorithmName' => '<string>', // REQUIRED
    'CertifyForMarketplace' => true || false,
    'InferenceSpecification' => [
        'Containers' => [ // REQUIRED
            [
                'AdditionalS3DataSource' => [
                    'CompressionType' => 'None|Gzip',
                    'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
                'ContainerHostname' => '<string>',
                'Environment' => ['<string>', ...],
                'Framework' => '<string>',
                'FrameworkVersion' => '<string>',
                'Image' => '<string>', // REQUIRED
                'ImageDigest' => '<string>',
                'ModelDataSource' => [
                    'S3DataSource' => [
                        'CompressionType' => 'None|Gzip', // REQUIRED
                        'HubAccessConfig' => [
                            'HubContentArn' => '<string>', // REQUIRED
                        ],
                        'ManifestS3Uri' => '<string>',
                        'ModelAccessConfig' => [
                            'AcceptEula' => true || false, // REQUIRED
                        ],
                        'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
                        'S3Uri' => '<string>', // REQUIRED
                    ],
                ],
                'ModelDataUrl' => '<string>',
                'ModelInput' => [
                    'DataInputConfig' => '<string>', // REQUIRED
                ],
                'NearestModelName' => '<string>',
                'ProductId' => '<string>',
            ],
            // ...
        ],
        'SupportedContentTypes' => ['<string>', ...],
        'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...],
        'SupportedResponseMIMETypes' => ['<string>', ...],
        'SupportedTransformInstanceTypes' => ['<string>', ...],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrainingSpecification' => [ // REQUIRED
        'AdditionalS3DataSource' => [
            'CompressionType' => 'None|Gzip',
            'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
            'S3Uri' => '<string>', // REQUIRED
        ],
        'MetricDefinitions' => [
            [
                'Name' => '<string>', // REQUIRED
                'Regex' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SupportedHyperParameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'IsRequired' => true || false,
                'IsTunable' => true || false,
                'Name' => '<string>', // REQUIRED
                'Range' => [
                    'CategoricalParameterRangeSpecification' => [
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                    'ContinuousParameterRangeSpecification' => [
                        'MaxValue' => '<string>', // REQUIRED
                        'MinValue' => '<string>', // REQUIRED
                    ],
                    'IntegerParameterRangeSpecification' => [
                        'MaxValue' => '<string>', // REQUIRED
                        'MinValue' => '<string>', // REQUIRED
                    ],
                ],
                'Type' => 'Integer|Continuous|Categorical|FreeText', // REQUIRED
            ],
            // ...
        ],
        'SupportedTrainingInstanceTypes' => ['<string>', ...], // REQUIRED
        'SupportedTuningJobObjectiveMetrics' => [
            [
                'MetricName' => '<string>', // REQUIRED
                'Type' => 'Maximize|Minimize', // REQUIRED
            ],
            // ...
        ],
        'SupportsDistributedTraining' => true || false,
        'TrainingChannels' => [ // REQUIRED
            [
                'Description' => '<string>',
                'IsRequired' => true || false,
                'Name' => '<string>', // REQUIRED
                'SupportedCompressionTypes' => ['<string>', ...],
                'SupportedContentTypes' => ['<string>', ...], // REQUIRED
                'SupportedInputModes' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'TrainingImage' => '<string>', // REQUIRED
        'TrainingImageDigest' => '<string>',
    ],
    'ValidationSpecification' => [
        'ValidationProfiles' => [ // REQUIRED
            [
                'ProfileName' => '<string>', // REQUIRED
                'TrainingJobDefinition' => [ // REQUIRED
                    'HyperParameters' => ['<string>', ...],
                    'InputDataConfig' => [ // REQUIRED
                        [
                            'ChannelName' => '<string>', // REQUIRED
                            'CompressionType' => 'None|Gzip',
                            'ContentType' => '<string>',
                            'DataSource' => [ // REQUIRED
                                'FileSystemDataSource' => [
                                    'DirectoryPath' => '<string>', // REQUIRED
                                    'FileSystemAccessMode' => 'rw|ro', // REQUIRED
                                    'FileSystemId' => '<string>', // REQUIRED
                                    'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
                                ],
                                'S3DataSource' => [
                                    'AttributeNames' => ['<string>', ...],
                                    'InstanceGroupNames' => ['<string>', ...],
                                    'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                                    'S3Uri' => '<string>', // REQUIRED
                                ],
                            ],
                            'InputMode' => 'Pipe|File|FastFile',
                            'RecordWrapperType' => 'None|RecordIO',
                            'ShuffleConfig' => [
                                'Seed' => <integer>, // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'OutputDataConfig' => [ // REQUIRED
                        'CompressionType' => 'GZIP|NONE',
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>', // REQUIRED
                    ],
                    'ResourceConfig' => [ // REQUIRED
                        'InstanceCount' => <integer>,
                        'InstanceGroups' => [
                            [
                                'InstanceCount' => <integer>, // REQUIRED
                                'InstanceGroupName' => '<string>', // REQUIRED
                                'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
                            ],
                            // ...
                        ],
                        'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
                        'KeepAlivePeriodInSeconds' => <integer>,
                        'VolumeKmsKeyId' => '<string>',
                        'VolumeSizeInGB' => <integer>, // REQUIRED
                    ],
                    'StoppingCondition' => [ // REQUIRED
                        'MaxPendingTimeInSeconds' => <integer>,
                        'MaxRuntimeInSeconds' => <integer>,
                        'MaxWaitTimeInSeconds' => <integer>,
                    ],
                    'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
                ],
                'TransformJobDefinition' => [
                    'BatchStrategy' => 'MultiRecord|SingleRecord',
                    'Environment' => ['<string>', ...],
                    'MaxConcurrentTransforms' => <integer>,
                    'MaxPayloadInMB' => <integer>,
                    'TransformInput' => [ // REQUIRED
                        'CompressionType' => 'None|Gzip',
                        'ContentType' => '<string>',
                        'DataSource' => [ // REQUIRED
                            'S3DataSource' => [ // REQUIRED
                                'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                                'S3Uri' => '<string>', // REQUIRED
                            ],
                        ],
                        'SplitType' => 'None|Line|RecordIO|TFRecord',
                    ],
                    'TransformOutput' => [ // REQUIRED
                        'Accept' => '<string>',
                        'AssembleWith' => 'None|Line',
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>', // REQUIRED
                    ],
                    'TransformResources' => [ // REQUIRED
                        'InstanceCount' => <integer>, // REQUIRED
                        'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge', // REQUIRED
                        'VolumeKmsKeyId' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ValidationRole' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'AlgorithmArn' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

Parameter Syntax

$result = $client->createApp([
    'AppName' => '<string>', // REQUIRED
    'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas', // REQUIRED
    'DomainId' => '<string>', // REQUIRED
    'ResourceSpec' => [
        'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
        'LifecycleConfigArn' => '<string>',
        'SageMakerImageArn' => '<string>',
        'SageMakerImageVersionAlias' => '<string>',
        'SageMakerImageVersionArn' => '<string>',
    ],
    'SpaceName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserProfileName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AppArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateAppImageConfig

$result = $client->createAppImageConfig([/* ... */]);
$promise = $client->createAppImageConfigAsync([/* ... */]);

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

Parameter Syntax

$result = $client->createAppImageConfig([
    'AppImageConfigName' => '<string>', // REQUIRED
    'CodeEditorAppImageConfig' => [
        'ContainerConfig' => [
            'ContainerArguments' => ['<string>', ...],
            'ContainerEntrypoint' => ['<string>', ...],
            'ContainerEnvironmentVariables' => ['<string>', ...],
        ],
        'FileSystemConfig' => [
            'DefaultGid' => <integer>,
            'DefaultUid' => <integer>,
            'MountPath' => '<string>',
        ],
    ],
    'JupyterLabAppImageConfig' => [
        'ContainerConfig' => [
            'ContainerArguments' => ['<string>', ...],
            'ContainerEntrypoint' => ['<string>', ...],
            'ContainerEnvironmentVariables' => ['<string>', ...],
        ],
        'FileSystemConfig' => [
            'DefaultGid' => <integer>,
            'DefaultUid' => <integer>,
            'MountPath' => '<string>',
        ],
    ],
    'KernelGatewayImageConfig' => [
        'FileSystemConfig' => [
            'DefaultGid' => <integer>,
            'DefaultUid' => <integer>,
            'MountPath' => '<string>',
        ],
        'KernelSpecs' => [ // REQUIRED
            [
                'DisplayName' => '<string>',
                'Name' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AppImageConfigArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

CreateArtifact

$result = $client->createArtifact([/* ... */]);
$promise = $client->createArtifactAsync([/* ... */]);

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

Parameter Syntax

$result = $client->createArtifact([
    'ArtifactName' => '<string>',
    'ArtifactType' => '<string>', // REQUIRED
    'MetadataProperties' => [
        'CommitId' => '<string>',
        'GeneratedBy' => '<string>',
        'ProjectId' => '<string>',
        'Repository' => '<string>',
    ],
    'Properties' => ['<string>', ...],
    'Source' => [ // REQUIRED
        'SourceTypes' => [
            [
                'SourceIdType' => 'MD5Hash|S3ETag|S3Version|Custom', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SourceUri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ArtifactArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateAutoMLJob

$result = $client->createAutoMLJob([/* ... */]);
$promise = $client->createAutoMLJobAsync([/* ... */]);

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

An AutoML job in SageMaker is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker developer guide.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

Parameter Syntax

$result = $client->createAutoMLJob([
    'AutoMLJobConfig' => [
        'CandidateGenerationConfig' => [
            'AlgorithmsConfig' => [
                [
                    'AutoMLAlgorithms' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'FeatureSpecificationS3Uri' => '<string>',
        ],
        'CompletionCriteria' => [
            'MaxAutoMLJobRuntimeInSeconds' => <integer>,
            'MaxCandidates' => <integer>,
            'MaxRuntimePerTrainingJobInSeconds' => <integer>,
        ],
        'DataSplitConfig' => [
            'ValidationFraction' => <float>,
        ],
        'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
        'SecurityConfig' => [
            'EnableInterContainerTrafficEncryption' => true || false,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'Subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'AutoMLJobName' => '<string>', // REQUIRED
    'AutoMLJobObjective' => [
        'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss', // REQUIRED
    ],
    'GenerateCandidateDefinitionsOnly' => true || false,
    'InputDataConfig' => [ // REQUIRED
        [
            'ChannelType' => 'training|validation',
            'CompressionType' => 'None|Gzip',
            'ContentType' => '<string>',
            'DataSource' => [
                'S3DataSource' => [ // REQUIRED
                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            'SampleWeightAttributeName' => '<string>',
            'TargetAttributeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ModelDeployConfig' => [
        'AutoGenerateEndpointName' => true || false,
        'EndpointName' => '<string>',
    ],
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AutoMLJobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateAutoMLJobV2

$result = $client->createAutoMLJobV2([/* ... */]);
$promise = $client->createAutoMLJobV2Async([/* ... */]);

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

An AutoML job in SageMaker is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker developer guide.

AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

Parameter Syntax

$result = $client->createAutoMLJobV2([
    'AutoMLComputeConfig' => [
        'EmrServerlessComputeConfig' => [
            'ExecutionRoleARN' => '<string>', // REQUIRED
        ],
    ],
    'AutoMLJobInputDataConfig' => [ // REQUIRED
        [
            'ChannelType' => 'training|validation',
            'CompressionType' => 'None|Gzip',
            'ContentType' => '<string>',
            'DataSource' => [
                'S3DataSource' => [ // REQUIRED
                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
    'AutoMLJobName' => '<string>', // REQUIRED
    'AutoMLJobObjective' => [
        'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss', // REQUIRED
    ],
    'AutoMLProblemTypeConfig' => [ // REQUIRED
        'ImageClassificationJobConfig' => [
            'CompletionCriteria' => [
                'MaxAutoMLJobRuntimeInSeconds' => <integer>,
                'MaxCandidates' => <integer>,
                'MaxRuntimePerTrainingJobInSeconds' => <integer>,
            ],
        ],
        'TabularJobConfig' => [
            'CandidateGenerationConfig' => [
                'AlgorithmsConfig' => [
                    [
                        'AutoMLAlgorithms' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            'CompletionCriteria' => [
                'MaxAutoMLJobRuntimeInSeconds' => <integer>,
                'MaxCandidates' => <integer>,
                'MaxRuntimePerTrainingJobInSeconds' => <integer>,
            ],
            'FeatureSpecificationS3Uri' => '<string>',
            'GenerateCandidateDefinitionsOnly' => true || false,
            'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
            'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
            'SampleWeightAttributeName' => '<string>',
            'TargetAttributeName' => '<string>', // REQUIRED
        ],
        'TextClassificationJobConfig' => [
            'CompletionCriteria' => [
                'MaxAutoMLJobRuntimeInSeconds' => <integer>,
                'MaxCandidates' => <integer>,
                'MaxRuntimePerTrainingJobInSeconds' => <integer>,
            ],
            'ContentColumn' => '<string>', // REQUIRED
            'TargetLabelColumn' => '<string>', // REQUIRED
        ],
        'TextGenerationJobConfig' => [
            'BaseModelName' => '<string>',
            'CompletionCriteria' => [
                'MaxAutoMLJobRuntimeInSeconds' => <integer>,
                'MaxCandidates' => <integer>,
                'MaxRuntimePerTrainingJobInSeconds' => <integer>,
            ],
            'ModelAccessConfig' => [
                'AcceptEula' => true || false, // REQUIRED
            ],
            'TextGenerationHyperParameters' => ['<string>', ...],
        ],
        'TimeSeriesForecastingJobConfig' => [
            'CandidateGenerationConfig' => [
                'AlgorithmsConfig' => [
                    [
                        'AutoMLAlgorithms' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            'CompletionCriteria' => [
                'MaxAutoMLJobRuntimeInSeconds' => <integer>,
                'MaxCandidates' => <integer>,
                'MaxRuntimePerTrainingJobInSeconds' => <integer>,
            ],
            'FeatureSpecificationS3Uri' => '<string>',
            'ForecastFrequency' => '<string>', // REQUIRED
            'ForecastHorizon' => <integer>, // REQUIRED
            'ForecastQuantiles' => ['<string>', ...],
            'HolidayConfig' => [
                [
                    'CountryCode' => '<string>',
                ],
                // ...
            ],
            'TimeSeriesConfig' => [ // REQUIRED
                'GroupingAttributeNames' => ['<string>', ...],
                'ItemIdentifierAttributeName' => '<string>', // REQUIRED
                'TargetAttributeName' => '<string>', // REQUIRED
                'TimestampAttributeName' => '<string>', // REQUIRED
            ],
            'Transformations' => [
                'Aggregation' => ['<string>', ...],
                'Filling' => [
                    '<TransformationAttributeName>' => ['<string>', ...],
                    // ...
                ],
            ],
        ],
    ],
    'DataSplitConfig' => [
        'ValidationFraction' => <float>,
    ],
    'ModelDeployConfig' => [
        'AutoGenerateEndpointName' => true || false,
        'EndpointName' => '<string>',
    ],
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'SecurityConfig' => [
        'EnableInterContainerTrafficEncryption' => true || false,
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AutoMLJobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

Parameter Syntax

$result = $client->createCluster([
    'ClusterName' => '<string>', // REQUIRED
    'InstanceGroups' => [ // REQUIRED
        [
            'ExecutionRole' => '<string>', // REQUIRED
            'InstanceCount' => <integer>, // REQUIRED
            'InstanceGroupName' => '<string>', // REQUIRED
            'InstanceStorageConfigs' => [
                [
                    'EbsVolumeConfig' => [
                        'VolumeSizeInGB' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge', // REQUIRED
            'LifeCycleConfig' => [ // REQUIRED
                'OnCreate' => '<string>', // REQUIRED
                'SourceS3Uri' => '<string>', // REQUIRED
            ],
            'OnStartDeepHealthChecks' => ['<string>', ...],
            'ThreadsPerCore' => <integer>,
        ],
        // ...
    ],
    'NodeRecovery' => 'Automatic|None',
    'Orchestrator' => [
        'Eks' => [ // REQUIRED
            'ClusterArn' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ClusterArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateCodeRepository

$result = $client->createCodeRepository([/* ... */]);
$promise = $client->createCodeRepositoryAsync([/* ... */]);

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

Parameter Syntax

$result = $client->createCodeRepository([
    'CodeRepositoryName' => '<string>', // REQUIRED
    'GitConfig' => [ // REQUIRED
        'Branch' => '<string>',
        'RepositoryUrl' => '<string>', // REQUIRED
        'SecretArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CodeRepositoryArn' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateCompilationJob

$result = $client->createCompilationJob([/* ... */]);
$promise = $client->createCompilationJobAsync([/* ... */]);

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

• A name for the compilation job

• Information about the input model artifacts

• The output location for the compiled model and the device (target) that the model runs on

• The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Parameter Syntax

$result = $client->createCompilationJob([
    'CompilationJobName' => '<string>', // REQUIRED
    'InputConfig' => [
        'DataInputConfig' => '<string>',
        'Framework' => 'TENSORFLOW|KERAS|MXNET|ONNX|PYTORCH|XGBOOST|TFLITE|DARKNET|SKLEARN', // REQUIRED
        'FrameworkVersion' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'ModelPackageVersionArn' => '<string>',
    'OutputConfig' => [ // REQUIRED
        'CompilerOptions' => '<string>',
        'KmsKeyId' => '<string>',
        'S3OutputLocation' => '<string>', // REQUIRED
        'TargetDevice' => 'lambda|ml_m4|ml_m5|ml_m6g|ml_c4|ml_c5|ml_c6g|ml_p2|ml_p3|ml_g4dn|ml_inf1|ml_inf2|ml_trn1|ml_eia2|jetson_tx1|jetson_tx2|jetson_nano|jetson_xavier|rasp3b|rasp4b|imx8qm|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603|sitara_am57x|amba_cv2|amba_cv22|amba_cv25|x86_win32|x86_win64|coreml|jacinto_tda4vm|imx8mplus',
        'TargetPlatform' => [
            'Accelerator' => 'INTEL_GRAPHICS|MALI|NVIDIA|NNA',
            'Arch' => 'X86_64|X86|ARM64|ARM_EABI|ARM_EABIHF', // REQUIRED
            'Os' => 'ANDROID|LINUX', // REQUIRED
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxPendingTimeInSeconds' => <integer>,
        'MaxRuntimeInSeconds' => <integer>,
        'MaxWaitTimeInSeconds' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'CompilationJobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateContext

$result = $client->createContext([/* ... */]);
$promise = $client->createContextAsync([/* ... */]);

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

Parameter Syntax

$result = $client->createContext([
    'ContextName' => '<string>', // REQUIRED
    'ContextType' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Properties' => ['<string>', ...],
    'Source' => [ // REQUIRED
        'SourceId' => '<string>',
        'SourceType' => '<string>',
        'SourceUri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ContextArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateDataQualityJobDefinition

$result = $client->createDataQualityJobDefinition([/* ... */]);
$promise = $client->createDataQualityJobDefinitionAsync([/* ... */]);

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

Parameter Syntax

$result = $client->createDataQualityJobDefinition([
    'DataQualityAppSpecification' => [ // REQUIRED
        'ContainerArguments' => ['<string>', ...],
        'ContainerEntrypoint' => ['<string>', ...],
        'Environment' => ['<string>', ...],
        'ImageUri' => '<string>', // REQUIRED
        'PostAnalyticsProcessorSourceUri' => '<string>',
        'RecordPreprocessorSourceUri' => '<string>',
    ],
    'DataQualityBaselineConfig' => [
        'BaseliningJobName' => '<string>',
        'ConstraintsResource' => [
            'S3Uri' => '<string>',
        ],
        'StatisticsResource' => [
            'S3Uri' => '<string>',
        ],
    ],
    'DataQualityJobInput' => [ // REQUIRED
        'BatchTransformInput' => [
            'DataCapturedDestinationS3Uri' => '<string>', // REQUIRED
            'DatasetFormat' => [ // REQUIRED
                'Csv' => [
                    'Header' => true || false,
                ],
                'Json' => [
                    'Line' => true || false,
                ],
                'Parquet' => [
                ],
            ],
            'EndTimeOffset' => '<string>',
            'ExcludeFeaturesAttribute' => '<string>',
            'FeaturesAttribute' => '<string>',
            'InferenceAttribute' => '<string>',
            'LocalPath' => '<string>', // REQUIRED
            'ProbabilityAttribute' => '<string>',
            'ProbabilityThresholdAttribute' => <float>,
            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
            'S3InputMode' => 'Pipe|File',
            'StartTimeOffset' => '<string>',
        ],
        'EndpointInput' => [
            'EndTimeOffset' => '<string>',
            'EndpointName' => '<string>', // REQUIRED
            'ExcludeFeaturesAttribute' => '<string>',
            'FeaturesAttribute' => '<string>',
            'InferenceAttribute' => '<string>',
            'LocalPath' => '<string>', // REQUIRED
            'ProbabilityAttribute' => '<string>',
            'ProbabilityThresholdAttribute' => <float>,
            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
            'S3InputMode' => 'Pipe|File',
            'StartTimeOffset' => '<string>',
        ],
    ],
    'DataQualityJobOutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'MonitoringOutputs' => [ // REQUIRED
            [
                'S3Output' => [ // REQUIRED
                    'LocalPath' => '<string>', // REQUIRED
                    'S3UploadMode' => 'Continuous|EndOfJob',
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'JobDefinitionName' => '<string>', // REQUIRED
    'JobResources' => [ // REQUIRED
        'ClusterConfig' => [ // REQUIRED
            'InstanceCount' => <integer>, // REQUIRED
            'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
    ],
    'NetworkConfig' => [
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableNetworkIsolation' => true || false,
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [
        'MaxRuntimeInSeconds' => <integer>, // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'JobDefinitionArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateDeviceFleet

$result = $client->createDeviceFleet([/* ... */]);
$promise = $client->createDeviceFleetAsync([/* ... */]);

Creates a device fleet.

Parameter Syntax

$result = $client->createDeviceFleet([
    'Description' => '<string>',
    'DeviceFleetName' => '<string>', // REQUIRED
    'EnableIotRoleAlias' => true || false,
    'OutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'PresetDeploymentConfig' => '<string>',
        'PresetDeploymentType' => 'GreengrassV2Component',
        'S3OutputLocation' => '<string>', // REQUIRED
    ],
    'RoleArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

• PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

• VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

  When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

Parameter Syntax

$result = $client->createDomain([
    'AppNetworkAccessType' => 'PublicInternetOnly|VpcOnly',
    'AppSecurityGroupManagement' => 'Service|Customer',
    'AuthMode' => 'SSO|IAM', // REQUIRED
    'DefaultSpaceSettings' => [
        'CustomFileSystemConfigs' => [
            [
                'EFSFileSystemConfig' => [
                    'FileSystemId' => '<string>', // REQUIRED
                    'FileSystemPath' => '<string>',
                ],
            ],
            // ...
        ],
        'CustomPosixUserConfig' => [
            'Gid' => <integer>, // REQUIRED
            'Uid' => <integer>, // REQUIRED
        ],
        'ExecutionRole' => '<string>',
        'JupyterLabAppSettings' => [
            'AppLifecycleManagement' => [
                'IdleSettings' => [
                    'IdleTimeoutInMinutes' => <integer>,
                    'LifecycleManagement' => 'ENABLED|DISABLED',
                    'MaxIdleTimeoutInMinutes' => <integer>,
                    'MinIdleTimeoutInMinutes' => <integer>,
                ],
            ],
            'BuiltInLifecycleConfigArn' => '<string>',
            'CodeRepositories' => [
                [
                    'RepositoryUrl' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'EmrSettings' => [
                'AssumableRoleArns' => ['<string>', ...],
                'ExecutionRoleArns' => ['<string>', ...],
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'JupyterServerAppSettings' => [
            'CodeRepositories' => [
                [
                    'RepositoryUrl' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'KernelGatewayAppSettings' => [
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'SecurityGroups' => ['<string>', ...],
        'SpaceStorageSettings' => [
            'DefaultEbsStorageSettings' => [
                'DefaultEbsVolumeSizeInGb' => <integer>, // REQUIRED
                'MaximumEbsVolumeSizeInGb' => <integer>, // REQUIRED
            ],
        ],
    ],
    'DefaultUserSettings' => [ // REQUIRED
        'AutoMountHomeEFS' => 'Enabled|Disabled|DefaultAsDomain',
        'CanvasAppSettings' => [
            'DirectDeploySettings' => [
                'Status' => 'ENABLED|DISABLED',
            ],
            'EmrServerlessSettings' => [
                'ExecutionRoleArn' => '<string>',
                'Status' => 'ENABLED|DISABLED',
            ],
            'GenerativeAiSettings' => [
                'AmazonBedrockRoleArn' => '<string>',
            ],
            'IdentityProviderOAuthSettings' => [
                [
                    'DataSourceName' => 'SalesforceGenie|Snowflake',
                    'SecretArn' => '<string>',
                    'Status' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
            'KendraSettings' => [
                'Status' => 'ENABLED|DISABLED',
            ],
            'ModelRegisterSettings' => [
                'CrossAccountModelRegisterRoleArn' => '<string>',
                'Status' => 'ENABLED|DISABLED',
            ],
            'TimeSeriesForecastingSettings' => [
                'AmazonForecastRoleArn' => '<string>',
                'Status' => 'ENABLED|DISABLED',
            ],
            'WorkspaceSettings' => [
                'S3ArtifactPath' => '<string>',
                'S3KmsKeyId' => '<string>',
            ],
        ],
        'CodeEditorAppSettings' => [
            'AppLifecycleManagement' => [
                'IdleSettings' => [
                    'IdleTimeoutInMinutes' => <integer>,
                    'LifecycleManagement' => 'ENABLED|DISABLED',
                    'MaxIdleTimeoutInMinutes' => <integer>,
                    'MinIdleTimeoutInMinutes' => <integer>,
                ],
            ],
            'BuiltInLifecycleConfigArn' => '<string>',
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'CustomFileSystemConfigs' => [
            [
                'EFSFileSystemConfig' => [
                    'FileSystemId' => '<string>', // REQUIRED
                    'FileSystemPath' => '<string>',
                ],
            ],
            // ...
        ],
        'CustomPosixUserConfig' => [
            'Gid' => <integer>, // REQUIRED
            'Uid' => <integer>, // REQUIRED
        ],
        'DefaultLandingUri' => '<string>',
        'ExecutionRole' => '<string>',
        'JupyterLabAppSettings' => [
            'AppLifecycleManagement' => [
                'IdleSettings' => [
                    'IdleTimeoutInMinutes' => <integer>,
                    'LifecycleManagement' => 'ENABLED|DISABLED',
                    'MaxIdleTimeoutInMinutes' => <integer>,
                    'MinIdleTimeoutInMinutes' => <integer>,
                ],
            ],
            'BuiltInLifecycleConfigArn' => '<string>',
            'CodeRepositories' => [
                [
                    'RepositoryUrl' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'EmrSettings' => [
                'AssumableRoleArns' => ['<string>', ...],
                'ExecutionRoleArns' => ['<string>', ...],
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'JupyterServerAppSettings' => [
            'CodeRepositories' => [
                [
                    'RepositoryUrl' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'KernelGatewayAppSettings' => [
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'LifecycleConfigArns' => ['<string>', ...],
        ],
        'RSessionAppSettings' => [
            'CustomImages' => [
                [
                    'AppImageConfigName' => '<string>', // REQUIRED
                    'ImageName' => '<string>', // REQUIRED
                    'ImageVersionNumber' => <integer>,
                ],
                // ...
            ],
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
        ],
        'RStudioServerProAppSettings' => [
            'AccessStatus' => 'ENABLED|DISABLED',
            'UserGroup' => 'R_STUDIO_ADMIN|R_STUDIO_USER',
        ],
        'SecurityGroups' => ['<string>', ...],
        'SharingSettings' => [
            'NotebookOutputOption' => 'Allowed|Disabled',
            'S3KmsKeyId' => '<string>',
            'S3OutputPath' => '<string>',
        ],
        'SpaceStorageSettings' => [
            'DefaultEbsStorageSettings' => [
                'DefaultEbsVolumeSizeInGb' => <integer>, // REQUIRED
                'MaximumEbsVolumeSizeInGb' => <integer>, // REQUIRED
            ],
        ],
        'StudioWebPortal' => 'ENABLED|DISABLED',
        'StudioWebPortalSettings' => [
            'HiddenAppTypes' => ['<string>', ...],
            'HiddenInstanceTypes' => ['<string>', ...],
            'HiddenMlTools' => ['<string>', ...],
            'HiddenSageMakerImageVersionAliases' => [
                [
                    'SageMakerImageName' => 'sagemaker_distribution',
                    'VersionAliases' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'TensorBoardAppSettings' => [
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
        ],
    ],
    'DomainName' => '<string>', // REQUIRED
    'DomainSettings' => [
        'AmazonQSettings' => [
            'QProfileArn' => '<string>',
            'Status' => 'ENABLED|DISABLED',
        ],
        'DockerSettings' => [
            'EnableDockerAccess' => 'ENABLED|DISABLED',
            'VpcOnlyTrustedAccounts' => ['<string>', ...],
        ],
        'ExecutionRoleIdentityConfig' => 'USER_PROFILE_NAME|DISABLED',
        'RStudioServerProDomainSettings' => [
            'DefaultResourceSpec' => [
                'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge',
                'LifecycleConfigArn' => '<string>',
                'SageMakerImageArn' => '<string>',
                'SageMakerImageVersionAlias' => '<string>',
                'SageMakerImageVersionArn' => '<string>',
            ],
            'DomainExecutionRoleArn' => '<string>', // REQUIRED
            'RStudioConnectUrl' => '<string>',
            'RStudioPackageManagerUrl' => '<string>',
        ],
        'SecurityGroupIds' => ['<string>', ...],
    ],
    'HomeEfsFileSystemKmsKeyId' => '<string>',
    'KmsKeyId' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'TagPropagation' => 'ENABLED|DISABLED',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DomainArn' => '<string>',
    'Url' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateEdgeDeploymentPlan

$result = $client->createEdgeDeploymentPlan([/* ... */]);
$promise = $client->createEdgeDeploymentPlanAsync([/* ... */]);

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

Parameter Syntax

$result = $client->createEdgeDeploymentPlan([
    'DeviceFleetName' => '<string>', // REQUIRED
    'EdgeDeploymentPlanName' => '<string>', // REQUIRED
    'ModelConfigs' => [ // REQUIRED
        [
            'EdgePackagingJobName' => '<string>', // REQUIRED
            'ModelHandle' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Stages' => [
        [
            'DeploymentConfig' => [
                'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING', // REQUIRED
            ],
            'DeviceSelectionConfig' => [ // REQUIRED
                'DeviceNameContains' => '<string>',
                'DeviceNames' => ['<string>', ...],
                'DeviceSubsetType' => 'PERCENTAGE|SELECTION|NAMECONTAINS', // REQUIRED
                'Percentage' => <integer>,
            ],
            'StageName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'EdgeDeploymentPlanArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateEdgeDeploymentStage

$result = $client->createEdgeDeploymentStage([/* ... */]);
$promise = $client->createEdgeDeploymentStageAsync([/* ... */]);

Creates a new stage in an existing edge deployment plan.

Parameter Syntax

$result = $client->createEdgeDeploymentStage([
    'EdgeDeploymentPlanName' => '<string>', // REQUIRED
    'Stages' => [ // REQUIRED
        [
            'DeploymentConfig' => [
                'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING', // REQUIRED
            ],
            'DeviceSelectionConfig' => [ // REQUIRED
                'DeviceNameContains' => '<string>',
                'DeviceNames' => ['<string>', ...],
                'DeviceSubsetType' => 'PERCENTAGE|SELECTION|NAMECONTAINS', // REQUIRED
                'Percentage' => <integer>,
            ],
            'StageName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateEdgePackagingJob

$result = $client->createEdgePackagingJob([/* ... */]);
$promise = $client->createEdgePackagingJobAsync([/* ... */]);

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

Parameter Syntax

$result = $client->createEdgePackagingJob([
    'CompilationJobName' => '<string>', // REQUIRED
    'EdgePackagingJobName' => '<string>', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'ModelVersion' => '<string>', // REQUIRED
    'OutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'PresetDeploymentConfig' => '<string>',
        'PresetDeploymentType' => 'GreengrassV2Component',
        'S3OutputLocation' => '<string>', // REQUIRED
    ],
    'ResourceKey' => '<string>',
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateEndpoint

$result = $client->createEndpoint([/* ... */]);
$promise = $client->createEndpointAsync([/* ... */]);

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

Parameter Syntax

$result = $client->createEndpoint([
    'DeploymentConfig' => [
        'AutoRollbackConfiguration' => [
            'Alarms' => [
                [
                    'AlarmName' => '<string>',
                ],
                // ...
            ],
        ],
        'BlueGreenUpdatePolicy' => [
            'MaximumExecutionTimeoutInSeconds' => <integer>,
            'TerminationWaitInSeconds' => <integer>,
            'TrafficRoutingConfiguration' => [ // REQUIRED
                'CanarySize' => [
                    'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
                    'Value' => <integer>, // REQUIRED
                ],
                'LinearStepSize' => [
                    'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
                    'Value' => <integer>, // REQUIRED
                ],
                'Type' => 'ALL_AT_ONCE|CANARY|LINEAR', // REQUIRED
                'WaitIntervalInSeconds' => <integer>, // REQUIRED
            ],
        ],
        'RollingUpdatePolicy' => [
            'MaximumBatchSize' => [ // REQUIRED
                'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
                'Value' => <integer>, // REQUIRED
            ],
            'MaximumExecutionTimeoutInSeconds' => <integer>,
            'RollbackMaximumBatchSize' => [
                'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
                'Value' => <integer>, // REQUIRED
            ],
            'WaitIntervalInSeconds' => <integer>, // REQUIRED
        ],
    ],
    'EndpointConfigName' => '<string>', // REQUIRED
    'EndpointName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'EndpointArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateEndpointConfig

$result = $client->createEndpointConfig([/* ... */]);
$promise = $client->createEndpointConfigAsync([/* ... */]);

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

Parameter Syntax

$result = $client->createEndpointConfig([
    'AsyncInferenceConfig' => [
        'ClientConfig' => [
            'MaxConcurrentInvocationsPerInstance' => <integer>,
        ],
        'OutputConfig' => [ // REQUIRED
            'KmsKeyId' => '<string>',
            'NotificationConfig' => [
                'ErrorTopic' => '<string>',
                'IncludeInferenceResponseIn' => ['<string>', ...],
                'SuccessTopic' => '<string>',
            ],
            'S3FailurePath' => '<string>',
            'S3OutputPath' => '<string>',
        ],
    ],
    'DataCaptureConfig' => [
        'CaptureContentTypeHeader' => [
            'CsvContentTypes' => ['<string>', ...],
            'JsonContentTypes' => ['<string>', ...],
        ],
        'CaptureOptions' => [ // REQUIRED
            [
                'CaptureMode' => 'Input|Output|InputAndOutput', // REQUIRED
            ],
            // ...
        ],
        'DestinationS3Uri' => '<string>', // REQUIRED
        'EnableCapture' => true || false,
        'InitialSamplingPercentage' => <integer>, // REQUIRED
        'KmsKeyId' => '<string>',
    ],
    'EnableNetworkIsolation' => true || false,
    'EndpointConfigName' => '<string>', // REQUIRED
    'ExecutionRoleArn' => '<string>',
    'ExplainerConfig' => [
        'ClarifyExplainerConfig' => [
            'EnableExplanations' => '<string>',
            'InferenceConfig' => [
                'ContentTemplate' => '<string>',
                'FeatureHeaders' => ['<string>', ...],
                'FeatureTypes' => ['<string>', ...],
                'FeaturesAttribute' => '<string>',
                'LabelAttribute' => '<string>',
                'LabelHeaders' => ['<string>', ...],
                'LabelIndex' => <integer>,
                'MaxPayloadInMB' => <integer>,
                'MaxRecordCount' => <integer>,
                'ProbabilityAttribute' => '<string>',
                'ProbabilityIndex' => <integer>,
            ],
            'ShapConfig' => [ // REQUIRED
                'NumberOfSamples' => <integer>,
                'Seed' => <integer>,
                'ShapBaselineConfig' => [ // REQUIRED
                    'MimeType' => '<string>',
                    'ShapBaseline' => '<string>',
                    'ShapBaselineUri' => '<string>',
                ],
                'TextConfig' => [
                    'Granularity' => 'token|sentence|paragraph', // REQUIRED
                    'Language' => 'af|sq|ar|hy|eu|bn|bg|ca|zh|hr|cs|da|nl|en|et|fi|fr|de|el|gu|he|hi|hu|is|id|ga|it|kn|ky|lv|lt|lb|mk|ml|mr|ne|nb|fa|pl|pt|ro|ru|sa|sr|tn|si|sk|sl|es|sv|tl|ta|tt|te|tr|uk|ur|yo|lij|xx', // REQUIRED
                ],
                'UseLogit' => true || false,
            ],
        ],
    ],
    'KmsKeyId' => '<string>',
    'ProductionVariants' => [ // REQUIRED
        [
            'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
            'ContainerStartupHealthCheckTimeoutInSeconds' => <integer>,
            'CoreDumpConfig' => [
                'DestinationS3Uri' => '<string>', // REQUIRED
                'KmsKeyId' => '<string>',
            ],
            'EnableSSMAccess' => true || false,
            'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2',
            'InitialInstanceCount' => <integer>,
            'InitialVariantWeight' => <float>,
            'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge',
            'ManagedInstanceScaling' => [
                'MaxInstanceCount' => <integer>,
                'MinInstanceCount' => <integer>,
                'Status' => 'ENABLED|DISABLED',
            ],
            'ModelDataDownloadTimeoutInSeconds' => <integer>,
            'ModelName' => '<string>',
            'RoutingConfig' => [
                'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM', // REQUIRED
            ],
            'ServerlessConfig' => [
                'MaxConcurrency' => <integer>, // REQUIRED
                'MemorySizeInMB' => <integer>, // REQUIRED
                'ProvisionedConcurrency' => <integer>,
            ],
            'VariantName' => '<string>', // REQUIRED
            'VolumeSizeInGB' => <integer>,
        ],
        // ...
    ],
    'ShadowProductionVariants' => [
        [
            'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
            'ContainerStartupHealthCheckTimeoutInSeconds' => <integer>,
            'CoreDumpConfig' => [
                'DestinationS3Uri' => '<string>', // REQUIRED
                'KmsKeyId' => '<string>',
            ],
            'EnableSSMAccess' => true || false,
            'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2',
            'InitialInstanceCount' => <integer>,
            'InitialVariantWeight' => <float>,
            'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge',
            'ManagedInstanceScaling' => [
                'MaxInstanceCount' => <integer>,
                'MinInstanceCount' => <integer>,
                'Status' => 'ENABLED|DISABLED',
            ],
            'ModelDataDownloadTimeoutInSeconds' => <integer>,
            'ModelName' => '<string>',
            'RoutingConfig' => [
                'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM', // REQUIRED
            ],
            'ServerlessConfig' => [
                'MaxConcurrency' => <integer>, // REQUIRED
                'MemorySizeInMB' => <integer>, // REQUIRED
                'ProvisionedConcurrency' => <integer>,
            ],
            'VariantName' => '<string>', // REQUIRED
            'VolumeSizeInGB' => <integer>,
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'EndpointConfigArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateExperiment

$result = $client->createExperiment([/* ... */]);
$promise = $client->createExperimentAsync([/* ... */]);

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

Parameter Syntax

$result = $client->createExperiment([
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'ExperimentName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ExperimentArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateFeatureGroup

$result = $client->createFeatureGroup([/* ... */]);
$promise = $client->createFeatureGroupAsync([/* ... */]);

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

Parameter Syntax

$result = $client->createFeatureGroup([
    'Description' => '<string>',
    'EventTimeFeatureName' => '<string>', // REQUIRED
    'FeatureDefinitions' => [ // REQUIRED
        [
            'CollectionConfig' => [
                'VectorConfig' => [
                    'Dimension' => <integer>, // REQUIRED
                ],
            ],
            'CollectionType' => 'List|Set|Vector',
            'FeatureName' => '<string>', // REQUIRED
            'FeatureType' => 'Integral|Fractional|String', // REQUIRED
        ],
        // ...
    ],
    'FeatureGroupName' => '<string>', // REQUIRED
    'OfflineStoreConfig' => [
        'DataCatalogConfig' => [
            'Catalog' => '<string>', // REQUIRED
            'Database' => '<string>', // REQUIRED
            'TableName' => '<string>', // REQUIRED
        ],
        'DisableGlueTableCreation' => true || false,
        'S3StorageConfig' => [ // REQUIRED
            'KmsKeyId' => '<string>',
            'ResolvedOutputS3Uri' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
        'TableFormat' => 'Default|Glue|Iceberg',
    ],
    'OnlineStoreConfig' => [
        'EnableOnlineStore' => true || false,
        'SecurityConfig' => [
            'KmsKeyId' => '<string>',
        ],
        'StorageType' => 'Standard|InMemory',
        'TtlDuration' => [
            'Unit' => 'Seconds|Minutes|Hours|Days|Weeks',
            'Value' => <integer>,
        ],
    ],
    'RecordIdentifierFeatureName' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ThroughputConfig' => [
        'ProvisionedReadCapacityUnits' => <integer>,
        'ProvisionedWriteCapacityUnits' => <integer>,
        'ThroughputMode' => 'OnDemand|Provisioned', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'FeatureGroupArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateFlowDefinition

$result = $client->createFlowDefinition([/* ... */]);
$promise = $client->createFlowDefinitionAsync([/* ... */]);

Creates a flow definition.

Parameter Syntax

$result = $client->createFlowDefinition([
    'FlowDefinitionName' => '<string>', // REQUIRED
    'HumanLoopActivationConfig' => [
        'HumanLoopActivationConditionsConfig' => [ // REQUIRED
            'HumanLoopActivationConditions' => '<string>', // REQUIRED
        ],
    ],
    'HumanLoopConfig' => [
        'HumanTaskUiArn' => '<string>', // REQUIRED
        'PublicWorkforceTaskPrice' => [
            'AmountInUsd' => [
                'Cents' => <integer>,
                'Dollars' => <integer>,
                'TenthFractionsOfACent' => <integer>,
            ],
        ],
        'TaskAvailabilityLifetimeInSeconds' => <integer>,
        'TaskCount' => <integer>, // REQUIRED
        'TaskDescription' => '<string>', // REQUIRED
        'TaskKeywords' => ['<string>', ...],
        'TaskTimeLimitInSeconds' => <integer>,
        'TaskTitle' => '<string>', // REQUIRED
        'WorkteamArn' => '<string>', // REQUIRED
    ],
    'HumanLoopRequestSource' => [
        'AwsManagedHumanLoopRequestSource' => 'AWS/Rekognition/DetectModerationLabels/Image/V3|AWS/Textract/AnalyzeDocument/Forms/V1', // REQUIRED
    ],
    'OutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FlowDefinitionArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateHub

$result = $client->createHub([/* ... */]);
$promise = $client->createHubAsync([/* ... */]);

Create a hub.

Parameter Syntax

$result = $client->createHub([
    'HubDescription' => '<string>', // REQUIRED
    'HubDisplayName' => '<string>',
    'HubName' => '<string>', // REQUIRED
    'HubSearchKeywords' => ['<string>', ...],
    'S3StorageConfig' => [
        'S3OutputPath' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'HubArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateHubContentReference

$result = $client->createHubContentReference([/* ... */]);
$promise = $client->createHubContentReferenceAsync([/* ... */]);

Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.

Parameter Syntax

$result = $client->createHubContentReference([
    'HubContentName' => '<string>',
    'HubName' => '<string>', // REQUIRED
    'MinVersion' => '<string>',
    'SageMakerPublicHubContentArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'HubArn' => '<string>',
    'HubContentArn' => '<string>',
]

Result Details

Errors

ResourceNotFound:

Resource being access is not found.

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateHumanTaskUi

$result = $client->createHumanTaskUi([/* ... */]);
$promise = $client->createHumanTaskUiAsync([/* ... */]);

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

Parameter Syntax

$result = $client->createHumanTaskUi([
    'HumanTaskUiName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UiTemplate' => [ // REQUIRED
        'Content' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'HumanTaskUiArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateHyperParameterTuningJob

$result = $client->createHyperParameterTuningJob([/* ... */]);
$promise = $client->createHyperParameterTuningJobAsync([/* ... */]);

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Parameter Syntax

$result = $client->createHyperParameterTuningJob([
    'Autotune' => [
        'Mode' => 'Enabled', // REQUIRED
    ],
    'HyperParameterTuningJobConfig' => [ // REQUIRED
        'HyperParameterTuningJobObjective' => [
            'MetricName' => '<string>', // REQUIRED
            'Type' => 'Maximize|Minimize', // REQUIRED
        ],
        'ParameterRanges' => [
            'AutoParameters' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'ValueHint' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CategoricalParameterRanges' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ContinuousParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                    'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                ],
                // ...
            ],
            'IntegerParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                    'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                ],
                // ...
            ],
        ],
        'RandomSeed' => <integer>,
        'ResourceLimits' => [ // REQUIRED
            'MaxNumberOfTrainingJobs' => <integer>,
            'MaxParallelTrainingJobs' => <integer>, // REQUIRED
            'MaxRuntimeInSeconds' => <integer>,
        ],
        'Strategy' => 'Bayesian|Random|Hyperband|Grid', // REQUIRED
        'StrategyConfig' => [
            'HyperbandStrategyConfig' => [
                'MaxResource' => <integer>,
                'MinResource' => <integer>,
            ],
        ],
        'TrainingJobEarlyStoppingType' => 'Off|Auto',
        'TuningJobCompletionCriteria' => [
            'BestObjectiveNotImproving' => [
                'MaxNumberOfTrainingJobsNotImproving' => <integer>,
            ],
            'ConvergenceDetected' => [
                'CompleteOnConvergence' => 'Disabled|Enabled',
            ],
            'TargetObjectiveMetricValue' => <float>,
        ],
    ],
    'HyperParameterTuningJobName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrainingJobDefinition' => [
        'AlgorithmSpecification' => [ // REQUIRED
            'AlgorithmName' => '<string>',
            'MetricDefinitions' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Regex' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TrainingImage' => '<string>',
            'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
        ],
        'CheckpointConfig' => [
            'LocalPath' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
        'DefinitionName' => '<string>',
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableManagedSpotTraining' => true || false,
        'EnableNetworkIsolation' => true || false,
        'Environment' => ['<string>', ...],
        'HyperParameterRanges' => [
            'AutoParameters' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'ValueHint' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CategoricalParameterRanges' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ContinuousParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                    'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                ],
                // ...
            ],
            'IntegerParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                    'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                ],
                // ...
            ],
        ],
        'HyperParameterTuningResourceConfig' => [
            'AllocationStrategy' => 'Prioritized',
            'InstanceConfigs' => [
                [
                    'InstanceCount' => <integer>, // REQUIRED
                    'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
                    'VolumeSizeInGB' => <integer>, // REQUIRED
                ],
                // ...
            ],
            'InstanceCount' => <integer>,
            'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>,
        ],
        'InputDataConfig' => [
            [
                'ChannelName' => '<string>', // REQUIRED
                'CompressionType' => 'None|Gzip',
                'ContentType' => '<string>',
                'DataSource' => [ // REQUIRED
                    'FileSystemDataSource' => [
                        'DirectoryPath' => '<string>', // REQUIRED
                        'FileSystemAccessMode' => 'rw|ro', // REQUIRED
                        'FileSystemId' => '<string>', // REQUIRED
                        'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
                    ],
                    'S3DataSource' => [
                        'AttributeNames' => ['<string>', ...],
                        'InstanceGroupNames' => ['<string>', ...],
                        'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                        'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                        'S3Uri' => '<string>', // REQUIRED
                    ],
                ],
                'InputMode' => 'Pipe|File|FastFile',
                'RecordWrapperType' => 'None|RecordIO',
                'ShuffleConfig' => [
                    'Seed' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'OutputDataConfig' => [ // REQUIRED
            'CompressionType' => 'GZIP|NONE',
            'KmsKeyId' => '<string>',
            'S3OutputPath' => '<string>', // REQUIRED
        ],
        'ResourceConfig' => [
            'InstanceCount' => <integer>,
            'InstanceGroups' => [
                [
                    'InstanceCount' => <integer>, // REQUIRED
                    'InstanceGroupName' => '<string>', // REQUIRED
                    'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
                ],
                // ...
            ],
            'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
            'KeepAlivePeriodInSeconds' => <integer>,
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
        'RetryStrategy' => [
            'MaximumRetryAttempts' => <integer>, // REQUIRED
        ],
        'RoleArn' => '<string>', // REQUIRED
        'StaticHyperParameters' => ['<string>', ...],
        'StoppingCondition' => [ // REQUIRED
            'MaxPendingTimeInSeconds' => <integer>,
            'MaxRuntimeInSeconds' => <integer>,
            'MaxWaitTimeInSeconds' => <integer>,
        ],
        'TuningObjective' => [
            'MetricName' => '<string>', // REQUIRED
            'Type' => 'Maximize|Minimize', // REQUIRED
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'TrainingJobDefinitions' => [
        [
            'AlgorithmSpecification' => [ // REQUIRED
                'AlgorithmName' => '<string>',
                'MetricDefinitions' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Regex' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'TrainingImage' => '<string>',
                'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
            ],
            'CheckpointConfig' => [
                'LocalPath' => '<string>',
                'S3Uri' => '<string>', // REQUIRED
            ],
            'DefinitionName' => '<string>',
            'EnableInterContainerTrafficEncryption' => true || false,
            'EnableManagedSpotTraining' => true || false,
            'EnableNetworkIsolation' => true || false,
            'Environment' => ['<string>', ...],
            'HyperParameterRanges' => [
                'AutoParameters' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'ValueHint' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'CategoricalParameterRanges' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'ContinuousParameterRanges' => [
                    [
                        'MaxValue' => '<string>', // REQUIRED
                        'MinValue' => '<string>', // REQUIRED
                        'Name' => '<string>', // REQUIRED
                        'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                    ],
                    // ...
                ],
                'IntegerParameterRanges' => [
                    [
                        'MaxValue' => '<string>', // REQUIRED
                        'MinValue' => '<string>', // REQUIRED
                        'Name' => '<string>', // REQUIRED
                        'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
                    ],
                    // ...
                ],
            ],
            'HyperParameterTuningResourceConfig' => [
                'AllocationStrategy' => 'Prioritized',
                'InstanceConfigs' => [
                    [
                        'InstanceCount' => <integer>, // REQUIRED
                        'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
                        'VolumeSizeInGB' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
                'InstanceCount' => <integer>,
                'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
                'VolumeKmsKeyId' => '<string>',
                'VolumeSizeInGB' => <integer>,
            ],
            'InputDataConfig' => [
                [
                    'ChannelName' => '<string>', // REQUIRED
                    'CompressionType' => 'None|Gzip',
                    'ContentType' => '<string>',
                    'DataSource' => [ // REQUIRED
                        'FileSystemDataSource' => [
                            'DirectoryPath' => '<string>', // REQUIRED
                            'FileSystemAccessMode' => 'rw|ro', // REQUIRED
                            'FileSystemId' => '<string>', // REQUIRED
                            'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
                        ],
                        'S3DataSource' => [
                            'AttributeNames' => ['<string>', ...],
                            'InstanceGroupNames' => ['<string>', ...],
                            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                            'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                            'S3Uri' => '<string>', // REQUIRED
                        ],
                    ],
                    'InputMode' => 'Pipe|File|FastFile',
                    'RecordWrapperType' => 'None|RecordIO',
                    'ShuffleConfig' => [
                        'Seed' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            'OutputDataConfig' => [ // REQUIRED
                'CompressionType' => 'GZIP|NONE',
                'KmsKeyId' => '<string>',
                'S3OutputPath' => '<string>', // REQUIRED
            ],
            'ResourceConfig' => [
                'InstanceCount' => <integer>,
                'InstanceGroups' => [
                    [
                        'InstanceCount' => <integer>, // REQUIRED
                        'InstanceGroupName' => '<string>', // REQUIRED
                        'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
                    ],
                    // ...
                ],
                'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
                'KeepAlivePeriodInSeconds' => <integer>,
                'VolumeKmsKeyId' => '<string>',
                'VolumeSizeInGB' => <integer>, // REQUIRED
            ],
            'RetryStrategy' => [
                'MaximumRetryAttempts' => <integer>, // REQUIRED
            ],
            'RoleArn' => '<string>', // REQUIRED
            'StaticHyperParameters' => ['<string>', ...],
            'StoppingCondition' => [ // REQUIRED
                'MaxPendingTimeInSeconds' => <integer>,
                'MaxRuntimeInSeconds' => <integer>,
                'MaxWaitTimeInSeconds' => <integer>,
            ],
            'TuningObjective' => [
                'MetricName' => '<string>', // REQUIRED
                'Type' => 'Maximize|Minimize', // REQUIRED
            ],
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'Subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
        // ...
    ],
    'WarmStartConfig' => [
        'ParentHyperParameterTuningJobs' => [ // REQUIRED
            [
                'HyperParameterTuningJobName' => '<string>',
            ],
            // ...
        ],
        'WarmStartType' => 'IdenticalDataAndAlgorithm|TransferLearning', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'HyperParameterTuningJobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateImage

$result = $client->createImage([/* ... */]);
$promise = $client->createImageAsync([/* ... */]);

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

Parameter Syntax

$result = $client->createImage([
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'ImageName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ImageArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateImageVersion

$result = $client->createImageVersion([/* ... */]);
$promise = $client->createImageVersionAsync([/* ... */]);

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

Parameter Syntax

$result = $client->createImageVersion([
    'Aliases' => ['<string>', ...],
    'BaseImage' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Horovod' => true || false,
    'ImageName' => '<string>', // REQUIRED
    'JobType' => 'TRAINING|INFERENCE|NOTEBOOK_KERNEL',
    'MLFramework' => '<string>',
    'Processor' => 'CPU|GPU',
    'ProgrammingLang' => '<string>',
    'ReleaseNotes' => '<string>',
    'VendorGuidance' => 'NOT_PROVIDED|STABLE|TO_BE_ARCHIVED|ARCHIVED',
]);

Parameter Details

Result Syntax

[
    'ImageVersionArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceNotFound:

Resource being access is not found.

CreateInferenceComponent

$result = $client->createInferenceComponent([/* ... */]);
$promise = $client->createInferenceComponentAsync([/* ... */]);

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

Parameter Syntax

$result = $client->createInferenceComponent([
    'EndpointName' => '<string>', // REQUIRED
    'InferenceComponentName' => '<string>', // REQUIRED
    'RuntimeConfig' => [ // REQUIRED
        'CopyCount' => <integer>, // REQUIRED
    ],
    'Specification' => [ // REQUIRED
        'ComputeResourceRequirements' => [ // REQUIRED
            'MaxMemoryRequiredInMb' => <integer>,
            'MinMemoryRequiredInMb' => <integer>, // REQUIRED
            'NumberOfAcceleratorDevicesRequired' => <float>,
            'NumberOfCpuCoresRequired' => <float>,
        ],
        'Container' => [
            'ArtifactUrl' => '<string>',
            'Environment' => ['<string>', ...],
            'Image' => '<string>',
        ],
        'ModelName' => '<string>',
        'StartupParameters' => [
            'ContainerStartupHealthCheckTimeoutInSeconds' => <integer>,
            'ModelDataDownloadTimeoutInSeconds' => <integer>,
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VariantName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InferenceComponentArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateInferenceExperiment

$result = $client->createInferenceExperiment([/* ... */]);
$promise = $client->createInferenceExperimentAsync([/* ... */]);

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

Parameter Syntax

$result = $client->createInferenceExperiment([
    'DataStorageConfig' => [
        'ContentType' => [
            'CsvContentTypes' => ['<string>', ...],
            'JsonContentTypes' => ['<string>', ...],
        ],
        'Destination' => '<string>', // REQUIRED
        'KmsKey' => '<string>',
    ],
    'Description' => '<string>',
    'EndpointName' => '<string>', // REQUIRED
    'KmsKey' => '<string>',
    'ModelVariants' => [ // REQUIRED
        [
            'InfrastructureConfig' => [ // REQUIRED
                'InfrastructureType' => 'RealTimeInference', // REQUIRED
                'RealTimeInferenceConfig' => [ // REQUIRED
                    'InstanceCount' => <integer>, // REQUIRED
                    'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge', // REQUIRED
                ],
            ],
            'ModelName' => '<string>', // REQUIRED
            'VariantName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Schedule' => [
        'EndTime' => <integer || string || DateTime>,
        'StartTime' => <integer || string || DateTime>,
    ],
    'ShadowModeConfig' => [ // REQUIRED
        'ShadowModelVariants' => [ // REQUIRED
            [
                'SamplingPercentage' => <integer>, // REQUIRED
                'ShadowModelVariantName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SourceModelVariantName' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'ShadowMode', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InferenceExperimentArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateInferenceRecommendationsJob

$result = $client->createInferenceRecommendationsJob([/* ... */]);
$promise = $client->createInferenceRecommendationsJobAsync([/* ... */]);

Starts a recommendation job. You can create either an instance recommendation or load test job.

Parameter Syntax

$result = $client->createInferenceRecommendationsJob([
    'InputConfig' => [ // REQUIRED
        'ContainerConfig' => [
            'DataInputConfig' => '<string>',
            'Domain' => '<string>',
            'Framework' => '<string>',
            'FrameworkVersion' => '<string>',
            'NearestModelName' => '<string>',
            'PayloadConfig' => [
                'SamplePayloadUrl' => '<string>',
                'SupportedContentTypes' => ['<string>', ...],
            ],
            'SupportedEndpointType' => 'RealTime|Serverless',
            'SupportedInstanceTypes' => ['<string>', ...],
            'SupportedResponseMIMETypes' => ['<string>', ...],
            'Task' => '<string>',
        ],
        'EndpointConfigurations' => [
            [
                'EnvironmentParameterRanges' => [
                    'CategoricalParameterRanges' => [
                        [
                            'Name' => '<string>', // REQUIRED
                            'Value' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'InferenceSpecificationName' => '<string>',
                'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge',
                'ServerlessConfig' => [
                    'MaxConcurrency' => <integer>, // REQUIRED
                    'MemorySizeInMB' => <integer>, // REQUIRED
                    'ProvisionedConcurrency' => <integer>,
                ],
            ],
            // ...
        ],
        'Endpoints' => [
            [
                'EndpointName' => '<string>',
            ],
            // ...
        ],
        'JobDurationInSeconds' => <integer>,
        'ModelName' => '<string>',
        'ModelPackageVersionArn' => '<string>',
        'ResourceLimit' => [
            'MaxNumberOfTests' => <integer>,
            'MaxParallelOfTests' => <integer>,
        ],
        'TrafficPattern' => [
            'Phases' => [
                [
                    'DurationInSeconds' => <integer>,
                    'InitialNumberOfUsers' => <integer>,
                    'SpawnRate' => <integer>,
                ],
                // ...
            ],
            'Stairs' => [
                'DurationInSeconds' => <integer>,
                'NumberOfSteps' => <integer>,
                'UsersPerStep' => <integer>,
            ],
            'TrafficType' => 'PHASES|STAIRS',
        ],
        'VolumeKmsKeyId' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'JobDescription' => '<string>',
    'JobName' => '<string>', // REQUIRED
    'JobType' => 'Default|Advanced', // REQUIRED
    'OutputConfig' => [
        'CompiledOutputConfig' => [
            'S3OutputUri' => '<string>',
        ],
        'KmsKeyId' => '<string>',
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingConditions' => [
        'FlatInvocations' => 'Continue|Stop',
        'MaxInvocations' => <integer>,
        'ModelLatencyThresholds' => [
            [
                'Percentile' => '<string>',
                'ValueInMilliseconds' => <integer>,
            ],
            // ...
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'JobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateLabelingJob

$result = $client->createLabelingJob([/* ... */]);
$promise = $client->createLabelingJobAsync([/* ... */]);

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

• A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

• One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

• The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

Parameter Syntax

$result = $client->createLabelingJob([
    'HumanTaskConfig' => [ // REQUIRED
        'AnnotationConsolidationConfig' => [
            'AnnotationConsolidationLambdaArn' => '<string>', // REQUIRED
        ],
        'MaxConcurrentTaskCount' => <integer>,
        'NumberOfHumanWorkersPerDataObject' => <integer>, // REQUIRED
        'PreHumanTaskLambdaArn' => '<string>',
        'PublicWorkforceTaskPrice' => [
            'AmountInUsd' => [
                'Cents' => <integer>,
                'Dollars' => <integer>,
                'TenthFractionsOfACent' => <integer>,
            ],
        ],
        'TaskAvailabilityLifetimeInSeconds' => <integer>,
        'TaskDescription' => '<string>', // REQUIRED
        'TaskKeywords' => ['<string>', ...],
        'TaskTimeLimitInSeconds' => <integer>, // REQUIRED
        'TaskTitle' => '<string>', // REQUIRED
        'UiConfig' => [ // REQUIRED
            'HumanTaskUiArn' => '<string>',
            'UiTemplateS3Uri' => '<string>',
        ],
        'WorkteamArn' => '<string>', // REQUIRED
    ],
    'InputConfig' => [ // REQUIRED
        'DataAttributes' => [
            'ContentClassifiers' => ['<string>', ...],
        ],
        'DataSource' => [ // REQUIRED
            'S3DataSource' => [
                'ManifestS3Uri' => '<string>', // REQUIRED
            ],
            'SnsDataSource' => [
                'SnsTopicArn' => '<string>', // REQUIRED
            ],
        ],
    ],
    'LabelAttributeName' => '<string>', // REQUIRED
    'LabelCategoryConfigS3Uri' => '<string>',
    'LabelingJobAlgorithmsConfig' => [
        'InitialActiveLearningModelArn' => '<string>',
        'LabelingJobAlgorithmSpecificationArn' => '<string>', // REQUIRED
        'LabelingJobResourceConfig' => [
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'Subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'LabelingJobName' => '<string>', // REQUIRED
    'OutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
        'SnsTopicArn' => '<string>',
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingConditions' => [
        'MaxHumanLabeledObjectCount' => <integer>,
        'MaxPercentageOfInputDatasetLabeled' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LabelingJobArn' => '<string>',
]

Result Details

Errors

ResourceInUse:

Resource being accessed is in use.

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateMlflowTrackingServer

$result = $client->createMlflowTrackingServer([/* ... */]);
$promise = $client->createMlflowTrackingServerAsync([/* ... */]);

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.

Parameter Syntax

$result = $client->createMlflowTrackingServer([
    'ArtifactStoreUri' => '<string>', // REQUIRED
    'AutomaticModelRegistration' => true || false,
    'MlflowVersion' => '<string>',
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrackingServerName' => '<string>', // REQUIRED
    'TrackingServerSize' => 'Small|Medium|Large',
    'WeeklyMaintenanceWindowStart' => '<string>',
]);

Parameter Details

Result Syntax

[
    'TrackingServerArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateModel

$result = $client->createModel([/* ... */]);
$promise = $client->createModelAsync([/* ... */]);

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

Parameter Syntax

$result = $client->createModel([
    'Containers' => [
        [
            'AdditionalModelDataSources' => [
                [
                    'ChannelName' => '<string>', // REQUIRED
                    'S3DataSource' => [ // REQUIRED
                        'CompressionType' => 'None|Gzip', // REQUIRED
                        'HubAccessConfig' => [
                            'HubContentArn' => '<string>', // REQUIRED
                        ],
                        'ManifestS3Uri' => '<string>',
                        'ModelAccessConfig' => [
                            'AcceptEula' => true || false, // REQUIRED
                        ],
                        'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
                        'S3Uri' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'ContainerHostname' => '<string>',
            'Environment' => ['<string>', ...],
            'Image' => '<string>',
            'ImageConfig' => [
                'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
                'RepositoryAuthConfig' => [
                    'RepositoryCredentialsProviderArn' => '<string>', // REQUIRED
                ],
            ],
            'InferenceSpecificationName' => '<string>',
            'Mode' => 'SingleModel|MultiModel',
            'ModelDataSource' => [
                'S3DataSource' => [
                    'CompressionType' => 'None|Gzip', // REQUIRED
                    'HubAccessConfig' => [
                        'HubContentArn' => '<string>', // REQUIRED
                    ],
                    'ManifestS3Uri' => '<string>',
                    'ModelAccessConfig' => [
                        'AcceptEula' => true || false, // REQUIRED
                    ],
                    'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            'ModelDataUrl' => '<string>',
            'ModelPackageName' => '<string>',
            'MultiModelConfig' => [
                'ModelCacheSetting' => 'Enabled|Disabled',
            ],
        ],
        // ...
    ],
    'EnableNetworkIsolation' => true || false,
    'ExecutionRoleArn' => '<string>',
    'InferenceExecutionConfig' => [
        'Mode' => 'Serial|Direct', // REQUIRED
    ],
    'ModelName' => '<string>', // REQUIRED
    'PrimaryContainer' => [
        'AdditionalModelDataSources' => [
            [
                'ChannelName' => '<string>', // REQUIRED
                'S3DataSource' => [ // REQUIRED
                    'CompressionType' => 'None|Gzip', // REQUIRED
                    'HubAccessConfig' => [
                        'HubContentArn' => '<string>', // REQUIRED
                    ],
                    'ManifestS3Uri' => '<string>',
                    'ModelAccessConfig' => [
                        'AcceptEula' => true || false, // REQUIRED
                    ],
                    'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'ContainerHostname' => '<string>',
        'Environment' => ['<string>', ...],
        'Image' => '<string>',
        'ImageConfig' => [
            'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
            'RepositoryAuthConfig' => [
                'RepositoryCredentialsProviderArn' => '<string>', // REQUIRED
            ],
        ],
        'InferenceSpecificationName' => '<string>',
        'Mode' => 'SingleModel|MultiModel',
        'ModelDataSource' => [
            'S3DataSource' => [
                'CompressionType' => 'None|Gzip', // REQUIRED
                'HubAccessConfig' => [
                    'HubContentArn' => '<string>', // REQUIRED
                ],
                'ManifestS3Uri' => '<string>',
                'ModelAccessConfig' => [
                    'AcceptEula' => true || false, // REQUIRED
                ],
                'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
                'S3Uri' => '<string>', // REQUIRED
            ],
        ],
        'ModelDataUrl' => '<string>',
        'ModelPackageName' => '<string>',
        'MultiModelConfig' => [
            'ModelCacheSetting' => 'Enabled|Disabled',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

CreateModelBiasJobDefinition

$result = $client->createModelBiasJobDefinition([/* ... */]);
$promise = $client->createModelBiasJobDefinitionAsync([/* ... */]);

Creates the definition for a model bias job.

Parameter Syntax

$result = $client->createModelBiasJobDefinition([
    'JobDefinitionName' => '<string>', // REQUIRED
    'JobResources' => [ // REQUIRED
        'ClusterConfig' => [ // REQUIRED
            'InstanceCount' => <integer>, // REQUIRED
            'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
    ],
    'ModelBiasAppSpecification' => [ // REQUIRED
        'ConfigUri' => '<string>', // REQUIRED
        'Environment' => ['<string>', ...],
        'ImageUri' => '<string>', // REQUIRED
    ],
    'ModelBiasBaselineConfig' => [
        'BaseliningJobName' => '<string>',
        'ConstraintsResource' => [
            'S3Uri' => '<string>',
        ],
    ],
    'ModelBiasJobInput' => [ // REQUIRED
        'BatchTransformInput' => [
            'DataCapturedDestinationS3Uri' => '<string>', // REQUIRED
            'DatasetFormat' => [ // REQUIRED
                'Csv' => [
                    'Header' => true || false,
                ],
                'Json' => [
                    'Line' => true || false,
                ],
                'Parquet' => [
                ],
            ],
            'EndTimeOffset' => '<string>',
            'ExcludeFeaturesAttribute' => '<string>',
            'FeaturesAttribute' => '<string>',
            'InferenceAttribute' => '<string>',
            'LocalPath' => '<string>', // REQUIRED
            'ProbabilityAttribute' => '<string>',
            'ProbabilityThresholdAttribute' => <float>,
            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
            'S3InputMode' => 'Pipe|File',
            'StartTimeOffset' => '<string>',
        ],
        'EndpointInput' => [
            'EndTimeOffset' => '<string>',
            'EndpointName' => '<string>', // REQUIRED
            'ExcludeFeaturesAttribute' => '<string>',
            'FeaturesAttribute' => '<string>',
            'InferenceAttribute' => '<string>',
            'LocalPath' => '<string>', // REQUIRED
            'ProbabilityAttribute' => '<string>',
            'ProbabilityThresholdAttribute' => <float>,
            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
            'S3InputMode' => 'Pipe|File',
            'StartTimeOffset' => '<string>',
        ],
        'GroundTruthS3Input' => [ // REQUIRED
            'S3Uri' => '<string>',
        ],
    ],
    'ModelBiasJobOutputConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'MonitoringOutputs' => [ // REQUIRED
            [
                'S3Output' => [ // REQUIRED
                    'LocalPath' => '<string>', // REQUIRED
                    'S3UploadMode' => 'Continuous|EndOfJob',
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'NetworkConfig' => [
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableNetworkIsolation' => true || false,
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [
        'MaxRuntimeInSeconds' => <integer>, // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'JobDefinitionArn' => '<string>',
]

Result Details

Errors

ResourceLimitExceeded:

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

ResourceInUse:

Resource being accessed is in use.

CreateModelCard

$result = $client->createModelCard([/* ... */]);
$promise = $client->createModelCardAsync([/* ... */]);

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

Parameter Syntax

$result = $client->createModelCard([
    'Content' => '<string>', // REQUIRED
    'ModelCardName' => '<string>', // REQUIRED
    'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived', // REQUIRED
    'SecurityConfig' => [
        'KmsKeyId' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ModelCardArn' => '<string>',
]

Result Details