Amazon SageMaker Service 2017-07-24

AddTags

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

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([/* ... */]);

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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateAlgorithm

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

Parameter Syntax

$result = $client->createAlgorithm([
    'AlgorithmDescription' => '<string>',
    'AlgorithmName' => '<string>', // REQUIRED
    'CertifyForMarketplace' => true || false,
    'InferenceSpecification' => [
        'Containers' => [ // REQUIRED
            [
                'ContainerHostname' => '<string>',
                'Image' => '<string>', // REQUIRED
                'ImageDigest' => '<string>',
                'ModelDataUrl' => '<string>',
                'ProductId' => '<string>',
            ],
            // ...
        ],
        'SupportedContentTypes' => ['<string>', ...], // REQUIRED
        'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...], // REQUIRED
        'SupportedResponseMIMETypes' => ['<string>', ...], // REQUIRED
        'SupportedTransformInstanceTypes' => ['<string>', ...], // REQUIRED
    ],
    'TrainingSpecification' => [ // 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>', ...],
                                    'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                                    'S3Uri' => '<string>', // REQUIRED
                                ],
                            ],
                            'InputMode' => 'Pipe|File',
                            'RecordWrapperType' => 'None|RecordIO',
                            'ShuffleConfig' => [
                                'Seed' => <integer>, // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'OutputDataConfig' => [ // REQUIRED
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>', // REQUIRED
                    ],
                    'ResourceConfig' => [ // REQUIRED
                        '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.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', // REQUIRED
                        'VolumeKmsKeyId' => '<string>',
                        'VolumeSizeInGB' => <integer>, // REQUIRED
                    ],
                    'StoppingCondition' => [ // REQUIRED
                        'MaxRuntimeInSeconds' => <integer>,
                        'MaxWaitTimeInSeconds' => <integer>,
                    ],
                    'TrainingInputMode' => 'Pipe|File', // 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', // 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([/* ... */]);

Parameter Syntax

$result = $client->createApp([
    'AppName' => '<string>', // REQUIRED
    'AppType' => 'JupyterServer|KernelGateway|TensorBoard', // 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.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.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge',
        'SageMakerImageArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceLimitExceeded:

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

• ResourceInUse:

  Resource being accessed is in use.

CreateAutoMLJob

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

Parameter Syntax

$result = $client->createAutoMLJob([
    'AutoMLJobConfig' => [
        'CompletionCriteria' => [
            'MaxAutoMLJobRuntimeInSeconds' => <integer>,
            'MaxCandidates' => <integer>,
            'MaxRuntimePerTrainingJobInSeconds' => <integer>,
        ],
        'SecurityConfig' => [
            'EnableInterContainerTrafficEncryption' => true || false,
            'VolumeKmsKeyId' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'Subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'AutoMLJobName' => '<string>', // REQUIRED
    'AutoMLJobObjective' => [
        'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC', // REQUIRED
    ],
    'GenerateCandidateDefinitionsOnly' => true || false,
    'InputDataConfig' => [ // REQUIRED
        [
            'CompressionType' => 'None|Gzip',
            'DataSource' => [ // REQUIRED
                'S3DataSource' => [ // REQUIRED
                    'S3DataType' => 'ManifestFile|S3Prefix', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            'TargetAttributeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateCodeRepository

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

CreateCompilationJob

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

Parameter Syntax

$result = $client->createCompilationJob([
    'CompilationJobName' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'DataInputConfig' => '<string>', // REQUIRED
        'Framework' => 'TENSORFLOW|KERAS|MXNET|ONNX|PYTORCH|XGBOOST|TFLITE', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [ // REQUIRED
        'CompilerOptions' => '<string>',
        'S3OutputLocation' => '<string>', // REQUIRED
        'TargetDevice' => 'lambda|ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|ml_g4dn|ml_inf1|jetson_tx1|jetson_tx2|jetson_nano|jetson_xavier|rasp3b|imx8qm|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603|sitara_am57x|amba_cv22|x86_win32|x86_win64',
        'TargetPlatform' => [
            'Accelerator' => 'INTEL_GRAPHICS|MALI|NVIDIA',
            'Arch' => 'X86_64|X86|ARM64|ARM_EABI|ARM_EABIHF', // REQUIRED
            'Os' => 'ANDROID|LINUX', // REQUIRED
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <integer>,
        'MaxWaitTimeInSeconds' => <integer>,
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceInUse:

  Resource being accessed is in use.

• ResourceLimitExceeded:

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

CreateDomain

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

Parameter Syntax

$result = $client->createDomain([
    'AuthMode' => 'SSO|IAM', // REQUIRED
    'DefaultUserSettings' => [ // REQUIRED
        'ExecutionRole' => '<string>',
        'JupyterServerAppSettings' => [
            '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.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.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge',
                'SageMakerImageArn' => '<string>',
            ],
        ],
        'KernelGatewayAppSettings' => [
            '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.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.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge',
                'SageMakerImageArn' => '<string>',
            ],
        ],
        'SecurityGroups' => ['<string>', ...],
        'SharingSettings' => [
            'NotebookOutputOption' => 'Allowed|Disabled',
            'S3KmsKeyId' => '<string>',
            'S3OutputPath' => '<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.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.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge',
                'SageMakerImageArn' => '<string>',
            ],
        ],
    ],
    'DomainName' => '<string>', // REQUIRED
    'HomeEfsFileSystemKmsKeyId' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

• ResourceInUse:

  Resource being accessed is in use.

CreateEndpoint

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

Parameter Syntax

$result = $client->createEndpoint([
    '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateEndpointConfig

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

Parameter Syntax

$result = $client->createEndpointConfig([
    'DataCaptureConfig' => [
        'CaptureContentTypeHeader' => [
            'CsvContentTypes' => ['<string>', ...],
            'JsonContentTypes' => ['<string>', ...],
        ],
        'CaptureOptions' => [ // REQUIRED
            [
                'CaptureMode' => 'Input|Output', // REQUIRED
            ],
            // ...
        ],
        'DestinationS3Uri' => '<string>', // REQUIRED
        'EnableCapture' => true || false,
        'InitialSamplingPercentage' => <integer>, // REQUIRED
        'KmsKeyId' => '<string>',
    ],
    'EndpointConfigName' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'ProductionVariants' => [ // REQUIRED
        [
            'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
            'InitialInstanceCount' => <integer>, // REQUIRED
            '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', // REQUIRED
            'ModelName' => '<string>', // REQUIRED
            'VariantName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceLimitExceeded:

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

CreateExperiment

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

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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateFlowDefinition

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

Parameter Syntax

$result = $client->createFlowDefinition([
    'FlowDefinitionName' => '<string>', // REQUIRED
    'HumanLoopActivationConfig' => [
        'HumanLoopActivationConditionsConfig' => [ // REQUIRED
            'HumanLoopActivationConditions' => '<string>', // REQUIRED
        ],
    ],
    'HumanLoopConfig' => [ // REQUIRED
        '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

• ResourceInUse:

  Resource being accessed is in use.

CreateHumanTaskUi

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

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 Amazon 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([/* ... */]);

Parameter Syntax

$result = $client->createHyperParameterTuningJob([
    'HyperParameterTuningJobConfig' => [ // REQUIRED
        'HyperParameterTuningJobObjective' => [
            'MetricName' => '<string>', // REQUIRED
            'Type' => 'Maximize|Minimize', // REQUIRED
        ],
        'ParameterRanges' => [
            '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',
                ],
                // ...
            ],
        ],
        'ResourceLimits' => [ // REQUIRED
            'MaxNumberOfTrainingJobs' => <integer>, // REQUIRED
            'MaxParallelTrainingJobs' => <integer>, // REQUIRED
        ],
        'Strategy' => 'Bayesian|Random', // REQUIRED
        'TrainingJobEarlyStoppingType' => 'Off|Auto',
        'TuningJobCompletionCriteria' => [
            'TargetObjectiveMetricValue' => <float>, // REQUIRED
        ],
    ],
    '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', // REQUIRED
        ],
        'CheckpointConfig' => [
            'LocalPath' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
        'DefinitionName' => '<string>',
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableManagedSpotTraining' => true || false,
        'EnableNetworkIsolation' => true || false,
        'HyperParameterRanges' => [
            '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',
                ],
                // ...
            ],
        ],
        '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>', ...],
                        'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                        'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                        'S3Uri' => '<string>', // REQUIRED
                    ],
                ],
                'InputMode' => 'Pipe|File',
                'RecordWrapperType' => 'None|RecordIO',
                'ShuffleConfig' => [
                    'Seed' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'OutputDataConfig' => [ // REQUIRED
            'KmsKeyId' => '<string>',
            'S3OutputPath' => '<string>', // REQUIRED
        ],
        'ResourceConfig' => [ // REQUIRED
            '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.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', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
        'RoleArn' => '<string>', // REQUIRED
        'StaticHyperParameters' => ['<string>', ...],
        'StoppingCondition' => [ // REQUIRED
            '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', // REQUIRED
            ],
            'CheckpointConfig' => [
                'LocalPath' => '<string>',
                'S3Uri' => '<string>', // REQUIRED
            ],
            'DefinitionName' => '<string>',
            'EnableInterContainerTrafficEncryption' => true || false,
            'EnableManagedSpotTraining' => true || false,
            'EnableNetworkIsolation' => true || false,
            'HyperParameterRanges' => [
                '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',
                    ],
                    // ...
                ],
            ],
            '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>', ...],
                            'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                            'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                            'S3Uri' => '<string>', // REQUIRED
                        ],
                    ],
                    'InputMode' => 'Pipe|File',
                    'RecordWrapperType' => 'None|RecordIO',
                    'ShuffleConfig' => [
                        'Seed' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            'OutputDataConfig' => [ // REQUIRED
                'KmsKeyId' => '<string>',
                'S3OutputPath' => '<string>', // REQUIRED
            ],
            'ResourceConfig' => [ // REQUIRED
                '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.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', // REQUIRED
                'VolumeKmsKeyId' => '<string>',
                'VolumeSizeInGB' => <integer>, // REQUIRED
            ],
            'RoleArn' => '<string>', // REQUIRED
            'StaticHyperParameters' => ['<string>', ...],
            'StoppingCondition' => [ // REQUIRED
                '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateLabelingJob

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

Parameter Syntax

$result = $client->createLabelingJob([
    'HumanTaskConfig' => [ // REQUIRED
        'AnnotationConsolidationConfig' => [ // REQUIRED
            'AnnotationConsolidationLambdaArn' => '<string>', // REQUIRED
        ],
        'MaxConcurrentTaskCount' => <integer>,
        'NumberOfHumanWorkersPerDataObject' => <integer>, // REQUIRED
        'PreHumanTaskLambdaArn' => '<string>', // REQUIRED
        '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>',
        ],
    ],
    '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateModel

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

Parameter Syntax

$result = $client->createModel([
    'Containers' => [
        [
            'ContainerHostname' => '<string>',
            'Environment' => ['<string>', ...],
            'Image' => '<string>',
            'ImageConfig' => [
                'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
            ],
            'Mode' => 'SingleModel|MultiModel',
            'ModelDataUrl' => '<string>',
            'ModelPackageName' => '<string>',
        ],
        // ...
    ],
    'EnableNetworkIsolation' => true || false,
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'PrimaryContainer' => [
        'ContainerHostname' => '<string>',
        'Environment' => ['<string>', ...],
        'Image' => '<string>',
        'ImageConfig' => [
            'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
        ],
        'Mode' => 'SingleModel|MultiModel',
        'ModelDataUrl' => '<string>',
        'ModelPackageName' => '<string>',
    ],
    '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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

CreateModelPackage

$result = $client->createModelPackage([/* ... */]);
$promise = $client->createModelPackageAsync([/* ... */]);

Parameter Syntax

$result = $client->createModelPackage([
    'CertifyForMarketplace' => true || false,
    'InferenceSpecification' => [
        'Containers' => [ // REQUIRED
            [
                'ContainerHostname' => '<string>',
                'Image' => '<string>', // REQUIRED
                'ImageDigest' => '<string>',
                'ModelDataUrl' => '<string>',
                'ProductId' => '<string>',
            ],
            // ...
        ],
        'SupportedContentTypes' => ['<string>', ...], // REQUIRED
        'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...], // REQUIRED
        'SupportedResponseMIMETypes' => ['<string>', ...], // REQUIRED
        'SupportedTransformInstanceTypes' => ['<string>', ...], // REQUIRED
    ],
    'ModelPackageDescription' => '<string>',
    'ModelPackageName' => '<string>', // REQUIRED
    'SourceAlgorithmSpecification' => [
        'SourceAlgorithms' => [ // REQUIRED
            [
                'AlgorithmName' => '<string>', // REQUIRED
                'ModelDataUrl' => '<string>',
            ],
            // ...
        ],
    ],
    'ValidationSpecification' => [
        'ValidationProfiles' => [ // REQUIRED
            [
                'ProfileName' => '<string>', // REQUIRED
                'TransformJobDefinition' => [ // REQUIRED
                    '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', // REQUIRED
                        'VolumeKmsKeyId' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ValidationRole' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

CreateMonitoringSchedule

$result = $client->createMonitoringSchedule([/* ... */]);
$promise = $client->createMonitoringScheduleAsync([/* ... */]);

Parameter Syntax

$result = $client->createMonitoringSchedule([
    'MonitoringScheduleConfig' => [ // REQUIRED
        'MonitoringJobDefinition' => [ // REQUIRED
            'BaselineConfig' => [
                'ConstraintsResource' => [
                    'S3Uri' => '<string>',
                ],
                'StatisticsResource' => [
                    'S3Uri' => '<string>',
                ],
            ],
            'Environment' => ['<string>', ...],
            'MonitoringAppSpecification' => [ // REQUIRED
                'ContainerArguments' => ['<string>', ...],
                'ContainerEntrypoint' => ['<string>', ...],
                'ImageUri' => '<string>', // REQUIRED
                'PostAnalyticsProcessorSourceUri' => '<string>',
                'RecordPreprocessorSourceUri' => '<string>',
            ],
            'MonitoringInputs' => [ // REQUIRED
                [
                    'EndpointInput' => [ // REQUIRED
                        'EndpointName' => '<string>', // REQUIRED
                        'LocalPath' => '<string>', // REQUIRED
                        'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                        'S3InputMode' => 'Pipe|File',
                    ],
                ],
                // ...
            ],
            'MonitoringOutputConfig' => [ // REQUIRED
                'KmsKeyId' => '<string>',
                'MonitoringOutputs' => [ // REQUIRED
                    [
                        'S3Output' => [ // REQUIRED
                            'LocalPath' => '<string>', // REQUIRED
                            'S3UploadMode' => 'Continuous|EndOfJob',
                            'S3Uri' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
            ],
            'MonitoringResources' => [ // 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', // 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
            ],
        ],
        'ScheduleConfig' => [
            'ScheduleExpression' => '<string>', // REQUIRED
        ],
    ],
    'MonitoringScheduleName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceLimitExceeded:

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

• ResourceInUse:

  Resource being accessed is in use.

CreateNotebookInstance

$result = $client->createNotebookInstance([/* ... */]);
$promise = $client->createNotebookInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->createNotebookInstance([
    'AcceleratorTypes' => ['<string>', ...],
    'AdditionalCodeRepositories' => ['<string>', ...],
    'DefaultCodeRepository' => '<string>',
    'DirectInternetAccess' => 'Enabled|Disabled',
    '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.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', // REQUIRED
    'KmsKeyId' => '<string>',
    'LifecycleConfigName' => '<string>',
    'NotebookInstanceName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'RootAccess' => 'Enabled|Disabled',
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeSizeInGB' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceLimitExceeded:

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

CreateNotebookInstanceLifecycleConfig

$result = $client->createNotebookInstanceLifecycleConfig([/* ... */]);
$promise = $client->createNotebookInstanceLifecycleConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->createNotebookInstanceLifecycleConfig([
    'NotebookInstanceLifecycleConfigName' => '<string>', // REQUIRED
    'OnCreate' => [
        [
            'Content' => '<string>',
        ],
        // ...
    ],
    'OnStart' => [
        [
            'Content' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceLimitExceeded:

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

CreatePresignedDomainUrl

$result = $client->createPresignedDomainUrl([/* ... */]);
$promise = $client->createPresignedDomainUrlAsync([/* ... */]);

Parameter Syntax

$result = $client->createPresignedDomainUrl([
    'DomainId' => '<string>', // REQUIRED
    'SessionExpirationDurationInSeconds' => <integer>,
    'UserProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

CreatePresignedNotebookInstanceUrl

$result = $client->createPresignedNotebookInstanceUrl([/* ... */]);
$promise = $client->createPresignedNotebookInstanceUrlAsync([/* ... */]);

Parameter Syntax

$result = $client->createPresignedNotebookInstanceUrl([
    'NotebookInstanceName' => '<string>', // REQUIRED
    'SessionExpirationDurationInSeconds' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

CreateProcessingJob

$result = $client->createProcessingJob([/* ... */]);
$promise = $client->createProcessingJobAsync([/* ... */]);

Parameter Syntax

$result = $client->createProcessingJob([
    'AppSpecification' => [ // REQUIRED
        'ContainerArguments' => ['<string>', ...],
        'ContainerEntrypoint' => ['<string>', ...],
        'ImageUri' => '<string>', // REQUIRED
    ],
    'Environment' => ['<string>', ...],
    'ExperimentConfig' => [
        'ExperimentName' => '<string>',
        'TrialComponentDisplayName' => '<string>',
        'TrialName' => '<string>',
    ],
    'NetworkConfig' => [
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableNetworkIsolation' => true || false,
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'ProcessingInputs' => [
        [
            'InputName' => '<string>', // REQUIRED
            'S3Input' => [ // REQUIRED
                'LocalPath' => '<string>', // REQUIRED
                'S3CompressionType' => 'None|Gzip',
                'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                'S3DataType' => 'ManifestFile|S3Prefix', // REQUIRED
                'S3InputMode' => 'Pipe|File', // REQUIRED
                'S3Uri' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'ProcessingJobName' => '<string>', // REQUIRED
    'ProcessingOutputConfig' => [
        'KmsKeyId' => '<string>',
        'Outputs' => [ // REQUIRED
            [
                'OutputName' => '<string>', // REQUIRED
                'S3Output' => [ // REQUIRED
                    'LocalPath' => '<string>', // REQUIRED
                    'S3UploadMode' => 'Continuous|EndOfJob', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'ProcessingResources' => [ // 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', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [
        'MaxRuntimeInSeconds' => <integer>, // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceInUse:

  Resource being accessed is in use.

• ResourceLimitExceeded:

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

• ResourceNotFound:

  Resource being access is not found.

CreateTrainingJob

$result = $client->createTrainingJob([/* ... */]);
$promise = $client->createTrainingJobAsync([/* ... */]);

Parameter Syntax

$result = $client->createTrainingJob([
    'AlgorithmSpecification' => [ // REQUIRED
        'AlgorithmName' => '<string>',
        'EnableSageMakerMetricsTimeSeries' => true || false,
        'MetricDefinitions' => [
            [
                'Name' => '<string>', // REQUIRED
                'Regex' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TrainingImage' => '<string>',
        'TrainingInputMode' => 'Pipe|File', // REQUIRED
    ],
    'CheckpointConfig' => [
        'LocalPath' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'DebugHookConfig' => [
        'CollectionConfigurations' => [
            [
                'CollectionName' => '<string>',
                'CollectionParameters' => ['<string>', ...],
            ],
            // ...
        ],
        'HookParameters' => ['<string>', ...],
        'LocalPath' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'DebugRuleConfigurations' => [
        [
            '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',
            'LocalPath' => '<string>',
            'RuleConfigurationName' => '<string>', // REQUIRED
            'RuleEvaluatorImage' => '<string>', // REQUIRED
            'RuleParameters' => ['<string>', ...],
            'S3OutputPath' => '<string>',
            'VolumeSizeInGB' => <integer>,
        ],
        // ...
    ],
    'EnableInterContainerTrafficEncryption' => true || false,
    'EnableManagedSpotTraining' => true || false,
    'EnableNetworkIsolation' => true || false,
    'ExperimentConfig' => [
        'ExperimentName' => '<string>',
        'TrialComponentDisplayName' => '<string>',
        'TrialName' => '<string>',
    ],
    'HyperParameters' => ['<string>', ...],
    '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>', ...],
                    'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                    'S3Uri' => '<string>', // REQUIRED
                ],
            ],
            'InputMode' => 'Pipe|File',
            'RecordWrapperType' => 'None|RecordIO',
            'ShuffleConfig' => [
                'Seed' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'ResourceConfig' => [ // REQUIRED
        '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.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', // REQUIRED
        'VolumeKmsKeyId' => '<string>',
        'VolumeSizeInGB' => <integer>, // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <integer>,
        'MaxWaitTimeInSeconds' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TensorBoardOutputConfig' => [
        'LocalPath' => '<string>',
        'S3OutputPath' => '<string>', // REQUIRED
    ],
    'TrainingJobName' => '<string>', // REQUIRED
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceInUse:

  Resource being accessed is in use.

• ResourceLimitExceeded:

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

• ResourceNotFound:

  Resource being access is not found.

CreateTransformJob

$result = $client->createTransformJob([/* ... */]);
$promise = $client->createTransformJobAsync([/* ... */]);

Parameter Syntax

$result = $client->createTransformJob([
    'BatchStrategy' => 'MultiRecord|SingleRecord',
    'DataProcessing' => [
        'InputFilter' => '<string>',
        'JoinSource' => 'Input|None',
        'OutputFilter' => '<string>',
    ],
    'Environment' => ['<string>', ...],
    'ExperimentConfig' => [
        'ExperimentName' => '<string>',
        'TrialComponentDisplayName' => '<string>',
        'TrialName' => '<string>',
    ],
    'MaxConcurrentTransforms' => <integer>,
    'MaxPayloadInMB' => <integer>,
    'ModelClientConfig' => [
        'InvocationsMaxRetries' => <integer>,
        'InvocationsTimeoutInSeconds' => <integer>,
    ],
    'ModelName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TransformInput' => [ // REQUIRED
        'CompressionType' => 'None|Gzip',
        'ContentType' => '<string>',
        'DataSource' => [ // REQUIRED
            'S3DataSource' => [ // REQUIRED
                'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
                'S3Uri' => '<string>', // REQUIRED
            ],
        ],
        'SplitType' => 'None|Line|RecordIO|TFRecord',
    ],
    'TransformJobName' => '<string>', // REQUIRED
    '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', // REQUIRED
        'VolumeKmsKeyId' => '<string>',
    ],
]);

Parameter Details

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