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.

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
                                'S3DataSource' => [ // REQUIRED
                                    '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.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.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge', // REQUIRED
                        'VolumeKmsKeyId' => '<string>',
                        'VolumeSizeInGB' => <integer>, // REQUIRED
                    ],
                    'StoppingCondition' => [ // REQUIRED
                        'MaxRuntimeInSeconds' => <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',
                    ],
                    '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.

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|MXNET|ONNX|PYTORCH|XGBOOST', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [ // REQUIRED
        'S3OutputLocation' => '<string>', // REQUIRED
        'TargetDevice' => 'ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|jetson_tx1|jetson_tx2|rasp3b|deeplens', // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <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.

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([
    'EndpointConfigName' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'ProductionVariants' => [ // REQUIRED
        [
            'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.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.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', // 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.

CreateHyperParameterTuningJob

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

Parameter Syntax

$result = $client->createHyperParameterTuningJob([
    'HyperParameterTuningJobConfig' => [ // REQUIRED
        'HyperParameterTuningJobObjective' => [ // REQUIRED
            'MetricName' => '<string>', // REQUIRED
            'Type' => 'Maximize|Minimize', // REQUIRED
        ],
        'ParameterRanges' => [ // REQUIRED
            'CategoricalParameterRanges' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ContinuousParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'IntegerParameterRanges' => [
                [
                    'MaxValue' => '<string>', // REQUIRED
                    'MinValue' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'ResourceLimits' => [ // REQUIRED
            'MaxNumberOfTrainingJobs' => <integer>, // REQUIRED
            'MaxParallelTrainingJobs' => <integer>, // REQUIRED
        ],
        'Strategy' => 'Bayesian', // REQUIRED
        'TrainingJobEarlyStoppingType' => 'Off|Auto',
    ],
    'HyperParameterTuningJobName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrainingJobDefinition' => [ // REQUIRED
        'AlgorithmSpecification' => [ // REQUIRED
            'AlgorithmName' => '<string>',
            'MetricDefinitions' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Regex' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TrainingImage' => '<string>',
            'TrainingInputMode' => 'Pipe|File', // REQUIRED
        ],
        'EnableNetworkIsolation' => true || false,
        'InputDataConfig' => [
            [
                'ChannelName' => '<string>', // REQUIRED
                'CompressionType' => 'None|Gzip',
                'ContentType' => '<string>',
                'DataSource' => [ // REQUIRED
                    'S3DataSource' => [ // REQUIRED
                        '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.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.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
        'RoleArn' => '<string>', // REQUIRED
        'StaticHyperParameters' => ['<string>', ...],
        'StoppingCondition' => [ // REQUIRED
            'MaxRuntimeInSeconds' => <integer>,
        ],
        '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
            'UiTemplateS3Uri' => '<string>', // REQUIRED
        ],
        'WorkteamArn' => '<string>', // REQUIRED
    ],
    'InputConfig' => [ // REQUIRED
        'DataAttributes' => [
            'ContentClassifiers' => ['<string>', ...],
        ],
        'DataSource' => [ // REQUIRED
            'S3DataSource' => [ // REQUIRED
                'ManifestS3Uri' => '<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
    ],
    '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>',
            'ModelDataUrl' => '<string>',
            'ModelPackageName' => '<string>',
        ],
        // ...
    ],
    'EnableNetworkIsolation' => true || false,
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'PrimaryContainer' => [
        'ContainerHostname' => '<string>',
        'Environment' => ['<string>', ...],
        'Image' => '<string>',
        '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',
                    ],
                    '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.

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
    '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.

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.

CreateTrainingJob

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

Parameter Syntax

$result = $client->createTrainingJob([
    'AlgorithmSpecification' => [ // REQUIRED
        'AlgorithmName' => '<string>',
        'MetricDefinitions' => [
            [
                'Name' => '<string>', // REQUIRED
                'Regex' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TrainingImage' => '<string>',
        'TrainingInputMode' => 'Pipe|File', // REQUIRED
    ],
    'EnableNetworkIsolation' => true || false,
    'HyperParameters' => ['<string>', ...],
    'InputDataConfig' => [
        [
            'ChannelName' => '<string>', // REQUIRED
            'CompressionType' => 'None|Gzip',
            'ContentType' => '<string>',
            'DataSource' => [ // REQUIRED
                'S3DataSource' => [ // REQUIRED
                    '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.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.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge', // REQUIRED
        'VolumeKmsKeyId' => '<string>',
        'VolumeSizeInGB' => <integer>, // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<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.

CreateTransformJob

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

Parameter Syntax

$result = $client->createTransformJob([
    'BatchStrategy' => 'MultiRecord|SingleRecord',
    'Environment' => ['<string>', ...],
    'MaxConcurrentTransforms' => <integer>,
    'MaxPayloadInMB' => <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',
    ],
    '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

Result Syntax

[
    'TransformJobArn' => '<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.

CreateWorkteam

$result = $client->createWorkteam([/* ... */]);
$promise = $client->createWorkteamAsync([/* ... */]);

Parameter Syntax

$result = $client->createWorkteam([
    'Description' => '<string>', // REQUIRED
    'MemberDefinitions' => [ // REQUIRED
        [
            'CognitoMemberDefinition' => [
                'ClientId' => '<string>', // REQUIRED
                'UserGroup' => '<string>', // REQUIRED
                'UserPool' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WorkteamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'WorkteamArn' => '<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.

DeleteAlgorithm

$result = $client->deleteAlgorithm([/* ... */]);
$promise = $client->deleteAlgorithmAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteAlgorithm([
    'AlgorithmName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteCodeRepository

$result = $client->deleteCodeRepository([/* ... */]);
$promise = $client->deleteCodeRepositoryAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteCodeRepository([
    'CodeRepositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteEndpoint

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteEndpoint([
    'EndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteEndpointConfig

$result = $client->deleteEndpointConfig([/* ... */]);
$promise = $client->deleteEndpointConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteEndpointConfig([
    'EndpointConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteModel

$result = $client->deleteModel([/* ... */]);
$promise = $client->deleteModelAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteModel([
    'ModelName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteModelPackage

$result = $client->deleteModelPackage([/* ... */]);
$promise = $client->deleteModelPackageAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteModelPackage([
    'ModelPackageName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteNotebookInstance

$result = $client->deleteNotebookInstance([/* ... */]);
$promise = $client->deleteNotebookInstanceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteNotebookInstanceLifecycleConfig

$result = $client->deleteNotebookInstanceLifecycleConfig([/* ... */]);
$promise = $client->deleteNotebookInstanceLifecycleConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteNotebookInstanceLifecycleConfig([
    'NotebookInstanceLifecycleConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteTags

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTags([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteWorkteam

$result = $client->deleteWorkteam([/* ... */]);
$promise = $client->deleteWorkteamAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteWorkteam([
    'WorkteamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Success' => true || false,
]

Result Details

Errors

• ResourceLimitExceeded:

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

DescribeAlgorithm

$result = $client->describeAlgorithm([/* ... */]);
$promise = $client->describeAlgorithmAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAlgorithm([
    'AlgorithmName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AlgorithmArn' => '<string>',
    'AlgorithmDescription' => '<string>',
    'AlgorithmName' => '<string>',
    'AlgorithmStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
    'AlgorithmStatusDetails' => [
        'ImageScanStatuses' => [
            [
                'FailureReason' => '<string>',
                'Name' => '<string>',
                'Status' => 'NotStarted|InProgress|Completed|Failed',
            ],
            // ...
        ],
        'ValidationStatuses' => [
            [
                'FailureReason' => '<string>',
                'Name' => '<string>',
                'Status' => 'NotStarted|InProgress|Completed|Failed',
            ],
            // ...
        ],
    ],
    'CertifyForMarketplace' => true || false,
    'CreationTime' => <DateTime>,
    'InferenceSpecification' => [
        'Containers' => [
            [
                'ContainerHostname' => '<string>',
                'Image' => '<string>',
                'ImageDigest' => '<string>',
                'ModelDataUrl' => '<string>',
                'ProductId' => '<string>',
            ],
            // ...
        ],
        'SupportedContentTypes' => ['<string>', ...],
        'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...],
        'SupportedResponseMIMETypes' => ['<string>', ...],
        'SupportedTransformInstanceTypes' => ['<string>', ...],
    ],
    'ProductId' => '<string>',
    'TrainingSpecification' => [
        'MetricDefinitions' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
        'SupportedHyperParameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'IsRequired' => true || false,
                'IsTunable' => true || false,
                'Name' => '<string>',
                'Range' => [
                    'CategoricalParameterRangeSpecification' => [
                        'Values' => ['<string>', ...],
                    ],
                    'ContinuousParameterRangeSpecification' => [
                        'MaxValue' => '<string>',
                        'MinValue' => '<string>',
                    ],
                    'IntegerParameterRangeSpecification' => [
                        'MaxValue' => '<string>',
                        'MinValue' => '<string>',
                    ],
                ],
                'Type' => 'Integer|Continuous|Categorical|FreeText',
            ],
            // ...
        ],
        'SupportedTrainingInstanceTypes' => ['<string>', ...],
        'SupportedTuningJobObjectiveMetrics' => [
            [
                'MetricName' => '<string>',
                'Type' => 'Maximize|Minimize',
            ],
            // ...
        ],
        'SupportsDistributedTraining' => true || false,
        'TrainingChannels' => [
            [
                'Description' => '<string>',
                'IsRequired' => true || false,
                'Name' => '<string>',
                'SupportedCompressionTypes' => ['<string>', ...],
                'SupportedContentTypes' => ['<string>', ...],
                'SupportedInputModes' => ['<string>', ...],
            ],
            // ...
        ],
        'TrainingImage' => '<string>',
        'TrainingImageDigest' => '<string>',
    ],
    'ValidationSpecification' => [
        'ValidationProfiles' => [
            [
                'ProfileName' => '<string>',
                'TrainingJobDefinition' => [
                    'HyperParameters' => ['<string>', ...],
                    'InputDataConfig' => [
                        [
                            'ChannelName' => '<string>',
                            'CompressionType' => 'None|Gzip',
                            'ContentType' => '<string>',
                            'DataSource' => [
                                'S3DataSource' => [
                                    'AttributeNames' => ['<string>', ...],
                                    'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                                    'S3Uri' => '<string>',
                                ],
                            ],
                            'InputMode' => 'Pipe|File',
                            'RecordWrapperType' => 'None|RecordIO',
                            'ShuffleConfig' => [
                                'Seed' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    'OutputDataConfig' => [
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>',
                    ],
                    'ResourceConfig' => [
                        'InstanceCount' => <integer>,
                        'InstanceType' => '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.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',
                        'VolumeKmsKeyId' => '<string>',
                        'VolumeSizeInGB' => <integer>,
                    ],
                    'StoppingCondition' => [
                        'MaxRuntimeInSeconds' => <integer>,
                    ],
                    'TrainingInputMode' => 'Pipe|File',
                ],
                'TransformJobDefinition' => [
                    'BatchStrategy' => 'MultiRecord|SingleRecord',
                    'Environment' => ['<string>', ...],
                    'MaxConcurrentTransforms' => <integer>,
                    'MaxPayloadInMB' => <integer>,
                    'TransformInput' => [
                        'CompressionType' => 'None|Gzip',
                        'ContentType' => '<string>',
                        'DataSource' => [
                            'S3DataSource' => [
                                'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                                'S3Uri' => '<string>',
                            ],
                        ],
                        'SplitType' => 'None|Line|RecordIO',
                    ],
                    'TransformOutput' => [
                        'Accept' => '<string>',
                        'AssembleWith' => 'None|Line',
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>',
                    ],
                    'TransformResources' => [
                        'InstanceCount' => <integer>,
                        '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',
                        'VolumeKmsKeyId' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ValidationRole' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeCodeRepository

$result = $client->describeCodeRepository([/* ... */]);
$promise = $client->describeCodeRepositoryAsync([/* ... */]);

Parameter Syntax

$result = $client->describeCodeRepository([
    'CodeRepositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CodeRepositoryArn' => '<string>',
    'CodeRepositoryName' => '<string>',
    'CreationTime' => <DateTime>,
    'GitConfig' => [
        'Branch' => '<string>',
        'RepositoryUrl' => '<string>',
        'SecretArn' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

DescribeCompilationJob

$result = $client->describeCompilationJob([/* ... */]);
$promise = $client->describeCompilationJobAsync([/* ... */]);

Parameter Syntax

$result = $client->describeCompilationJob([
    'CompilationJobName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompilationEndTime' => <DateTime>,
    'CompilationJobArn' => '<string>',
    'CompilationJobName' => '<string>',
    'CompilationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
    'CompilationStartTime' => <DateTime>,
    'CreationTime' => <DateTime>,
    'FailureReason' => '<string>',
    'InputConfig' => [
        'DataInputConfig' => '<string>',
        'Framework' => 'TENSORFLOW|MXNET|ONNX|PYTORCH|XGBOOST',
        'S3Uri' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'ModelArtifacts' => [
        'S3ModelArtifacts' => '<string>',
    ],
    'OutputConfig' => [
        'S3OutputLocation' => '<string>',
        'TargetDevice' => 'ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|jetson_tx1|jetson_tx2|rasp3b|deeplens',
    ],
    'RoleArn' => '<string>',
    'StoppingCondition' => [
        'MaxRuntimeInSeconds' => <integer>,
    ],
]

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

DescribeEndpoint

$result = $client->describeEndpoint([/* ... */]);
$promise = $client->describeEndpointAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEndpoint([
    'EndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EndpointArn' => '<string>',
    'EndpointConfigName' => '<string>',
    'EndpointName' => '<string>',
    'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed',
    'FailureReason' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'ProductionVariants' => [
        [
            'CurrentInstanceCount' => <integer>,
            'CurrentWeight' => <float>,
            'DeployedImages' => [
                [
                    'ResolutionTime' => <DateTime>,
                    'ResolvedImage' => '<string>',
                    'SpecifiedImage' => '<string>',
                ],
                // ...
            ],
            'DesiredInstanceCount' => <integer>,
            'DesiredWeight' => <float>,
            'VariantName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeEndpointConfig

$result = $client->describeEndpointConfig([/* ... */]);
$promise = $client->describeEndpointConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEndpointConfig([
    'EndpointConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EndpointConfigArn' => '<string>',
    'EndpointConfigName' => '<string>',
    'KmsKeyId' => '<string>',
    'ProductionVariants' => [
        [
            'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge',
            '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.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',
            'ModelName' => '<string>',
            'VariantName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeHyperParameterTuningJob

$result = $client->describeHyperParameterTuningJob([/* ... */]);
$promise = $client->describeHyperParameterTuningJobAsync([/* ... */]);

Parameter Syntax

$result = $client->describeHyperParameterTuningJob([
    'HyperParameterTuningJobName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BestTrainingJob' => [
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'FinalHyperParameterTuningJobObjectiveMetric' => [
            'MetricName' => '<string>',
            'Type' => 'Maximize|Minimize',
            'Value' => <float>,
        ],
        'ObjectiveStatus' => 'Succeeded|Pending|Failed',
        'TrainingEndTime' => <DateTime>,
        'TrainingJobArn' => '<string>',
        'TrainingJobName' => '<string>',
        'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
        'TrainingStartTime' => <DateTime>,
        'TunedHyperParameters' => ['<string>', ...],
        'TuningJobName' => '<string>',
    ],
    'CreationTime' => <DateTime>,
    'FailureReason' => '<string>',
    'HyperParameterTuningEndTime' => <DateTime>,
    'HyperParameterTuningJobArn' => '<string>',
    'HyperParameterTuningJobConfig' => [
        'HyperParameterTuningJobObjective' => [
            'MetricName' => '<string>',
            'Type' => 'Maximize|Minimize',
        ],
        'ParameterRanges' => [
            'CategoricalParameterRanges' => [
                [
                    'Name' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'ContinuousParameterRanges' => [
                [
                    'MaxValue' => '<string>',
                    'MinValue' => '<string>',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'IntegerParameterRanges' => [
                [
                    'MaxValue' => '<string>',
                    'MinValue' => '<string>',
                    'Name' => '<string>',
                ],
                // ...
            ],
        ],
        'ResourceLimits' => [
            'MaxNumberOfTrainingJobs' => <integer>,
            'MaxParallelTrainingJobs' => <integer>,
        ],
        'Strategy' => 'Bayesian',
        'TrainingJobEarlyStoppingType' => 'Off|Auto',
    ],
    'HyperParameterTuningJobName' => '<string>',
    'HyperParameterTuningJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
    'LastModifiedTime' => <DateTime>,
    'ObjectiveStatusCounters' => [
        'Failed' => <integer>,
        'Pending' => <integer>,
        'Succeeded' => <integer>,
    ],
    'OverallBestTrainingJob' => [
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'FinalHyperParameterTuningJobObjectiveMetric' => [
            'MetricName' => '<string>',
            'Type' => 'Maximize|Minimize',
            'Value' => <float>,
        ],
        'ObjectiveStatus' => 'Succeeded|Pending|Failed',
        'TrainingEndTime' => <DateTime>,
        'TrainingJobArn' => '<string>',
        'TrainingJobName' => '<string>',
        'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
        'TrainingStartTime' => <DateTime>,
        'TunedHyperParameters' => ['<string>', ...],
        'TuningJobName' => '<string>',
    ],
    'TrainingJobDefinition' => [
        'AlgorithmSpecification' => [
            'AlgorithmName' => '<string>',
            'MetricDefinitions' => [
                [
                    'Name' => '<string>',
                    'Regex' => '<string>',
                ],
                // ...
            ],
            'TrainingImage' => '<string>',
            'TrainingInputMode' => 'Pipe|File',
        ],
        'EnableNetworkIsolation' => true || false,
        'InputDataConfig' => [
            [
                'ChannelName' => '<string>',
                'CompressionType' => 'None|Gzip',
                'ContentType' => '<string>',
                'DataSource' => [
                    'S3DataSource' => [
                        'AttributeNames' => ['<string>', ...],
                        'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                        'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                        'S3Uri' => '<string>',
                    ],
                ],
                'InputMode' => 'Pipe|File',
                'RecordWrapperType' => 'None|RecordIO',
                'ShuffleConfig' => [
                    'Seed' => <integer>,
                ],
            ],
            // ...
        ],
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3OutputPath' => '<string>',
        ],
        'ResourceConfig' => [
            'InstanceCount' => <integer>,
            'InstanceType' => '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.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',
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>,
        ],
        'RoleArn' => '<string>',
        'StaticHyperParameters' => ['<string>', ...],
        'StoppingCondition' => [
            'MaxRuntimeInSeconds' => <integer>,
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'Subnets' => ['<string>', ...],
        ],
    ],
    'TrainingJobStatusCounters' => [
        'Completed' => <integer>,
        'InProgress' => <integer>,
        'NonRetryableError' => <integer>,
        'RetryableError' => <integer>,
        'Stopped' => <integer>,
    ],
    'WarmStartConfig' => [
        'ParentHyperParameterTuningJobs' => [
            [
                'HyperParameterTuningJobName' => '<string>',
            ],
            // ...
        ],
        'WarmStartType' => 'IdenticalDataAndAlgorithm|TransferLearning',
    ],
]

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

DescribeLabelingJob

$result = $client->describeLabelingJob([/* ... */]);
$promise = $client->describeLabelingJobAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLabelingJob([
    'LabelingJobName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'FailureReason' => '<string>',
    'HumanTaskConfig' => [
        'AnnotationConsolidationConfig' => [
            'AnnotationConsolidationLambdaArn' => '<string>',
        ],
        'MaxConcurrentTaskCount' => <integer>,
        'NumberOfHumanWorkersPerDataObject' => <integer>,
        'PreHumanTaskLambdaArn' => '<string>',
        'PublicWorkforceTaskPrice' => [
            'AmountInUsd' => [
                'Cents' => <integer>,
                'Dollars' => <integer>,
                'TenthFractionsOfACent' => <integer>,
            ],
        ],
        'TaskAvailabilityLifetimeInSeconds' => <integer>,
        'TaskDescription' => '<string>',
        'TaskKeywords' => ['<string>', ...],
        'TaskTimeLimitInSeconds' => <integer>,
        'TaskTitle' => '<string>',
        'UiConfig' => [
            'UiTemplateS3Uri' => '<string>',
        ],
        'WorkteamArn' => '<string>',
    ],
    'InputConfig' => [
        'DataAttributes' => [
            'ContentClassifiers' => ['<string>', ...],
        ],
        'DataSource' => [
            'S3DataSource' => [
                'ManifestS3Uri' => '<string>',
            ],
        ],
    ],
    'JobReferenceCode' => '<string>',
    'LabelAttributeName' => '<string>',
    'LabelCategoryConfigS3Uri' => '<string>',
    'LabelCounters' => [
        'FailedNonRetryableError' => <integer>,
        'HumanLabeled' => <integer>,
        'MachineLabeled' => <integer>,
        'TotalLabeled' => <integer>,
        'Unlabeled' => <integer>,
    ],
    'LabelingJobAlgorithmsConfig' => [
        'InitialActiveLearningModelArn' => '<string>',
        'LabelingJobAlgorithmSpecificationArn' => '<string>',
        'LabelingJobResourceConfig' => [
            'VolumeKmsKeyId' => '<string>',
        ],
    ],
    'LabelingJobArn' => '<string>',
    'LabelingJobName' => '<string>',
    'LabelingJobOutput' => [
        'FinalActiveLearningModelArn' => '<string>',
        'OutputDatasetS3Uri' => '<string>',
    ],
    'LabelingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
    'LastModifiedTime' => <DateTime>,
    'OutputConfig' => [
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>',
    ],
    'RoleArn' => '<string>',
    'StoppingConditions' => [
        'MaxHumanLabeledObjectCount' => <integer>,
        'MaxPercentageOfInputDatasetLabeled' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

DescribeModel

$result = $client->describeModel([/* ... */]);
$promise = $client->describeModelAsync([/* ... */]);

Parameter Syntax

$result = $client->describeModel([
    'ModelName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Containers' => [
        [
            'ContainerHostname' => '<string>',
            'Environment' => ['<string>', ...],
            'Image' => '<string>',
            'ModelDataUrl' => '<string>',
            'ModelPackageName' => '<string>',
        ],
        // ...
    ],
    'CreationTime' => <DateTime>,
    'EnableNetworkIsolation' => true || false,
    'ExecutionRoleArn' => '<string>',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'PrimaryContainer' => [
        'ContainerHostname' => '<string>',
        'Environment' => ['<string>', ...],
        'Image' => '<string>',
        'ModelDataUrl' => '<string>',
        'ModelPackageName' => '<string>',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'Subnets' => ['<string>', ...],
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeModelPackage

$result = $client->describeModelPackage([/* ... */]);
$promise = $client->describeModelPackageAsync([/* ... */]);

Parameter Syntax

$result = $client->describeModelPackage([
    'ModelPackageName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CertifyForMarketplace' => true || false,
    'CreationTime' => <DateTime>,
    'InferenceSpecification' => [
        'Containers' => [
            [
                'ContainerHostname' => '<string>',
                'Image' => '<string>',
                'ImageDigest' => '<string>',
                'ModelDataUrl' => '<string>',
                'ProductId' => '<string>',
            ],
            // ...
        ],
        'SupportedContentTypes' => ['<string>', ...],
        'SupportedRealtimeInferenceInstanceTypes' => ['<string>', ...],
        'SupportedResponseMIMETypes' => ['<string>', ...],
        'SupportedTransformInstanceTypes' => ['<string>', ...],
    ],
    'ModelPackageArn' => '<string>',
    'ModelPackageDescription' => '<string>',
    'ModelPackageName' => '<string>',
    'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
    'ModelPackageStatusDetails' => [
        'ImageScanStatuses' => [
            [
                'FailureReason' => '<string>',
                'Name' => '<string>',
                'Status' => 'NotStarted|InProgress|Completed|Failed',
            ],
            // ...
        ],
        'ValidationStatuses' => [
            [
                'FailureReason' => '<string>',
                'Name' => '<string>',
                'Status' => 'NotStarted|InProgress|Completed|Failed',
            ],
            // ...
        ],
    ],
    'SourceAlgorithmSpecification' => [
        'SourceAlgorithms' => [
            [
                'AlgorithmName' => '<string>',
                'ModelDataUrl' => '<string>',
            ],
            // ...
        ],
    ],
    'ValidationSpecification' => [
        'ValidationProfiles' => [
            [
                'ProfileName' => '<string>',
                'TransformJobDefinition' => [
                    'BatchStrategy' => 'MultiRecord|SingleRecord',
                    'Environment' => ['<string>', ...],
                    'MaxConcurrentTransforms' => <integer>,
                    'MaxPayloadInMB' => <integer>,
                    'TransformInput' => [
                        'CompressionType' => 'None|Gzip',
                        'ContentType' => '<string>',
                        'DataSource' => [
                            'S3DataSource' => [
                                'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                                'S3Uri' => '<string>',
                            ],
                        ],
                        'SplitType' => 'None|Line|RecordIO',
                    ],
                    'TransformOutput' => [
                        'Accept' => '<string>',
                        'AssembleWith' => 'None|Line',
                        'KmsKeyId' => '<string>',
                        'S3OutputPath' => '<string>',
                    ],
                    'TransformResources' => [
                        'InstanceCount' => <integer>,
                        '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',
                        'VolumeKmsKeyId' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ValidationRole' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeNotebookInstance

$result = $client->describeNotebookInstance([/* ... */]);
$promise = $client->describeNotebookInstanceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AcceleratorTypes' => ['<string>', ...],
    'AdditionalCodeRepositories' => ['<string>', ...],
    'CreationTime' => <DateTime>,
    'DefaultCodeRepository' => '<string>',
    'DirectInternetAccess' => 'Enabled|Disabled',
    'FailureReason' => '<string>',
    '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',
    'KmsKeyId' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'NetworkInterfaceId' => '<string>',
    'NotebookInstanceArn' => '<string>',
    'NotebookInstanceLifecycleConfigName' => '<string>',
    'NotebookInstanceName' => '<string>',
    'NotebookInstanceStatus' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating',
    'RoleArn' => '<string>',
    'SecurityGroups' => ['<string>', ...],
    'SubnetId' => '<string>',
    'Url' => '<string>',
    'VolumeSizeInGB' => <integer>,
]

Result Details

Errors

There are no errors described for this operation.

DescribeNotebookInstanceLifecycleConfig

$result = $client->describeNotebookInstanceLifecycleConfig([/* ... */]);
$promise = $client->describeNotebookInstanceLifecycleConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->describeNotebookInstanceLifecycleConfig([
    'NotebookInstanceLifecycleConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
    'NotebookInstanceLifecycleConfigArn' => '<string>',
    'NotebookInstanceLifecycleConfigName' => '<string>',
    'OnCreate' => [
        [
            'Content' => '<string>',
        ],
        // ...
    ],
    'OnStart' => [
        [
            'Content' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeSubscribedWorkteam

$result = $client->describeSubscribedWorkteam([/* ... */]);
$promise = $client->describeSubscribedWorkteamAsync([/* ... */]);

Parameter Syntax

$result = $client->describeSubscribedWorkteam([
    'WorkteamArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SubscribedWorkteam' => [
        'ListingId' => '<string>',
        'MarketplaceDescription' => '<string>',
        'MarketplaceTitle' => '<string>',
        'SellerName' => '<string>',
        'WorkteamArn' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeTrainingJob

$result = $client->describeTrainingJob([/* ... */]);
$promise = $client->describeTrainingJobAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTrainingJob([
    'TrainingJobName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AlgorithmSpecification' => [
        'AlgorithmName' => '<string>',
        'MetricDefinitions' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
        'TrainingImage' => '<string>',
        'TrainingInputMode' => 'Pipe|File',
    ],
    'CreationTime' => <DateTime>,
    'EnableNetworkIsolation' => true || false,
    'FailureReason' => '<string>',
    'FinalMetricDataList' => [
        [
            'MetricName' => '<string>',
            'Timestamp' => <DateTime>,
            'Value' => <float>,
        ],
        // ...
    ],
    'HyperParameters' => ['<string>', ...],
    'InputDataConfig' => [
        [
            'ChannelName' => '<string>',
            'CompressionType' => 'None|Gzip',
            'ContentType' => '<string>',
            'DataSource' => [
                'S3DataSource' => [
                    'AttributeNames' => ['<string>', ...],
                    'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
                    'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                    'S3Uri' => '<string>',
                ],
            ],
            'InputMode' => 'Pipe|File',
            'RecordWrapperType' => 'None|RecordIO',
            'ShuffleConfig' => [
                'Seed' => <integer>,
            ],
        ],
        // ...
    ],
    'LabelingJobArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'ModelArtifacts' => [
        'S3ModelArtifacts' => '<string>',
    ],
    'OutputDataConfig' => [
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>',
    ],
    'ResourceConfig' => [
        'InstanceCount' => <integer>,
        'InstanceType' => '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.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',
        'VolumeKmsKeyId' => '<string>',
        'VolumeSizeInGB' => <integer>,
    ],
    'RoleArn' => '<string>',
    'SecondaryStatus' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed',
    'SecondaryStatusTransitions' => [
        [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Status' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'StoppingCondition' => [
        'MaxRuntimeInSeconds' => <integer>,
    ],
    'TrainingEndTime' => <DateTime>,
    'TrainingJobArn' => '<string>',
    'TrainingJobName' => '<string>',
    'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
    'TrainingStartTime' => <DateTime>,
    'TuningJobArn' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'Subnets' => ['<string>', ...],
    ],
]

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

DescribeTransformJob

$result = $client->describeTransformJob([/* ... */]);
$promise = $client->describeTransformJobAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTransformJob([
    'TransformJobName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BatchStrategy' => 'MultiRecord|SingleRecord',
    'CreationTime' => <DateTime>,
    'Environment' => ['<string>', ...],
    'FailureReason' => '<string>',
    'LabelingJobArn' => '<string>',
    'MaxConcurrentTransforms' => <integer>,
    'MaxPayloadInMB' => <integer>,
    'ModelName' => '<string>',
    'TransformEndTime' => <DateTime>,
    'TransformInput' => [
        'CompressionType' => 'None|Gzip',
        'ContentType' => '<string>',
        'DataSource' => [
            'S3DataSource' => [
                'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
                'S3Uri' => '<string>',
            ],
        ],
        'SplitType' => 'None|Line|RecordIO',
    ],
    'TransformJobArn' => '<string>',
    'TransformJobName' => '<string>',
    'TransformJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
    'TransformOutput' => [
        'Accept' => '<string>',
        'AssembleWith' => 'None|Line',
        'KmsKeyId' => '<string>',
        'S3OutputPath' => '<string>',
    ],
    'TransformResources' => [
        'InstanceCount' => <integer>,
        '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',
        'VolumeKmsKeyId' => '<string>',
    ],
    'TransformStartTime' => <DateTime>,
]

Result Details

Errors

• ResourceNotFound:

  Resource being access is not found.

DescribeWorkteam

$result = $client->describeWorkteam([/* ... */]);
$promise = $client->describeWorkteamAsync([/* ... */]);

Parameter Syntax

$result = $client->describeWorkteam([
    'WorkteamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Workteam' => [
        'CreateDate' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedDate' => <DateTime>,
        'MemberDefinitions' => [
            [
                'CognitoMemberDefinition' => [
                    'ClientId' => '<string>',
                    'UserGroup' => '<string>',
                    'UserPool' => '<string>',
                ],
            ],
            // ...
        ],
        'ProductListingIds' => ['<string>', ...],
        'SubDomain' => '<string>',
        'WorkteamArn' => '<string>',
        'WorkteamName' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetSearchSuggestions

$result = $client->getSearchSuggestions([/* ... */]);
$promise = $client->getSearchSuggestionsAsync([/* ... */]);

Parameter Syntax

$result = $client->getSearchSuggestions([
    'Resource' => 'TrainingJob', // REQUIRED
    'SuggestionQuery' => [
        'PropertyNameQuery' => [
            'PropertyNameHint' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'PropertyNameSuggestions' => [
        [
            'PropertyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListAlgorithms

$result = $client->listAlgorithms([/* ... */]);
$promise = $client->listAlgorithmsAsync([/* ... */]);

Parameter Syntax

$result = $client->listAlgorithms([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|CreationTime',
    'SortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'AlgorithmSummaryList' => [
        [
            'AlgorithmArn' => '<string>',
            'AlgorithmDescription' => '<string>',
            'AlgorithmName' => '<string>',
            'AlgorithmStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
            'CreationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListCodeRepositories

$result = $client->listCodeRepositories([/* ... */]);
$promise = $client->listCodeRepositoriesAsync([/* ... */]);

Parameter Syntax

$result = $client->listCodeRepositories([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'LastModifiedTimeAfter' => <integer || string || DateTime>,
    'LastModifiedTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|CreationTime|LastModifiedTime',
    'SortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'CodeRepositorySummaryList' => [
        [
            'CodeRepositoryArn' => '<string>',
            'CodeRepositoryName' => '<string>',
            'CreationTime' => <DateTime>,
            'GitConfig' => [
                'Branch' => '<string>',
                'RepositoryUrl' => '<string>',
                'SecretArn' => '<string>',
            ],
            'LastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListCompilationJobs

$result = $client->listCompilationJobs([/* ... */]);
$promise = $client->listCompilationJobsAsync([/* ... */]);

Parameter Syntax

$result = $client->listCompilationJobs([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'LastModifiedTimeAfter' => <integer || string || DateTime>,
    'LastModifiedTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'StatusEquals' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
]);

Parameter Details

Result Syntax

[
    'CompilationJobSummaries' => [
        [
            'CompilationEndTime' => <DateTime>,
            'CompilationJobArn' => '<string>',
            'CompilationJobName' => '<string>',
            'CompilationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
            'CompilationTargetDevice' => 'ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|jetson_tx1|jetson_tx2|rasp3b|deeplens',
            'CreationTime' => <DateTime>,
            'LastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListEndpointConfigs

$result = $client->listEndpointConfigs([/* ... */]);
$promise = $client->listEndpointConfigsAsync([/* ... */]);

Parameter Syntax

$result = $client->listEndpointConfigs([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|CreationTime',
    'SortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'EndpointConfigs' => [
        [
            'CreationTime' => <DateTime>,
            'EndpointConfigArn' => '<string>',
            'EndpointConfigName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListEndpoints

$result = $client->listEndpoints([/* ... */]);
$promise = $client->listEndpointsAsync([/* ... */]);

Parameter Syntax

$result = $client->listEndpoints([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'LastModifiedTimeAfter' => <integer || string || DateTime>,
    'LastModifiedTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|CreationTime|Status',
    'SortOrder' => 'Ascending|Descending',
    'StatusEquals' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed',
]);

Parameter Details

Result Syntax

[
    'Endpoints' => [
        [
            'CreationTime' => <DateTime>,
            'EndpointArn' => '<string>',
            'EndpointName' => '<string>',
            'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed',
            'LastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListHyperParameterTuningJobs

$result = $client->listHyperParameterTuningJobs([/* ... */]);
$promise = $client->listHyperParameterTuningJobsAsync([/* ... */]);

Parameter Syntax

$result = $client->listHyperParameterTuningJobs([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'LastModifiedTimeAfter' => <integer || string || DateTime>,
    'LastModifiedTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|Status|CreationTime',
    'SortOrder' => 'Ascending|Descending',
    'StatusEquals' => 'Completed|InProgress|Failed|Stopped|Stopping',
]);

Parameter Details

Result Syntax

[
    'HyperParameterTuningJobSummaries' => [
        [
            'CreationTime' => <DateTime>,
            'HyperParameterTuningEndTime' => <DateTime>,
            'HyperParameterTuningJobArn' => '<string>',
            'HyperParameterTuningJobName' => '<string>',
            'HyperParameterTuningJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
            'LastModifiedTime' => <DateTime>,
            'ObjectiveStatusCounters' => [
                'Failed' => <integer>,
                'Pending' => <integer>,
                'Succeeded' => <integer>,
            ],
            'ResourceLimits' => [
                'MaxNumberOfTrainingJobs' => <integer>,
                'MaxParallelTrainingJobs' => <integer>,
            ],
            'Strategy' => 'Bayesian',
            'TrainingJobStatusCounters' => [
                'Completed' => <integer>,
                'InProgress' => <integer>,
                'NonRetryableError' => <integer>,
                'RetryableError' => <integer>,
                'Stopped' => <integer>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListLabelingJobs

$result = $client->listLabelingJobs([/* ... */]);
$promise = $client->listLabelingJobsAsync([/* ... */]);

Parameter Syntax

$result = $client->listLabelingJobs([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'LastModifiedTimeAfter' => <integer || string || DateTime>,
    'LastModifiedTimeBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'Name|CreationTime|Status',
    'SortOrder' => 'Ascending|Descending',
    'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);

Parameter Details

Result Syntax

[
    'LabelingJobSummaryList' => [
        [
            'AnnotationConsolidationLambdaArn' => '<string>',
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'InputConfig' => [
                'DataAttributes' => [
                    'ContentClassifiers' => ['<string>', ...],
                ],
                'DataSource' => [
                    'S3DataSource' => [
                        'ManifestS3Uri' => '<string>',
                    ],
                ],
            ],
            'LabelCounters' => [
                'FailedNonRetryableError' => <integer>,
                'HumanLabeled' => <integer>,
                'MachineLabeled' => <integer>,
                'TotalLabeled' => <integer>,
                'Unlabeled' => <integer>,
            ],
            'LabelingJobArn' => '<string>',
            'LabelingJobName' => '<string>',
            'LabelingJobOutput' => [
                'FinalActiveLearningModelArn' => '<string>',
                'OutputDatasetS3Uri' => '<string>',
            ],
            'LabelingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
            'LastModifiedTime' => <DateTime>,
            'PreHumanTaskLambdaArn' => '<string>',
            'WorkteamArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details