AWS SDK for PHP 3.x

Client: Aws\SageMaker\SageMakerClient

Service ID: sagemaker

Version: 2017-07-24

This page describes the parameters and results for the operations of the Amazon SageMaker Service (2017-07-24), and shows how to use the Aws\SageMaker\SageMakerClient object to call the described operations. This documentation is specific to the 2017-07-24 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddTags ( array $params = [] )
Adds or overwrites one or more tags for the specified Amazon SageMaker resource.
CreateAlgorithm ( array $params = [] )
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
CreateCodeRepository ( array $params = [] )
Creates a Git repository as a resource in your Amazon SageMaker account.
CreateCompilationJob ( array $params = [] )
Starts a model compilation job.
CreateEndpoint ( array $params = [] )
Creates an endpoint using the endpoint configuration specified in the request.
CreateEndpointConfig ( array $params = [] )
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.
CreateHyperParameterTuningJob ( array $params = [] )
Starts a hyperparameter tuning job.
CreateLabelingJob ( array $params = [] )
Creates a job that uses workers to label the data objects in your input dataset.
CreateModel ( array $params = [] )
Creates a model in Amazon SageMaker.
CreateModelPackage ( array $params = [] )
Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace.
CreateNotebookInstance ( array $params = [] )
Creates an Amazon SageMaker notebook instance.
CreateNotebookInstanceLifecycleConfig ( array $params = [] )
Creates a lifecycle configuration that you can associate with a notebook instance.
CreatePresignedNotebookInstanceUrl ( array $params = [] )
Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
CreateTrainingJob ( array $params = [] )
Starts a model training job.
CreateTransformJob ( array $params = [] )
Starts a transform job.
CreateWorkteam ( array $params = [] )
Creates a new work team for labeling your data.
DeleteAlgorithm ( array $params = [] )
Removes the specified algorithm from your account.
DeleteCodeRepository ( array $params = [] )
Deletes the specified Git repository from your account.
DeleteEndpoint ( array $params = [] )
Deletes an endpoint.
DeleteEndpointConfig ( array $params = [] )
Deletes an endpoint configuration.
DeleteModel ( array $params = [] )
Deletes a model.
DeleteModelPackage ( array $params = [] )
Deletes a model package.
DeleteNotebookInstance ( array $params = [] )
Deletes an Amazon SageMaker notebook instance.
DeleteNotebookInstanceLifecycleConfig ( array $params = [] )
Deletes a notebook instance lifecycle configuration.
DeleteTags ( array $params = [] )
Deletes the specified tags from an Amazon SageMaker resource.
DeleteWorkteam ( array $params = [] )
Deletes an existing work team.
DescribeAlgorithm ( array $params = [] )
Returns a description of the specified algorithm that is in your account.
DescribeCodeRepository ( array $params = [] )
Gets details about the specified Git repository.
DescribeCompilationJob ( array $params = [] )
Returns information about a model compilation job.
DescribeEndpoint ( array $params = [] )
Returns the description of an endpoint.
DescribeEndpointConfig ( array $params = [] )
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
DescribeHyperParameterTuningJob ( array $params = [] )
Gets a description of a hyperparameter tuning job.
DescribeLabelingJob ( array $params = [] )
Gets information about a labeling job.
DescribeModel ( array $params = [] )
Describes a model that you created using the CreateModel API.
DescribeModelPackage ( array $params = [] )
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
DescribeNotebookInstance ( array $params = [] )
Returns information about a notebook instance.
DescribeNotebookInstanceLifecycleConfig ( array $params = [] )
Returns a description of a notebook instance lifecycle configuration.
DescribeSubscribedWorkteam ( array $params = [] )
Gets information about a work team provided by a vendor.
DescribeTrainingJob ( array $params = [] )
Returns information about a training job.
DescribeTransformJob ( array $params = [] )
Returns information about a transform job.
DescribeWorkteam ( array $params = [] )
Gets information about a specific work team.
GetSearchSuggestions ( array $params = [] )
An auto-complete API for the search functionality in the Amazon SageMaker console.
ListAlgorithms ( array $params = [] )
Lists the machine learning algorithms that have been created.
ListCodeRepositories ( array $params = [] )
Gets a list of the Git repositories in your account.
ListCompilationJobs ( array $params = [] )
Lists model compilation jobs that satisfy various filters.
ListEndpointConfigs ( array $params = [] )
Lists endpoint configurations.
ListEndpoints ( array $params = [] )
Lists endpoints.
ListHyperParameterTuningJobs ( array $params = [] )
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
ListLabelingJobs ( array $params = [] )
Gets a list of labeling jobs.
ListLabelingJobsForWorkteam ( array $params = [] )
Gets a list of labeling jobs assigned to a specified work team.
ListModelPackages ( array $params = [] )
Lists the model packages that have been created.
ListModels ( array $params = [] )
Lists models created with the CreateModel API.
ListNotebookInstanceLifecycleConfigs ( array $params = [] )
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
ListNotebookInstances ( array $params = [] )
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
ListSubscribedWorkteams ( array $params = [] )
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
ListTags ( array $params = [] )
Returns the tags for the specified Amazon SageMaker resource.
ListTrainingJobs ( array $params = [] )
Lists training jobs.
ListTrainingJobsForHyperParameterTuningJob ( array $params = [] )
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
ListTransformJobs ( array $params = [] )
Lists transform jobs.
ListWorkteams ( array $params = [] )
Gets a list of work teams that you have defined in a region.
RenderUiTemplate ( array $params = [] )
Renders the UI template so that you can preview the worker's experience.
Search ( array $params = [] )
Finds Amazon SageMaker resources that match a search query.
StartNotebookInstance ( array $params = [] )
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
StopCompilationJob ( array $params = [] )
Stops a model compilation job.
StopHyperParameterTuningJob ( array $params = [] )
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
StopLabelingJob ( array $params = [] )
Stops a running labeling job.
StopNotebookInstance ( array $params = [] )
Terminates the ML compute instance.
StopTrainingJob ( array $params = [] )
Stops a training job.
StopTransformJob ( array $params = [] )
Stops a transform job.
UpdateCodeRepository ( array $params = [] )
Updates the specified Git repository with the specified values.
UpdateEndpoint ( array $params = [] )
Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
UpdateEndpointWeightsAndCapacities ( array $params = [] )
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.
UpdateNotebookInstance ( array $params = [] )
Updates a notebook instance.
UpdateNotebookInstanceLifecycleConfig ( array $params = [] )
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
UpdateWorkteam ( array $params = [] )
Updates an existing work team with new member definitions or description.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListCompilationJobs
ListEndpointConfigs
ListEndpoints
ListHyperParameterTuningJobs
ListLabelingJobs
ListLabelingJobsForWorkteam
ListModels
ListNotebookInstanceLifecycleConfigs
ListNotebookInstances
ListSubscribedWorkteams
ListTags
ListTrainingJobs
ListTrainingJobsForHyperParameterTuningJob
ListTransformJobs
ListWorkteams
Search

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
NotebookInstanceInService	DescribeNotebookInstance	30	60
NotebookInstanceStopped	DescribeNotebookInstance	30	60
NotebookInstanceDeleted	DescribeNotebookInstance	30	60
TrainingJobCompletedOrStopped	DescribeTrainingJob	120	180
EndpointInService	DescribeEndpoint	30	120
EndpointDeleted	DescribeEndpoint	30	60
TransformJobCompletedOrStopped	DescribeTransformJob	60	60

Operations

AddTags

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

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

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

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource that you want to tag.

Tags

Required: Yes
Type: Array of Tag structures

An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string.

Result Syntax

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

Result Details

Members

Tags

Type: Array of Tag structures

A list of tags associated with the Amazon SageMaker resource.

Errors

There are no errors described for this operation.

CreateAlgorithm

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

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

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.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|ml.p3dn.24xlarge', // 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

Members

AlgorithmDescription

Type: string

A description of the algorithm.

AlgorithmName

Required: Yes
Type: string

The name of the algorithm.

CertifyForMarketplace

Type: boolean

Whether to certify the algorithm so that it can be listed in AWS Marketplace.

InferenceSpecification

Type: InferenceSpecification structure

Specifies details about inference jobs that the algorithm runs, including the following:

The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the algorithm supports for inference.

TrainingSpecification

Required: Yes
Type: TrainingSpecification structure

Specifies details about training jobs run by this algorithm, including the following:

The Amazon ECR path of the container and the version digest of the algorithm.
The hyperparameters that the algorithm supports.
The instance types that the algorithm supports for training.
Whether the algorithm supports distributed training.
The metrics that the algorithm emits to Amazon CloudWatch.
Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

ValidationSpecification

Type: AlgorithmValidationSpecification structure

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

Result Syntax

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

Result Details

Members

AlgorithmArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the new algorithm.

Errors

There are no errors described for this operation.

CreateCodeRepository

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

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

The repository can be hosted either in AWS CodeCommit or in any other Git repository.

Parameter Syntax

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

Parameter Details

Members

CodeRepositoryName

Required: Yes
Type: string

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

GitConfig

Required: Yes
Type: GitConfig structure

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

Result Syntax

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

Result Details

Members

CodeRepositoryArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the new repository.

Errors

There are no errors described for this operation.

CreateCompilationJob

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

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

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

In the request body, you provide the following:

A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job

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

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

Parameter Syntax

$result = $client->createCompilationJob([
    'CompilationJobName' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'DataInputConfig' => '<string>', // REQUIRED
        'Framework' => 'TENSORFLOW|MXNET|ONNX|PYTORCH|XGBOOST', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'OutputConfig' => [ // REQUIRED
        'S3OutputLocation' => '<string>', // REQUIRED
        'TargetDevice' => 'lambda|ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|jetson_tx1|jetson_tx2|jetson_nano|rasp3b|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603', // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <integer>,
        'MaxWaitTimeInSeconds' => <integer>,
    ],
]);

Parameter Details

Members

CompilationJobName

Required: Yes
Type: string

A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.

InputConfig

Required: Yes
Type: InputConfig structure

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

OutputConfig

Required: Yes
Type: OutputConfig structure

Provides information about the output location for the compiled model and the target device the model runs on.

RoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

StoppingCondition

Required: Yes
Type: StoppingCondition structure

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Result Syntax

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

Result Details

Members

CompilationJobArn

Required: Yes
Type: string

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

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

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

Use this API only for hosting models using Amazon SageMaker hosting services.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an AWS Region in your AWS account.

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

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

For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.

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

Parameter Syntax

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

Parameter Details

Members

EndpointConfigName

Required: Yes
Type: string

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

EndpointName

Required: Yes
Type: string

The name of the endpoint. The name must be unique within an AWS Region in your AWS account.

Tags

Type: Array of Tag structures

An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.

Result Syntax

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

Result Details

Members

EndpointArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint.

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

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

Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.

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

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

Members

EndpointConfigName

Required: Yes
Type: string

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

KmsKeyId

Type: string

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

ProductionVariants

Required: Yes
Type: Array of ProductionVariant structures

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Tags

Type: Array of Tag structures

A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Result Syntax

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

Result Details

Members

EndpointConfigArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint configuration.

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

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

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',
    ],
    '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
        ],
        'EnableInterContainerTrafficEncryption' => true || false,
        'EnableManagedSpotTraining' => true || false,
        'EnableNetworkIsolation' => true || false,
        '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.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|ml.p3dn.24xlarge', // REQUIRED
            'VolumeKmsKeyId' => '<string>',
            'VolumeSizeInGB' => <integer>, // REQUIRED
        ],
        'RoleArn' => '<string>', // REQUIRED
        'StaticHyperParameters' => ['<string>', ...],
        'StoppingCondition' => [ // REQUIRED
            'MaxRuntimeInSeconds' => <integer>,
            'MaxWaitTimeInSeconds' => <integer>,
        ],
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'Subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'WarmStartConfig' => [
        'ParentHyperParameterTuningJobs' => [ // REQUIRED
            [
                'HyperParameterTuningJobName' => '<string>',
            ],
            // ...
        ],
        'WarmStartType' => 'IdenticalDataAndAlgorithm|TransferLearning', // REQUIRED
    ],
]);

Parameter Details

Members

HyperParameterTuningJobConfig

Required: Yes
Type: HyperParameterTuningJobConfig structure

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning

HyperParameterTuningJobName

Required: Yes
Type: string

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

Tags

Type: Array of Tag structures

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

TrainingJobDefinition

Type: HyperParameterTrainingJobDefinition structure

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

WarmStartConfig

Type: HyperParameterTuningJobWarmStartConfig structure

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

Result Syntax

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

Result Details

Members

HyperParameterTuningJobArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

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

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

You can select your workforce from one of three providers:

A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

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

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

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

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

Members

HumanTaskConfig

Required: Yes
Type: HumanTaskConfig structure

Configures the information required for human workers to complete a labeling task.

InputConfig

Required: Yes
Type: LabelingJobInputConfig structure

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

LabelAttributeName

Required: Yes
Type: string

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

LabelCategoryConfigS3Uri

Type: string

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

LabelingJobAlgorithmsConfig

Type: LabelingJobAlgorithmsConfig structure

Configures the information required to perform automated data labeling.

LabelingJobName

Required: Yes
Type: string

The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

OutputConfig

Required: Yes
Type: LabelingJobOutputConfig structure

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

RoleArn

Required: Yes
Type: string

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

StoppingConditions

Type: LabelingJobStoppingConditions structure

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Tags

Type: Array of Tag structures

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Result Syntax

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

Result Details

Members

LabelingJobArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

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

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

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

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

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

In the CreateModel request, you must define a container with the PrimaryContainer parameter.

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

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

Members

Containers

Type: Array of ContainerDefinition structures

Specifies the containers in the inference pipeline.

EnableNetworkIsolation

Type: boolean

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

The Semantic Segmentation built-in algorithm does not support network isolation.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

ModelName

Required: Yes
Type: string

The name of the new model.

PrimaryContainer

Type: ContainerDefinition structure

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Tags

Type: Array of Tag structures

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

VpcConfig

Type: VpcConfig structure

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

Result Syntax

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

Result Details

Members

ModelArn

Required: Yes
Type: string

The ARN of the model created in Amazon SageMaker.

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

Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.

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

Members

CertifyForMarketplace

Type: boolean

Whether to certify the model package for listing on AWS Marketplace.

InferenceSpecification

Type: InferenceSpecification structure

Specifies details about inference jobs that can be run with models based on this model package, including the following:

The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.

ModelPackageDescription

Type: string

A description of the model package.

ModelPackageName

Required: Yes
Type: string

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

SourceAlgorithmSpecification

Type: SourceAlgorithmSpecification structure

Details about the algorithm that was used to create the model package.

ValidationSpecification

Type: ModelPackageValidationSpecification structure

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

Result Syntax

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

Result Details

Members

ModelPackageArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the new model package.

Errors

There are no errors described for this operation.

CreateNotebookInstance

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

Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, Amazon SageMaker does the following:

Creates a network interface in the Amazon SageMaker VPC.
(Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

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

Members

AcceleratorTypes

Type: Array of strings

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

AdditionalCodeRepositories

Type: Array of strings

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

DefaultCodeRepository

Type: string

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

DirectInternetAccess

Type: string

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

InstanceType

Required: Yes
Type: string

The type of ML compute instance to launch for the notebook instance.

KmsKeyId

Type: string

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.

LifecycleConfigName

Type: string

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

NotebookInstanceName

Required: Yes
Type: string

The name of the new notebook instance.

RoleArn

Required: Yes
Type: string

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissionsto to assume this role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

RootAccess

Type: string

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

SecurityGroupIds

Type: Array of strings

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

SubnetId

Type: string

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

Tags

Type: Array of Tag structures

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

VolumeSizeInGB

Type: int

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Result Syntax

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

Result Details

Members

NotebookInstanceArn

Type: string

The Amazon Resource Name (ARN) of the notebook instance.

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

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceLifecycleConfigName

Required: Yes
Type: string

The name of the lifecycle configuration.

OnCreate

Type: Array of NotebookInstanceLifecycleHook structures

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

OnStart

Type: Array of NotebookInstanceLifecycleHook structures

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

Result Syntax

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

Result Details

Members

NotebookInstanceLifecycleConfigArn

Type: string

The Amazon Resource Name (ARN) of the lifecycle configuration.

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

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceName

Required: Yes
Type: string

The name of the notebook instance.

SessionExpirationDurationInSeconds

Type: int

The duration of the session, in seconds. The default is 12 hours.

Result Syntax

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

Result Details

Members

AuthorizedUrl

Type: string

A JSON object that contains the URL string.

Errors

There are no errors described for this operation.

CreateTrainingJob

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

Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences.

In the request body, you provide the following:

AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to to wait for a managed spot training job to complete.

For more information about Amazon SageMaker, see How It Works.

Parameter Syntax

$result = $client->createTrainingJob([
    'AlgorithmSpecification' => [ // REQUIRED
        'AlgorithmName' => '<string>',
        'MetricDefinitions' => [
            [
                'Name' => '<string>', // REQUIRED
                'Regex' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TrainingImage' => '<string>',
        'TrainingInputMode' => 'Pipe|File', // REQUIRED
    ],
    'CheckpointConfig' => [
        'LocalPath' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'EnableInterContainerTrafficEncryption' => true || false,
    'EnableManagedSpotTraining' => true || false,
    'EnableNetworkIsolation' => true || false,
    '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.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|ml.p3dn.24xlarge', // REQUIRED
        'VolumeKmsKeyId' => '<string>',
        'VolumeSizeInGB' => <integer>, // REQUIRED
    ],
    'RoleArn' => '<string>', // REQUIRED
    'StoppingCondition' => [ // REQUIRED
        'MaxRuntimeInSeconds' => <integer>,
        'MaxWaitTimeInSeconds' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrainingJobName' => '<string>', // REQUIRED
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members

AlgorithmSpecification

Required: Yes
Type: AlgorithmSpecification structure

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

CheckpointConfig

Type: CheckpointConfig structure

Contains information about the output location for managed spot training checkpoint data.

EnableInterContainerTrafficEncryption

Type: boolean

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

EnableManagedSpotTraining

Type: boolean

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

EnableNetworkIsolation

Type: boolean

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

The Semantic Segmentation built-in algorithm does not support network isolation.

HyperParameters

Type: Associative array of custom strings keys (ParameterKey) to strings

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

InputDataConfig

Type: Array of Channel structures

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

ResourceConfig

Required: Yes
Type: ResourceConfig structure

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

RoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

StoppingCondition

Required: Yes
Type: StoppingCondition structure

Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Tags

Type: Array of Tag structures

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

TrainingJobName

Required: Yes
Type: string

The name of the training job. The name must be unique within an AWS Region in an AWS account.

VpcConfig

Type: VpcConfig structure

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Result Syntax

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

Result Details

Members

TrainingJobArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the training job.

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

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works Amazon SageMaker, see How It Works.

Parameter Syntax

$result = $client->createTransformJob([
    'BatchStrategy' => 'MultiRecord|SingleRecord',
    'DataProcessing' => [
        'InputFilter' => '<string>',
        'JoinSource' => 'Input|None',
        'OutputFilter' => '<string>',
    ],
    '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|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

Members

BatchStrategy

Type: string

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

DataProcessing

Type: DataProcessing structure

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

Environment

Type: Associative array of custom strings keys (TransformEnvironmentKey) to strings

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

MaxConcurrentTransforms

Type: int

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the optimal settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

MaxPayloadInMB

Type: int

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

ModelName

Required: Yes

Type: string

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

Tags

Type: Array of Tag structures

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

TransformInput

Required: Yes

Type: TransformInput structure

Describes the input source and the way the transform job consumes it.

TransformJobName

Required: Yes

Type: string

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

TransformOutput

Required: Yes

Type: TransformOutput structure

Describes the results of the transform job.

TransformResources

Required: Yes

Type: TransformResources structure

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Result Syntax

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

Result Details

Members

TransformJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the transform job.

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

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

Parameter Syntax

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

Parameter Details

Members

Description

Required: Yes

Type: string

A description of the work team.

MemberDefinitions

Required: Yes

Type: Array of MemberDefinition structures

A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools.

All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.

NotificationConfiguration

Type: NotificationConfiguration structure

Configures notification of workers regarding available or expiring work items.

Tags

Type: Array of Tag structures

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

WorkteamName

Required: Yes

Type: string

The name of the work team. Use this name to identify the work team.

Result Syntax

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

Result Details

Members

WorkteamArn

Type: string

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

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

Removes the specified algorithm from your account.

Parameter Syntax

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

Parameter Details

Members

AlgorithmName

Required: Yes

Type: string

The name of the algorithm to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteCodeRepository

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

Deletes the specified Git repository from your account.

Parameter Syntax

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

Parameter Details

Members

CodeRepositoryName

Required: Yes

Type: string

The name of the Git repository to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteEndpoint

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

Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

Parameter Syntax

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

Parameter Details

Members

EndpointName

Required: Yes

Type: string

The name of the endpoint that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteEndpointConfig

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

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

Parameter Syntax

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

Parameter Details

Members

EndpointConfigName

Required: Yes

Type: string

The name of the endpoint configuration that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteModel

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

Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

Parameter Syntax

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

Parameter Details

Members

ModelName

Required: Yes

Type: string

The name of the model to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteModelPackage

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

Deletes a model package.

A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

Parameter Syntax

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

Parameter Details

Members

ModelPackageName

Required: Yes

Type: string

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteNotebookInstance

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

Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceName

Required: Yes

Type: string

The name of the Amazon SageMaker notebook instance to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteNotebookInstanceLifecycleConfig

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

Deletes a notebook instance lifecycle configuration.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceLifecycleConfigName

Required: Yes

Type: string

The name of the lifecycle configuration to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteTags

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

Deletes the specified tags from an Amazon SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

TagKeys

Required: Yes

Type: Array of strings

An array or one or more tag keys to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteWorkteam

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

Deletes an existing work team. This operation can't be undone.

Parameter Syntax

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

Parameter Details

Members

WorkteamName

Required: Yes

Type: string

The name of the work team to delete.

Result Syntax

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

Result Details

Members

Success

Required: Yes

Type: boolean

Returns true if the work team was successfully deleted; otherwise, returns false.

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

Returns a description of the specified algorithm that is in your account.

Parameter Syntax

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

Parameter Details

Members

AlgorithmName

Required: Yes

Type: string

The name of the algorithm to describe.

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' => [ 'FileSystemDataSource' => [ 'DirectoryPath' => '<string>', 'FileSystemAccessMode' => 'rw|ro', 'FileSystemId' => '<string>', 'FileSystemType' => 'EFS|FSxLustre', ], '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|ml.p3dn.24xlarge', 'VolumeKmsKeyId' => '<string>', 'VolumeSizeInGB' => <integer>, ], 'StoppingCondition' => [ 'MaxRuntimeInSeconds' => <integer>, 'MaxWaitTimeInSeconds' => <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|TFRecord', ], '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

Members

AlgorithmArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the algorithm.

AlgorithmDescription

Type: string

A brief summary about the algorithm.

AlgorithmName

Required: Yes

Type: string

The name of the algorithm being described.

AlgorithmStatus

Required: Yes

Type: string

The current status of the algorithm.

AlgorithmStatusDetails

Required: Yes

Type: AlgorithmStatusDetails structure

Details about the current status of the algorithm.

CertifyForMarketplace

Type: boolean

Whether the algorithm is certified to be listed in AWS Marketplace.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp specifying when the algorithm was created.

InferenceSpecification

Type: InferenceSpecification structure

Details about inference jobs that the algorithm runs.

ProductId

Type: string

The product identifier of the algorithm.

TrainingSpecification

Required: Yes

Type: TrainingSpecification structure

Details about training jobs run by this algorithm.

ValidationSpecification

Type: AlgorithmValidationSpecification structure

Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

Errors

There are no errors described for this operation.

DescribeCodeRepository

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

Gets details about the specified Git repository.

Parameter Syntax

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

Parameter Details

Members

CodeRepositoryName

Required: Yes

Type: string

The name of the Git repository to describe.

Result Syntax

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

Result Details

Members

CodeRepositoryArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the Git repository.

CodeRepositoryName

Required: Yes

Type: string

The name of the Git repository.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the repository was created.

GitConfig

Type: GitConfig structure

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the repository was last changed.

Errors

There are no errors described for this operation.

DescribeCompilationJob

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

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Parameter Syntax

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

Parameter Details

Members

CompilationJobName

Required: Yes

Type: string

The name of the model compilation job that you want information about.

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' => 'lambda|ml_m4|ml_m5|ml_c4|ml_c5|ml_p2|ml_p3|jetson_tx1|jetson_tx2|jetson_nano|rasp3b|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603', ], 'RoleArn' => '<string>', 'StoppingCondition' => [ 'MaxRuntimeInSeconds' => <integer>, 'MaxWaitTimeInSeconds' => <integer>, ], ]

Result Details

Members

CompilationEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

CompilationJobArn

Required: Yes

Type: string

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

CompilationJobName

Required: Yes

Type: string

The name of the model compilation job.

CompilationJobStatus

Required: Yes

Type: string

The status of the model compilation job.

CompilationStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the model compilation job was created.

FailureReason

Required: Yes

Type: string

If a model compilation job failed, the reason it failed.

InputConfig

Required: Yes

Type: InputConfig structure

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the status of the model compilation job was last modified.

ModelArtifacts

Required: Yes

Type: ModelArtifacts structure

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

OutputConfig

Required: Yes

Type: OutputConfig structure

Information about the output location for the compiled model and the target device that the model runs on.

RoleArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model compilation job.

StoppingCondition

Required: Yes

Type: StoppingCondition structure

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Errors

ResourceNotFound:
Resource being access is not found.

DescribeEndpoint

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

Returns the description of an endpoint.

Parameter Syntax

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

Parameter Details

Members

EndpointName

Required: Yes

Type: string

The name of the endpoint.

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

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint was created.

EndpointArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the endpoint.

EndpointConfigName

Required: Yes

Type: string

The name of the endpoint configuration associated with this endpoint.

EndpointName

Required: Yes

Type: string

Name of the endpoint.

EndpointStatus

Required: Yes

Type: string

The status of the endpoint.

OutOfService: Endpoint is not available to take incoming requests.

Creating: CreateEndpoint is executing.

Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

InService: Endpoint is available to process incoming requests.

Deleting: DeleteEndpoint is executing.

Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

FailureReason

Type: string

If the status of the endpoint is Failed, the reason why it failed.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint was last modified.

ProductionVariants

Type: Array of ProductionVariantSummary structures

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Errors

There are no errors described for this operation.

DescribeEndpointConfig

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

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Parameter Syntax

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

Parameter Details

Members

EndpointConfigName

Required: Yes

Type: string

The name of the endpoint configuration.

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

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint configuration was created.

EndpointConfigArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the endpoint configuration.

EndpointConfigName

Required: Yes

Type: string

Name of the Amazon SageMaker endpoint configuration.

KmsKeyId

Type: string

AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

ProductionVariants

Required: Yes

Type: Array of ProductionVariant structures

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

Errors

There are no errors described for this operation.

DescribeHyperParameterTuningJob

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

Gets a description of a hyperparameter tuning job.

Parameter Syntax

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

Parameter Details

Members

HyperParameterTuningJobName

Required: Yes

Type: string

The name of the tuning job to describe.

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>', 'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic', ], // ... ], 'IntegerParameterRanges' => [ [ 'MaxValue' => '<string>', 'MinValue' => '<string>', 'Name' => '<string>', 'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic', ], // ... ], ], 'ResourceLimits' => [ 'MaxNumberOfTrainingJobs' => <integer>, 'MaxParallelTrainingJobs' => <integer>, ], 'Strategy' => 'Bayesian|Random', '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', ], 'CheckpointConfig' => [ 'LocalPath' => '<string>', 'S3Uri' => '<string>', ], 'EnableInterContainerTrafficEncryption' => true || false, 'EnableManagedSpotTraining' => true || false, 'EnableNetworkIsolation' => true || false, 'InputDataConfig' => [ [ 'ChannelName' => '<string>', 'CompressionType' => 'None|Gzip', 'ContentType' => '<string>', 'DataSource' => [ 'FileSystemDataSource' => [ 'DirectoryPath' => '<string>', 'FileSystemAccessMode' => 'rw|ro', 'FileSystemId' => '<string>', 'FileSystemType' => 'EFS|FSxLustre', ], '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|ml.p3dn.24xlarge', 'VolumeKmsKeyId' => '<string>', 'VolumeSizeInGB' => <integer>, ], 'RoleArn' => '<string>', 'StaticHyperParameters' => ['<string>', ...], 'StoppingCondition' => [ 'MaxRuntimeInSeconds' => <integer>, 'MaxWaitTimeInSeconds' => <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

Members

BestTrainingJob

Type: HyperParameterTrainingJobSummary structure

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the tuning job started.

FailureReason

Type: string

If the tuning job failed, the reason it failed.

HyperParameterTuningEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the tuning job ended.

HyperParameterTuningJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the tuning job.

HyperParameterTuningJobConfig

Required: Yes

Type: HyperParameterTuningJobConfig structure

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

HyperParameterTuningJobName

Required: Yes

Type: string

The name of the tuning job.

HyperParameterTuningJobStatus

Required: Yes

Type: string

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the status of the tuning job was modified.

ObjectiveStatusCounters

Required: Yes

Type: ObjectiveStatusCounters structure

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

OverallBestTrainingJob

Type: HyperParameterTrainingJobSummary structure

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

TrainingJobDefinition

Type: HyperParameterTrainingJobDefinition structure

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

TrainingJobStatusCounters

Required: Yes

Type: TrainingJobStatusCounters structure

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

WarmStartConfig

Type: HyperParameterTuningJobWarmStartConfig structure

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

Errors

ResourceNotFound:
Resource being access is not found.

DescribeLabelingJob

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

Gets information about a labeling job.

Parameter Syntax

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

Parameter Details

Members

LabelingJobName

Required: Yes

Type: string

The name of the labeling job to return information for.

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

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the labeling job was created.

FailureReason

Type: string

If the job failed, the reason that it failed.

HumanTaskConfig

Required: Yes

Type: HumanTaskConfig structure

Configuration information required for human workers to complete a labeling task.

InputConfig

Required: Yes

Type: LabelingJobInputConfig structure

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

JobReferenceCode

Required: Yes

Type: string

A unique identifier for work done as part of a labeling job.

LabelAttributeName

Type: string

The attribute used as the label in the output manifest file.

LabelCategoryConfigS3Uri

Type: string

The S3 location of the JSON file that defines the categories used to label data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

LabelCounters

Required: Yes

Type: LabelCounters structure

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

LabelingJobAlgorithmsConfig

Type: LabelingJobAlgorithmsConfig structure

Configuration information for automated data labeling.

LabelingJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the labeling job.

LabelingJobName

Required: Yes

Type: string

The name assigned to the labeling job when it was created.

LabelingJobOutput

Type: LabelingJobOutput structure

The location of the output produced by the labeling job.

LabelingJobStatus

Required: Yes

Type: string

The processing status of the labeling job.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the labeling job was last updated.

OutputConfig

Required: Yes

Type: LabelingJobOutputConfig structure

The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

RoleArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

StoppingConditions

Type: LabelingJobStoppingConditions structure

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

Tags

Type: Array of Tag structures

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Errors

ResourceNotFound:
Resource being access is not found.

DescribeModel

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

Describes a model that you created using the CreateModel API.

Parameter Syntax

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

Parameter Details

Members

ModelName

Required: Yes

Type: string

The name of the model.

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

Members

Containers

Type: Array of ContainerDefinition structures

The containers in the inference pipeline.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the model was created.

EnableNetworkIsolation

Type: boolean

If True, no inbound or outbound network calls can be made to or from the model container.

The Semantic Segmentation built-in algorithm does not support network isolation.

ExecutionRoleArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

ModelArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model.

ModelName

Required: Yes

Type: string

Name of the Amazon SageMaker model.

PrimaryContainer

Type: ContainerDefinition structure

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

VpcConfig

Type: VpcConfig structure

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

Errors

There are no errors described for this operation.

DescribeModelPackage

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

Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.

Parameter Syntax

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

Parameter Details

Members

ModelPackageName

Required: Yes

Type: string

The name of the model package to describe.

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|TFRecord', ], '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

Members

CertifyForMarketplace

Type: boolean

Whether the model package is certified for listing on AWS Marketplace.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp specifying when the model package was created.

InferenceSpecification

Type: InferenceSpecification structure

Details about inference jobs that can be run with models based on this model package.

ModelPackageArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model package.

ModelPackageDescription

Type: string

A brief summary of the model package.

ModelPackageName

Required: Yes

Type: string

The name of the model package being described.

ModelPackageStatus

Required: Yes

Type: string

The current status of the model package.

ModelPackageStatusDetails

Required: Yes

Type: ModelPackageStatusDetails structure

Details about the current status of the model package.

SourceAlgorithmSpecification

Type: SourceAlgorithmSpecification structure

Details about the algorithm that was used to create the model package.

ValidationSpecification

Type: ModelPackageValidationSpecification structure

Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

Errors

There are no errors described for this operation.

DescribeNotebookInstance

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

Returns information about a notebook instance.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceName

Required: Yes

Type: string

The name of the notebook instance that you want information about.

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>', 'RootAccess' => 'Enabled|Disabled', 'SecurityGroups' => ['<string>', ...], 'SubnetId' => '<string>', 'Url' => '<string>', 'VolumeSizeInGB' => <integer>, ]

Result Details

Members

AcceleratorTypes

Type: Array of strings

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

AdditionalCodeRepositories

Type: Array of strings

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp. Use this parameter to return the time when the notebook instance was created

DefaultCodeRepository

Type: string

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

DirectInternetAccess

Type: string

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

FailureReason

Type: string

If status is Failed, the reason it failed.

InstanceType

Type: string

The type of ML compute instance running on the notebook instance.

KmsKeyId

Type: string

The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

NetworkInterfaceId

Type: string

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

NotebookInstanceArn

Type: string

The Amazon Resource Name (ARN) of the notebook instance.

NotebookInstanceLifecycleConfigName

Type: string

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

NotebookInstanceName

Type: string

The name of the Amazon SageMaker notebook instance.

NotebookInstanceStatus

Type: string

The status of the notebook instance.

RoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

RootAccess

Type: string

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

SecurityGroups

Type: Array of strings

The IDs of the VPC security groups.

SubnetId

Type: string

The ID of the VPC subnet.

Url

Type: string

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

VolumeSizeInGB

Type: int

The size, in GB, of the ML storage volume attached to the notebook instance.

Errors

There are no errors described for this operation.

DescribeNotebookInstanceLifecycleConfig

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

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceLifecycleConfigName

Required: Yes

Type: string

The name of the lifecycle configuration to describe.

Result Syntax

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

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that tells when the lifecycle configuration was created.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that tells when the lifecycle configuration was last modified.

NotebookInstanceLifecycleConfigArn

Type: string

The Amazon Resource Name (ARN) of the lifecycle configuration.

NotebookInstanceLifecycleConfigName

Type: string

The name of the lifecycle configuration.

OnCreate

Type: Array of NotebookInstanceLifecycleHook structures

The shell script that runs only once, when you create a notebook instance.

OnStart

Type: Array of NotebookInstanceLifecycleHook structures

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

Errors

There are no errors described for this operation.

DescribeSubscribedWorkteam

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

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.

Parameter Syntax

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

Parameter Details

Members

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the subscribed work team to describe.

Result Syntax

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

Result Details

Members

SubscribedWorkteam

Required: Yes

Type: SubscribedWorkteam structure

A Workteam instance that contains information about the work team.

Errors

There are no errors described for this operation.

DescribeTrainingJob

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

Returns information about a training job.

Parameter Syntax

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

Parameter Details

Members

TrainingJobName

Required: Yes

Type: string

The name of the training job.

Result Syntax

[ 'AlgorithmSpecification' => [ 'AlgorithmName' => '<string>', 'MetricDefinitions' => [ [ 'Name' => '<string>', 'Regex' => '<string>', ], // ... ], 'TrainingImage' => '<string>', 'TrainingInputMode' => 'Pipe|File', ], 'BillableTimeInSeconds' => <integer>, 'CheckpointConfig' => [ 'LocalPath' => '<string>', 'S3Uri' => '<string>', ], 'CreationTime' => <DateTime>, 'EnableInterContainerTrafficEncryption' => true || false, 'EnableManagedSpotTraining' => true || false, 'EnableNetworkIsolation' => true || false, 'FailureReason' => '<string>', 'FinalMetricDataList' => [ [ 'MetricName' => '<string>', 'Timestamp' => <DateTime>, 'Value' => <float>, ], // ... ], 'HyperParameters' => ['<string>', ...], 'InputDataConfig' => [ [ 'ChannelName' => '<string>', 'CompressionType' => 'None|Gzip', 'ContentType' => '<string>', 'DataSource' => [ 'FileSystemDataSource' => [ 'DirectoryPath' => '<string>', 'FileSystemAccessMode' => 'rw|ro', 'FileSystemId' => '<string>', 'FileSystemType' => 'EFS|FSxLustre', ], '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|ml.p3dn.24xlarge', 'VolumeKmsKeyId' => '<string>', 'VolumeSizeInGB' => <integer>, ], 'RoleArn' => '<string>', 'SecondaryStatus' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded', 'SecondaryStatusTransitions' => [ [ 'EndTime' => <DateTime>, 'StartTime' => <DateTime>, 'Status' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded', 'StatusMessage' => '<string>', ], // ... ], 'StoppingCondition' => [ 'MaxRuntimeInSeconds' => <integer>, 'MaxWaitTimeInSeconds' => <integer>, ], 'TrainingEndTime' => <DateTime>, 'TrainingJobArn' => '<string>', 'TrainingJobName' => '<string>', 'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped', 'TrainingStartTime' => <DateTime>, 'TrainingTimeInSeconds' => <integer>, 'TuningJobArn' => '<string>', 'VpcConfig' => [ 'SecurityGroupIds' => ['<string>', ...], 'Subnets' => ['<string>', ...], ], ]

Result Details

Members

AlgorithmSpecification

Required: Yes

Type: AlgorithmSpecification structure

Information about the algorithm used for training, and algorithm metadata.

BillableTimeInSeconds

Type: int

The billable time in seconds.

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

CheckpointConfig

Type: CheckpointConfig structure

Contains information about the output location for managed spot training checkpoint data.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the training job was created.

EnableInterContainerTrafficEncryption

Type: boolean

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

EnableManagedSpotTraining

Type: boolean

A Boolean indicating whether managed spot training is enabled (True) or not (False).

EnableNetworkIsolation

Type: boolean

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

The Semantic Segmentation built-in algorithm does not support network isolation.

FailureReason

Type: string

If the training job failed, the reason it failed.

FinalMetricDataList

Type: Array of MetricData structures

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

HyperParameters

Type: Associative array of custom strings keys (ParameterKey) to strings

Algorithm-specific parameters.

InputDataConfig

Type: Array of Channel structures

An array of Channel objects that describes each data input channel.

LabelingJobArn

Type: string

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the status of the training job was last modified.

ModelArtifacts

Required: Yes

Type: ModelArtifacts structure

Information about the Amazon S3 location that is configured for storing model artifacts.

OutputDataConfig

Type: OutputDataConfig structure

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

ResourceConfig

Required: Yes

Type: ResourceConfig structure

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

RoleArn

Type: string

The AWS Identity and Access Management (IAM) role configured for the training job.

SecondaryStatus

Required: Yes

Type: string

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

Starting - Starting the training job.

Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

Training - Training is in progress.

Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

Completed - The training job has completed.

Failed

Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

MaxWaitTmeExceeded - The job stopped because it exceeded the maximum allowed wait time.

Interrupted - The job stopped because the managed spot training instances were interrupted.

Stopped - The training job has stopped.

Stopping

Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

LaunchingMLInstances

PreparingTrainingStack

DownloadingTrainingImage

SecondaryStatusTransitions

Type: Array of SecondaryStatusTransition structures

A history of all of the secondary statuses that the training job has transitioned through.

StoppingCondition

Required: Yes

Type: StoppingCondition structure

Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

TrainingEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

TrainingJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the training job.

TrainingJobName

Required: Yes

Type: string

Name of the model training job.

TrainingJobStatus

Required: Yes

Type: string

The status of the training job.

Amazon SageMaker provides the following training job statuses:

InProgress - The training is in progress.

Completed - The training job has completed.

Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

Stopping - The training job is stopping.

Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

TrainingStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

TrainingTimeInSeconds

Type: int

The training time in seconds.

TuningJobArn

Type: string

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

VpcConfig

Type: VpcConfig structure

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Errors

ResourceNotFound:
Resource being access is not found.

DescribeTransformJob

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

Returns information about a transform job.

Parameter Syntax

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

Parameter Details

Members

TransformJobName

Required: Yes

Type: string

The name of the transform job that you want to view details of.

Result Syntax

[ 'BatchStrategy' => 'MultiRecord|SingleRecord', 'CreationTime' => <DateTime>, 'DataProcessing' => [ 'InputFilter' => '<string>', 'JoinSource' => 'Input|None', 'OutputFilter' => '<string>', ], '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|TFRecord', ], '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

Members

BatchStrategy

Type: string

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the transform Job was created.

DataProcessing

Type: DataProcessing structure

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

Environment

Type: Associative array of custom strings keys (TransformEnvironmentKey) to strings

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

FailureReason

Type: string

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

LabelingJobArn

Type: string

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

MaxConcurrentTransforms

Type: int

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

MaxPayloadInMB

Type: int

The maximum payload size, in MB, used in the transform job.

ModelName

Required: Yes

Type: string

The name of the model used in the transform job.

TransformEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

TransformInput

Required: Yes

Type: TransformInput structure

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

TransformJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the transform job.

TransformJobName

Required: Yes

Type: string

The name of the transform job.

TransformJobStatus

Required: Yes

Type: string

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

TransformOutput

Type: TransformOutput structure

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

TransformResources

Required: Yes

Type: TransformResources structure

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

TransformStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

Errors

ResourceNotFound:
Resource being access is not found.

DescribeWorkteam

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

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Members

WorkteamName

Required: Yes

Type: string

The name of the work team to return a description of.

Result Syntax

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

Result Details

Members

Workteam

Required: Yes

Type: Workteam structure

A Workteam instance that contains information about the work team.

Errors

There are no errors described for this operation.

GetSearchSuggestions

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

An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

Parameter Syntax

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

Parameter Details

Members

Resource

Required: Yes

Type: string

The name of the Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob.

SuggestionQuery

Type: SuggestionQuery structure

Limits the property names that are included in the response.

Result Syntax

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

Result Details

Members

PropertyNameSuggestions

Type: Array of PropertyNameSuggestion structures

A list of property names for a Resource that match a SuggestionQuery.

Errors

There are no errors described for this operation.

ListAlgorithms

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

Lists the machine learning algorithms that have been created.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only algorithms created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only algorithms created before the specified time (timestamp).

MaxResults

Type: int

The maximum number of algorithms to return in the response.

NameContains

Type: string

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

NextToken

Type: string

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

SortBy

Type: string

The parameter by which to sort the results. The default is CreationTime.

SortOrder

Type: string

The sort order for the results. The default is Ascending.

Result Syntax

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

Result Details

Members

AlgorithmSummaryList

Required: Yes

Type: Array of AlgorithmSummary structures

>An array of AlgorithmSummary objects, each of which lists an algorithm.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

Errors

There are no errors described for this operation.

ListCodeRepositories

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

Gets a list of the Git repositories in your account.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only Git repositories that were created after the specified time.

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only Git repositories that were created before the specified time.

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only Git repositories that were last modified after the specified time.

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only Git repositories that were last modified before the specified time.

MaxResults

Type: int

The maximum number of Git repositories to return in the response.

NameContains

Type: string

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

NextToken

Type: string

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is Name.

SortOrder

Type: string

The sort order for results. The default is Ascending.

Result Syntax

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

Result Details

Members

CodeRepositorySummaryList

Required: Yes

Type: Array of CodeRepositorySummary structures

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

Name

Amazon Resource Name (ARN)

Creation time

Last modified time

Configuration information, including the URL location of the repository and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

NextToken

Type: string

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

Errors

There are no errors described for this operation.

ListCompilationJobs

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

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

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>', 'SortBy' => 'Name|CreationTime|Status', 'SortOrder' => 'Ascending|Descending', 'StatusEquals' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED', ]);

Parameter Details

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns the model compilation jobs that were created after a specified time.

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns the model compilation jobs that were created before a specified time.

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns the model compilation jobs that were modified after a specified time.

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns the model compilation jobs that were modified before a specified time.

MaxResults

Type: int

The maximum number of model compilation jobs to return in the response.

NameContains

Type: string

A filter that returns the model compilation jobs whose name contains a specified string.

NextToken

Type: string

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

SortBy

Type: string

The field by which to sort results. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Ascending.

StatusEquals

Type: string

A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

Result Syntax

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

Result Details

Members

CompilationJobSummaries

Required: Yes

Type: Array of CompilationJobSummary structures

An array of CompilationJobSummary objects, each describing a model compilation job.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

Errors

There are no errors described for this operation.

ListEndpointConfigs

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

Lists endpoint configurations.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoint configurations created before the specified time (timestamp).

MaxResults

Type: int

The maximum number of training jobs to return in the response.

NameContains

Type: string

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Descending.

Result Syntax

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

Result Details

Members

EndpointConfigs

Required: Yes

Type: Array of EndpointConfigSummary structures

An array of endpoint configurations.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

Errors

There are no errors described for this operation.

ListEndpoints

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

Lists endpoints.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoints that were created before the specified time (timestamp).

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoints that were modified after the specified timestamp.

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only endpoints that were modified before the specified timestamp.

MaxResults

Type: int

The maximum number of endpoints to return in the response.

NameContains

Type: string

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

NextToken

Type: string

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

SortBy

Type: string

Sorts the list of results. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Descending.

StatusEquals

Type: string

A filter that returns only endpoints with the specified status.

Result Syntax

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

Result Details

Members

Endpoints

Required: Yes

Type: Array of EndpointSummary structures

An array or endpoint objects.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

Errors

There are no errors described for this operation.

ListHyperParameterTuningJobs

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

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only tuning jobs that were created after the specified time.

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only tuning jobs that were created before the specified time.

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only tuning jobs that were modified after the specified time.

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only tuning jobs that were modified before the specified time.

MaxResults

Type: int

The maximum number of tuning jobs to return. The default value is 10.

NameContains

Type: string

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is Name.

SortOrder

Type: string

The sort order for results. The default is Ascending.

StatusEquals

Type: string

A filter that returns only tuning jobs with the specified status.

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|Random', 'TrainingJobStatusCounters' => [ 'Completed' => <integer>, 'InProgress' => <integer>, 'NonRetryableError' => <integer>, 'RetryableError' => <integer>, 'Stopped' => <integer>, ], ], // ... ], 'NextToken' => '<string>', ]

Result Details

Members

HyperParameterTuningJobSummaries

Required: Yes

Type: Array of HyperParameterTuningJobSummary structures

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

NextToken

Type: string

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

Errors

There are no errors described for this operation.

ListLabelingJobs

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

Gets a list of labeling jobs.

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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs created before the specified time (timestamp).

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs modified after the specified time (timestamp).

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs modified before the specified time (timestamp).

MaxResults

Type: int

The maximum number of labeling jobs to return in each page of the response.

NameContains

Type: string

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Ascending.

StatusEquals

Type: string

A filter that retrieves only labeling jobs with a specific status.

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

Members

LabelingJobSummaryList

Type: Array of LabelingJobSummary structures

An array of LabelingJobSummary objects, each describing a labeling job.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

Errors

There are no errors described for this operation.

ListLabelingJobsForWorkteam

$result = $client->listLabelingJobsForWorkteam([/* ... */]); $promise = $client->listLabelingJobsForWorkteamAsync([/* ... */]);

Gets a list of labeling jobs assigned to a specified work team.

Parameter Syntax

$result = $client->listLabelingJobsForWorkteam([ 'CreationTimeAfter' => <integer || string || DateTime>, 'CreationTimeBefore' => <integer || string || DateTime>, 'JobReferenceCodeContains' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'SortBy' => 'CreationTime', 'SortOrder' => 'Ascending|Descending', 'WorkteamArn' => '<string>', // REQUIRED ]);

Parameter Details

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only labeling jobs created before the specified time (timestamp).

JobReferenceCodeContains

Type: string

A filter the limits jobs to only the ones whose job reference code contains the specified string.

MaxResults

Type: int

The maximum number of labeling jobs to return in each page of the response.

NextToken

Type: string

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Ascending.

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

Result Syntax

[ 'LabelingJobSummaryList' => [ [ 'CreationTime' => <DateTime>, 'JobReferenceCode' => '<string>', 'LabelCounters' => [ 'HumanLabeled' => <integer>, 'PendingHuman' => <integer>, 'Total' => <integer>, ], 'LabelingJobName' => '<string>', 'NumberOfHumanWorkersPerDataObject' => <integer>, 'WorkRequesterAccountId' => '<string>', ], // ... ], 'NextToken' => '<string>', ]

Result Details

Members

LabelingJobSummaryList

Required: Yes

Type: Array of LabelingJobForWorkteamSummary structures

An array of LabelingJobSummary objects, each describing a labeling job.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

Errors

ResourceNotFound:
Resource being access is not found.

ListModelPackages

$result = $client->listModelPackages([/* ... */]); $promise = $client->listModelPackagesAsync([/* ... */]);

Lists the model packages that have been created.

Parameter Syntax

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

Parameter Details

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only model packages created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only model packages created before the specified time (timestamp).

MaxResults

Type: int

The maximum number of model packages to return in the response.

NameContains

Type: string

A string in the model package name. This filter returns only model packages whose name contains the specified string.

NextToken

Type: string

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

SortBy

Type: string

The parameter by which to sort the results. The default is CreationTime.

SortOrder

Type: string

The sort order for the results. The default is Ascending.

Result Syntax

[ 'ModelPackageSummaryList' => [ [ 'CreationTime' => <DateTime>, 'ModelPackageArn' => '<string>', 'ModelPackageDescription' => '<string>', 'ModelPackageName' => '<string>', 'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting', ], // ... ], 'NextToken' => '<string>', ]

Result Details

Members

ModelPackageSummaryList

Required: Yes

Type: Array of ModelPackageSummary structures

An array of ModelPackageSummary objects, each of which lists a model package.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

Errors

There are no errors described for this operation.

ListModels

$result = $client->listModels([/* ... */]); $promise = $client->listModelsAsync([/* ... */]);

Lists models created with the CreateModel API.

Parameter Syntax

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

Parameter Details

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only models created before the specified time (timestamp).

MaxResults

Type: int

The maximum number of models to return in the response.

NameContains

Type: string

A string in the training job name. This filter returns only models in the training job whose name contains the specified string.

NextToken

Type: string

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

SortBy

Type: string

Sorts the list of results. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Descending.

Result Syntax

[ 'Models' => [ [ 'CreationTime' => <DateTime>, 'ModelArn' => '<string>', 'ModelName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]

Result Details

Members

Models

Required: Yes

Type: Array of ModelSummary structures

An array of ModelSummary objects, each of which lists a model.

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

Errors

There are no errors described for this operation.

ListNotebookInstanceLifecycleConfigs

$result = $client->listNotebookInstanceLifecycleConfigs([/* ... */]); $promise = $client->listNotebookInstanceLifecycleConfigsAsync([/* ... */]);

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

Parameter Syntax

$result = $client->listNotebookInstanceLifecycleConfigs([ '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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

MaxResults

Type: int

The maximum number of lifecycle configurations to return in the response.

NameContains

Type: string

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

NextToken

Type: string

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

SortBy

Type: string

Sorts the list of results. The default is CreationTime.

SortOrder

Type: string

The sort order for results.

Result Syntax

[ 'NextToken' => '<string>', 'NotebookInstanceLifecycleConfigs' => [ [ 'CreationTime' => <DateTime>, 'LastModifiedTime' => <DateTime>, 'NotebookInstanceLifecycleConfigArn' => '<string>', 'NotebookInstanceLifecycleConfigName' => '<string>', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

NotebookInstanceLifecycleConfigs

Type: Array of NotebookInstanceLifecycleConfigSummary structures

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

Errors

There are no errors described for this operation.

ListNotebookInstances

$result = $client->listNotebookInstances([/* ... */]); $promise = $client->listNotebookInstancesAsync([/* ... */]);

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.

Parameter Syntax

$result = $client->listNotebookInstances([ 'AdditionalCodeRepositoryEquals' => '<string>', 'CreationTimeAfter' => <integer || string || DateTime>, 'CreationTimeBefore' => <integer || string || DateTime>, 'DefaultCodeRepositoryContains' => '<string>', 'LastModifiedTimeAfter' => <integer || string || DateTime>, 'LastModifiedTimeBefore' => <integer || string || DateTime>, 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', 'NotebookInstanceLifecycleConfigNameContains' => '<string>', 'SortBy' => 'Name|CreationTime|Status', 'SortOrder' => 'Ascending|Descending', 'StatusEquals' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating', ]);

Parameter Details

Members

AdditionalCodeRepositoryEquals

Type: string

A filter that returns only notebook instances with associated with the specified git repository.

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only notebook instances that were created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only notebook instances that were created before the specified time (timestamp).

DefaultCodeRepositoryContains

Type: string

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only notebook instances that were modified after the specified time (timestamp).

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only notebook instances that were modified before the specified time (timestamp).

MaxResults

Type: int

The maximum number of notebook instances to return.

NameContains

Type: string

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

NextToken

Type: string

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

NotebookInstanceLifecycleConfigNameContains

Type: string

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

SortBy

Type: string

The field to sort results by. The default is Name.

SortOrder

Type: string

The sort order for results.

StatusEquals

Type: string

A filter that returns only notebook instances with the specified status.

Result Syntax

[ 'NextToken' => '<string>', 'NotebookInstances' => [ [ 'AdditionalCodeRepositories' => ['<string>', ...], 'CreationTime' => <DateTime>, 'DefaultCodeRepository' => '<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', 'LastModifiedTime' => <DateTime>, 'NotebookInstanceArn' => '<string>', 'NotebookInstanceLifecycleConfigName' => '<string>', 'NotebookInstanceName' => '<string>', 'NotebookInstanceStatus' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating', 'Url' => '<string>', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

NotebookInstances

Type: Array of NotebookInstanceSummary structures

An array of NotebookInstanceSummary objects, one for each notebook instance.

Errors

There are no errors described for this operation.

ListSubscribedWorkteams

$result = $client->listSubscribedWorkteams([/* ... */]); $promise = $client->listSubscribedWorkteamsAsync([/* ... */]);

Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Parameter Syntax

$result = $client->listSubscribedWorkteams([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', ]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of work teams to return in each page of the response.

NameContains

Type: string

A string in the work team name. This filter returns only work teams whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

Result Syntax

[ 'NextToken' => '<string>', 'SubscribedWorkteams' => [ [ 'ListingId' => '<string>', 'MarketplaceDescription' => '<string>', 'MarketplaceTitle' => '<string>', 'SellerName' => '<string>', 'WorkteamArn' => '<string>', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

SubscribedWorkteams

Required: Yes

Type: Array of SubscribedWorkteam structures

An array of Workteam objects, each describing a work team.

Errors

There are no errors described for this operation.

ListTags

$result = $client->listTags([/* ... */]); $promise = $client->listTagsAsync([/* ... */]);

Returns the tags for the specified Amazon SageMaker resource.

Parameter Syntax

$result = $client->listTags([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ResourceArn' => '<string>', // REQUIRED ]);

Parameter Details

Members

MaxResults

Type: int

Maximum number of tags to return.

NextToken

Type: string

If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

ResourceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Result Syntax

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

Result Details

Members

NextToken

Type: string

If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

Tags

Type: Array of Tag structures

An array of Tag objects, each with a tag key and a value.

Errors

There are no errors described for this operation.

ListTrainingJobs

$result = $client->listTrainingJobs([/* ... */]); $promise = $client->listTrainingJobsAsync([/* ... */]);

Lists training jobs.

Parameter Syntax

$result = $client->listTrainingJobs([ '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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only training jobs created after the specified time (timestamp).

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only training jobs created before the specified time (timestamp).

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only training jobs modified after the specified time (timestamp).

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only training jobs modified before the specified time (timestamp).

MaxResults

Type: int

The maximum number of training jobs to return in the response.

NameContains

Type: string

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Ascending.

StatusEquals

Type: string

A filter that retrieves only training jobs with a specific status.

Result Syntax

[ 'NextToken' => '<string>', 'TrainingJobSummaries' => [ [ 'CreationTime' => <DateTime>, 'LastModifiedTime' => <DateTime>, 'TrainingEndTime' => <DateTime>, 'TrainingJobArn' => '<string>', 'TrainingJobName' => '<string>', 'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

TrainingJobSummaries

Required: Yes

Type: Array of TrainingJobSummary structures

An array of TrainingJobSummary objects, each listing a training job.

Errors

There are no errors described for this operation.

ListTrainingJobsForHyperParameterTuningJob

$result = $client->listTrainingJobsForHyperParameterTuningJob([/* ... */]); $promise = $client->listTrainingJobsForHyperParameterTuningJobAsync([/* ... */]);

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

Parameter Syntax

$result = $client->listTrainingJobsForHyperParameterTuningJob([ 'HyperParameterTuningJobName' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'SortBy' => 'Name|CreationTime|Status|FinalObjectiveMetricValue', 'SortOrder' => 'Ascending|Descending', 'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped', ]);

Parameter Details

Members

HyperParameterTuningJobName

Required: Yes

Type: string

The name of the tuning job whose training jobs you want to list.

MaxResults

Type: int

The maximum number of training jobs to return. The default value is 10.

NextToken

Type: string

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

SortOrder

Type: string

The sort order for results. The default is Ascending.

StatusEquals

Type: string

A filter that returns only training jobs with the specified status.

Result Syntax

[ 'NextToken' => '<string>', 'TrainingJobSummaries' => [ [ '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>', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

TrainingJobSummaries

Required: Yes

Type: Array of HyperParameterTrainingJobSummary structures

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

Errors

ResourceNotFound:
Resource being access is not found.

ListTransformJobs

$result = $client->listTransformJobs([/* ... */]); $promise = $client->listTransformJobsAsync([/* ... */]);

Lists transform jobs.

Parameter Syntax

$result = $client->listTransformJobs([ '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

Members

CreationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only transform jobs created after the specified time.

CreationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only transform jobs created before the specified time.

LastModifiedTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only transform jobs modified after the specified time.

LastModifiedTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

A filter that returns only transform jobs modified before the specified time.

MaxResults

Type: int

The maximum number of transform jobs to return in the response. The default value is 10.

NameContains

Type: string

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Descending.

StatusEquals

Type: string

A filter that retrieves only transform jobs with a specific status.

Result Syntax

[ 'NextToken' => '<string>', 'TransformJobSummaries' => [ [ 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'LastModifiedTime' => <DateTime>, 'TransformEndTime' => <DateTime>, 'TransformJobArn' => '<string>', 'TransformJobName' => '<string>', 'TransformJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped', ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

TransformJobSummaries

Required: Yes

Type: Array of TransformJobSummary structures

An array of TransformJobSummary objects.

Errors

There are no errors described for this operation.

ListWorkteams

$result = $client->listWorkteams([/* ... */]); $promise = $client->listWorkteamsAsync([/* ... */]);

Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Parameter Syntax

$result = $client->listWorkteams([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', 'SortBy' => 'Name|CreateDate', 'SortOrder' => 'Ascending|Descending', ]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of work teams to return in each page of the response.

NameContains

Type: string

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

NextToken

Type: string

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

SortBy

Type: string

The field to sort results by. The default is CreationTime.

SortOrder

Type: string

The sort order for results. The default is Ascending.

Result Syntax

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

Result Details

Members

NextToken

Type: string

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

Workteams

Required: Yes

Type: Array of Workteam structures

An array of Workteam objects, each describing a work team.

Errors

There are no errors described for this operation.

RenderUiTemplate

$result = $client->renderUiTemplate([/* ... */]); $promise = $client->renderUiTemplateAsync([/* ... */]);

Renders the UI template so that you can preview the worker's experience.

Parameter Syntax

$result = $client->renderUiTemplate([ 'RoleArn' => '<string>', // REQUIRED 'Task' => [ // REQUIRED 'Input' => '<string>', // REQUIRED ], 'UiTemplate' => [ // REQUIRED 'Content' => '<string>', // REQUIRED ], ]);

Parameter Details

Members

RoleArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Task

Required: Yes

Type: RenderableTask structure

A RenderableTask object containing a representative task to render.

UiTemplate

Required: Yes

Type: UiTemplate structure

A Template object containing the worker UI template to render.

Result Syntax

[ 'Errors' => [ [ 'Code' => '<string>', 'Message' => '<string>', ], // ... ], 'RenderedContent' => '<string>', ]

Result Details

Members

Errors

Required: Yes

Type: Array of RenderingError structures

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

RenderedContent

Required: Yes

Type: string

A Liquid template that renders the HTML for the worker UI.

Errors

There are no errors described for this operation.

Search

$result = $client->search([/* ... */]); $promise = $client->searchAsync([/* ... */]);

Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numerical, text, Booleans, and timestamps.

Parameter Syntax

$result = $client->search([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Resource' => 'TrainingJob', // REQUIRED 'SearchExpression' => [ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Operator' => 'Equals|NotEquals|GreaterThan|GreaterThanOrEqualTo|LessThan|LessThanOrEqualTo|Contains', 'Value' => '<string>', ], // ... ], 'NestedFilters' => [ [ 'Filters' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Operator' => 'Equals|NotEquals|GreaterThan|GreaterThanOrEqualTo|LessThan|LessThanOrEqualTo|Contains', 'Value' => '<string>', ], // ... ], 'NestedPropertyName' => '<string>', // REQUIRED ], // ... ], 'Operator' => 'And|Or', 'SubExpressions' => [ [...], // RECURSIVE // ... ], ], 'SortBy' => '<string>', 'SortOrder' => 'Ascending|Descending', ]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results to return in a SearchResponse.

NextToken

Type: string

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Resource

Required: Yes

Type: string

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

SearchExpression

Type: SearchExpression structure

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

SortBy

Type: string

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

SortOrder

Type: string

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Result Syntax

[ 'NextToken' => '<string>', 'Results' => [ [ 'TrainingJob' => [ 'AlgorithmSpecification' => [ 'AlgorithmName' => '<string>', 'MetricDefinitions' => [ [ 'Name' => '<string>', 'Regex' => '<string>', ], // ... ], 'TrainingImage' => '<string>', 'TrainingInputMode' => 'Pipe|File', ], 'CreationTime' => <DateTime>, 'EnableInterContainerTrafficEncryption' => true || false, 'EnableNetworkIsolation' => true || false, 'FailureReason' => '<string>', 'FinalMetricDataList' => [ [ 'MetricName' => '<string>', 'Timestamp' => <DateTime>, 'Value' => <float>, ], // ... ], 'HyperParameters' => ['<string>', ...], 'InputDataConfig' => [ [ 'ChannelName' => '<string>', 'CompressionType' => 'None|Gzip', 'ContentType' => '<string>', 'DataSource' => [ 'FileSystemDataSource' => [ 'DirectoryPath' => '<string>', 'FileSystemAccessMode' => 'rw|ro', 'FileSystemId' => '<string>', 'FileSystemType' => 'EFS|FSxLustre', ], '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|ml.p3dn.24xlarge', 'VolumeKmsKeyId' => '<string>', 'VolumeSizeInGB' => <integer>, ], 'RoleArn' => '<string>', 'SecondaryStatus' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded', 'SecondaryStatusTransitions' => [ [ 'EndTime' => <DateTime>, 'StartTime' => <DateTime>, 'Status' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded', 'StatusMessage' => '<string>', ], // ... ], 'StoppingCondition' => [ 'MaxRuntimeInSeconds' => <integer>, 'MaxWaitTimeInSeconds' => <integer>, ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TrainingEndTime' => <DateTime>, 'TrainingJobArn' => '<string>', 'TrainingJobName' => '<string>', 'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped', 'TrainingStartTime' => <DateTime>, 'TuningJobArn' => '<string>', 'VpcConfig' => [ 'SecurityGroupIds' => ['<string>', ...], 'Subnets' => ['<string>', ...], ], ], ], // ... ], ]

Result Details

Members

NextToken

Type: string

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

Results

Type: Array of SearchRecord structures

A list of SearchResult objects.

Errors

There are no errors described for this operation.

StartNotebookInstance

$result = $client->startNotebookInstance([/* ... */]); $promise = $client->startNotebookInstanceAsync([/* ... */]);

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceName

Required: Yes

Type: string

The name of the notebook instance to start.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

StopCompilationJob

$result = $client->stopCompilationJob([/* ... */]); $promise = $client->stopCompilationJobAsync([/* ... */]);

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

Parameter Syntax

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

Parameter Details

Members

CompilationJobName

Required: Yes

Type: string

The name of the model compilation job to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFound:
Resource being access is not found.

StopHyperParameterTuningJob

$result = $client->stopHyperParameterTuningJob([/* ... */]); $promise = $client->stopHyperParameterTuningJobAsync([/* ... */]);

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

Parameter Syntax

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

Parameter Details

Members

HyperParameterTuningJobName

Required: Yes

Type: string

The name of the tuning job to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFound:
Resource being access is not found.

StopLabelingJob

$result = $client->stopLabelingJob([/* ... */]); $promise = $client->stopLabelingJobAsync([/* ... */]);

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

Parameter Syntax

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

Parameter Details

Members

LabelingJobName

Required: Yes

Type: string

The name of the labeling job to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFound:
Resource being access is not found.

StopNotebookInstance

$result = $client->stopNotebookInstance([/* ... */]); $promise = $client->stopNotebookInstanceAsync([/* ... */]);

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceName

Required: Yes

Type: string

The name of the notebook instance to terminate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

StopTrainingJob

$result = $client->stopTrainingJob([/* ... */]); $promise = $client->stopTrainingJobAsync([/* ... */]);

Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.

Parameter Syntax

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

Parameter Details

Members

TrainingJobName

Required: Yes

Type: string

The name of the training job to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFound:
Resource being access is not found.

StopTransformJob

$result = $client->stopTransformJob([/* ... */]); $promise = $client->stopTransformJobAsync([/* ... */]);

Stops a transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

Parameter Syntax

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

Parameter Details

Members

TransformJobName

Required: Yes

Type: string

The name of the transform job to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFound:
Resource being access is not found.

UpdateCodeRepository

$result = $client->updateCodeRepository([/* ... */]); $promise = $client->updateCodeRepositoryAsync([/* ... */]);

Updates the specified Git repository with the specified values.

Parameter Syntax

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

Parameter Details

Members

CodeRepositoryName

Required: Yes

Type: string

The name of the Git repository to update.

GitConfig

Type: GitConfigForUpdate structure

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

Result Syntax

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

Result Details

Members

CodeRepositoryArn

Required: Yes

Type: string

The ARN of the Git repository.

Errors

There are no errors described for this operation.

UpdateEndpoint

$result = $client->updateEndpoint([/* ... */]); $promise = $client->updateEndpointAsync([/* ... */]);

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

Parameter Syntax

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

Parameter Details

Members

EndpointConfigName

Required: Yes

Type: string

The name of the new endpoint configuration.

EndpointName

Required: Yes

Type: string

The name of the endpoint whose configuration you want to update.

Result Syntax

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

Result Details

Members

EndpointArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the endpoint.

Errors

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

UpdateEndpointWeightsAndCapacities

$result = $client->updateEndpointWeightsAndCapacities([/* ... */]); $promise = $client->updateEndpointWeightsAndCapacitiesAsync([/* ... */]);

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

Parameter Syntax

$result = $client->updateEndpointWeightsAndCapacities([ 'DesiredWeightsAndCapacities' => [ // REQUIRED [ 'DesiredInstanceCount' => <integer>, 'DesiredWeight' => <float>, 'VariantName' => '<string>', // REQUIRED ], // ... ], 'EndpointName' => '<string>', // REQUIRED ]);

Parameter Details

Members

DesiredWeightsAndCapacities

Required: Yes

Type: Array of DesiredWeightAndCapacity structures

An object that provides new capacity and weight values for a variant.

EndpointName

Required: Yes

Type: string

The name of an existing Amazon SageMaker endpoint.

Result Syntax

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

Result Details

Members

EndpointArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the updated endpoint.

Errors

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

UpdateNotebookInstance

$result = $client->updateNotebookInstance([/* ... */]); $promise = $client->updateNotebookInstanceAsync([/* ... */]);

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

Parameter Syntax

$result = $client->updateNotebookInstance([ 'AcceleratorTypes' => ['<string>', ...], 'AdditionalCodeRepositories' => ['<string>', ...], 'DefaultCodeRepository' => '<string>', 'DisassociateAcceleratorTypes' => true || false, 'DisassociateAdditionalCodeRepositories' => true || false, 'DisassociateDefaultCodeRepository' => true || false, 'DisassociateLifecycleConfig' => true || false, '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', 'LifecycleConfigName' => '<string>', 'NotebookInstanceName' => '<string>', // REQUIRED 'RoleArn' => '<string>', 'RootAccess' => 'Enabled|Disabled', 'VolumeSizeInGB' => <integer>, ]);

Parameter Details

Members

AcceleratorTypes

Type: Array of strings

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

AdditionalCodeRepositories

Type: Array of strings

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

DefaultCodeRepository

Type: string

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

DisassociateAcceleratorTypes

Type: boolean

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

DisassociateAdditionalCodeRepositories

Type: boolean

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

DisassociateDefaultCodeRepository

Type: boolean

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

DisassociateLifecycleConfig

Type: boolean

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

InstanceType

Type: string

The Amazon ML compute instance type.

LifecycleConfigName

Type: string

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

NotebookInstanceName

Required: Yes

Type: string

The name of the notebook instance to update.

RoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

RootAccess

Type: string

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

VolumeSizeInGB

Type: int

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

UpdateNotebookInstanceLifecycleConfig

$result = $client->updateNotebookInstanceLifecycleConfig([/* ... */]); $promise = $client->updateNotebookInstanceLifecycleConfigAsync([/* ... */]);

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Parameter Syntax

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

Parameter Details

Members

NotebookInstanceLifecycleConfigName

Required: Yes

Type: string

The name of the lifecycle configuration.

OnCreate

Type: Array of NotebookInstanceLifecycleHook structures

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

OnStart

Type: Array of NotebookInstanceLifecycleHook structures

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

UpdateWorkteam

$result = $client->updateWorkteam([/* ... */]); $promise = $client->updateWorkteamAsync([/* ... */]);

Updates an existing work team with new member definitions or description.

Parameter Syntax

$result = $client->updateWorkteam([ 'Description' => '<string>', 'MemberDefinitions' => [ [ 'CognitoMemberDefinition' => [ 'ClientId' => '<string>', // REQUIRED 'UserGroup' => '<string>', // REQUIRED 'UserPool' => '<string>', // REQUIRED ], ], // ... ], 'NotificationConfiguration' => [ 'NotificationTopicArn' => '<string>', ], 'WorkteamName' => '<string>', // REQUIRED ]);

Parameter Details

Members

Description

Type: string

An updated description for the work team.

MemberDefinitions

Type: Array of MemberDefinition structures

A list of MemberDefinition objects that contain the updated work team members.

NotificationConfiguration

Type: NotificationConfiguration structure

Configures SNS topic notifications for available or expiring work items

WorkteamName

Required: Yes

Type: string

The name of the work team to update.

Result Syntax

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

Result Details

Members

Workteam

Required: Yes

Type: Workteam structure

A Workteam object that describes the updated work team.

Errors

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

Shapes

AlgorithmSpecification

Description

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

Members

AlgorithmName

Type: string

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

MetricDefinitions

Type: Array of MetricDefinition structures

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

TrainingImage

Type: string

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

TrainingInputMode

Required: Yes

Type: string

The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.

AlgorithmStatusDetails

Description

Specifies the validation and image scan statuses of the algorithm.

Members

ImageScanStatuses

Type: Array of AlgorithmStatusItem structures

The status of the scan of the algorithm's Docker image container.

ValidationStatuses

Type: Array of AlgorithmStatusItem structures

The status of algorithm validation.

AlgorithmStatusItem

Description

Represents the overall status of an algorithm.

Members

FailureReason

Type: string

if the overall status is Failed, the reason for the failure.

Name

Required: Yes

Type: string

The name of the algorithm for which the overall status is being reported.

Status

Required: Yes

Type: string

The current status.

AlgorithmSummary

Description

Provides summary information about an algorithm.

Members

AlgorithmArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the algorithm.

AlgorithmDescription

Type: string

A brief description of the algorithm.

AlgorithmName

Required: Yes

Type: string

The name of the algorithm that is described by the summary.

AlgorithmStatus

Required: Yes

Type: string

The overall status of the algorithm.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the algorithm was created.

AlgorithmValidationProfile

Description

Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on AWS Marketplace.

Members

ProfileName

Required: Yes

Type: string

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

TrainingJobDefinition

Required: Yes

Type: TrainingJobDefinition structure

The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.

TransformJobDefinition

Type: TransformJobDefinition structure

The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.

AlgorithmValidationSpecification

Description

Specifies configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

Members

ValidationProfiles

Required: Yes

Type: Array of AlgorithmValidationProfile structures

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

ValidationRole

Required: Yes

Type: string

The IAM roles that Amazon SageMaker uses to run the training jobs.

AnnotationConsolidationConfig

Description

Configures how labels are consolidated across human workers.

Members

AnnotationConsolidationLambdaArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

For more information, see Annotation Consolidation.

CategoricalParameterRange

Description

A list of categorical hyperparameters to tune.

Members

Name

Required: Yes

Type: string

The name of the categorical hyperparameter to tune.

Values

Required: Yes

Type: Array of strings

A list of the categories for the hyperparameter.

CategoricalParameterRangeSpecification

Description

Defines the possible values for a categorical hyperparameter.

Members

Values

Required: Yes

Type: Array of strings

The allowed categories for the hyperparameter.

Channel

Description

A channel is a named input source that training algorithms can consume.

Members

ChannelName

Required: Yes

Type: string

The name of the channel.

CompressionType

Type: string

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

ContentType

Type: string

The MIME type of the data.

DataSource

Required: Yes

Type: DataSource structure

The location of the channel data.

InputMode

Type: string

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

RecordWrapperType

Type: string

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

ShuffleConfig

Type: ShuffleConfig structure

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

ChannelSpecification

Description

Defines a named input source, called a channel, to be used by an algorithm.

Members

Description

Type: string

A brief description of the channel.

IsRequired

Type: boolean

Indicates whether the channel is required by the algorithm.

Name

Required: Yes

Type: string

The name of the channel.

SupportedCompressionTypes

Type: Array of strings

The allowed compression types, if data compression is used.

SupportedContentTypes

Required: Yes

Type: Array of strings

The supported MIME types for the data.

SupportedInputModes

Required: Yes

Type: Array of strings

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

CheckpointConfig

Description

Contains information about the output location for managed spot training checkpoint data.

Members

LocalPath

Type: string

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

S3Uri

Required: Yes

Type: string

Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

CodeRepositorySummary

Description

Specifies summary information about a Git repository.

Members

CodeRepositoryArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the Git repository.

CodeRepositoryName

Required: Yes

Type: string

The name of the Git repository.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the Git repository was created.

GitConfig

Type: GitConfig structure

Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the Git repository was last modified.

CognitoMemberDefinition

Description

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

Members

ClientId

Required: Yes

Type: string

An identifier for an application client. You must create the app client ID using Amazon Cognito.

UserGroup

Required: Yes

Type: string

An identifier for a user group.

UserPool

Required: Yes

Type: string

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

CompilationJobSummary

Description

A summary of a model compilation job.

Members

CompilationEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job completed.

CompilationJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model compilation job.

CompilationJobName

Required: Yes

Type: string

The name of the model compilation job that you want a summary for.

CompilationJobStatus

Required: Yes

Type: string

The status of the model compilation job.

CompilationStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job started.

CompilationTargetDevice

Required: Yes

Type: string

The type of device that the model will run on after compilation has completed.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job was created.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the model compilation job was last modified.

ContainerDefinition

Description

Describes the container, as part of model definition.

Members

ContainerHostname

Type: string

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

Environment

Type: Associative array of custom strings keys (EnvironmentKey) to strings

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

Image

Type: string

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

ModelDataUrl

Type: string

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

ModelPackageName

Type: string

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

ContinuousParameterRange

Description

A list of continuous hyperparameters to tune.

Members

MaxValue

Required: Yes

Type: string

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

MinValue

Required: Yes

Type: string

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

Name

Required: Yes

Type: string

The name of the continuous hyperparameter to tune.

ScalingType

Type: string

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

ContinuousParameterRangeSpecification

Description

Defines the possible values for a continuous hyperparameter.

Members

MaxValue

Required: Yes

Type: string

The maximum floating-point value allowed.

MinValue

Required: Yes

Type: string

The minimum floating-point value allowed.

DataProcessing

Description

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

Members

InputFilter

Type: string

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

JoinSource

Type: string

Specifies the source of the data to join with the transformed data. The valid values are None and Input The default value is None which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input.

For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.

OutputFilter

Type: string

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"

DataSource

Description

Describes the location of the channel data.

Members

FileSystemDataSource

Type: FileSystemDataSource structure

The file system that is associated with a channel.

S3DataSource

Type: S3DataSource structure

The S3 location of the data source that is associated with a channel.

DeployedImage

Description

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

Members

ResolutionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the image path for the model resolved to the ResolvedImage

ResolvedImage

Type: string

The specific digest path of the image hosted in this ProductionVariant.

SpecifiedImage

Type: string

The image path you specified when you created the model.

DesiredWeightAndCapacity

Description

Specifies weight and capacity values for a production variant.

Members

DesiredInstanceCount

Type: int

The variant's capacity.

DesiredWeight

Type: float

The variant's weight.

VariantName

Required: Yes

Type: string

The name of the variant to update.

EndpointConfigSummary

Description

Provides summary information for an endpoint configuration.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint configuration was created.

EndpointConfigArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the endpoint configuration.

EndpointConfigName

Required: Yes

Type: string

The name of the endpoint configuration.

EndpointSummary

Description

Provides summary information for an endpoint.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint was created.

EndpointArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the endpoint.

EndpointName

Required: Yes

Type: string

The name of the endpoint.

EndpointStatus

Required: Yes

Type: string

The status of the endpoint.

OutOfService: Endpoint is not available to take incoming requests.

Creating: CreateEndpoint is executing.

Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

InService: Endpoint is available to process incoming requests.

Deleting: DeleteEndpoint is executing.

Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the endpoint was last modified.

FileSystemDataSource

Description

Specifies a file system data source for a channel.

Members

DirectoryPath

Required: Yes

Type: string

The full path to the directory to associate with the channel.

FileSystemAccessMode

Required: Yes

Type: string

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write).

FileSystemId

Required: Yes

Type: string

The file system id.

FileSystemType

Required: Yes

Type: string

The file system type.

Filter

Description

A conditional statement for a search expression that includes a Boolean operator, a resource property, and a value.

If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.

If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as the default.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GREATER_THAN",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LESS_THAN",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form "Tags.<key>".

Members

Name

Required: Yes

Type: string

A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

Operator

Type: string

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The specified resource in Name equals the specified Value.

NotEquals

The specified resource in Name does not equal the specified Value.

GreaterThan

The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

GreaterThanOrEqualTo

The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

LessThan

The specified resource in Name is less than the specified Value. Not supported for text-based properties.

LessThanOrEqualTo

The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

Contains

Only supported for text-based properties. The word-list of the property contains the specified Value.

If you have specified a filter Value, the default is Equals.

Value

Type: string

A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

FinalHyperParameterTuningJobObjectiveMetric

Description

Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

Members

MetricName

Required: Yes

Type: string

The name of the objective metric.

Type

Type: string

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Value

Required: Yes

Type: float

The value of the objective metric.

GitConfig

Description

Specifies configuration details for a Git repository in your AWS account.

Members

Branch

Type: string

The default branch for the Git repository.

RepositoryUrl

Required: Yes

Type: string

The URL where the Git repository is located.

SecretArn

Type: string

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

GitConfigForUpdate

Description

Specifies configuration details for a Git repository when the repository is updated.

Members

SecretArn

Type: string

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

HumanTaskConfig

Description

Information required for human workers to complete a labeling task.

Members

AnnotationConsolidationConfig

Required: Yes

Type: AnnotationConsolidationConfig structure

Configures how labels are consolidated across human workers.

MaxConcurrentTaskCount

Type: int

Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

NumberOfHumanWorkersPerDataObject

Required: Yes

Type: int

The number of human workers that will label an object.

PreHumanTaskLambdaArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

US East (Northern Virginia) (us-east-1):

arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

US East (Ohio) (us-east-2):

arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

US West (Oregon) (us-west-2):

arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

Canada (Central) (ca-central-1):

arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

EU (Ireland) (eu-west-1):

arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

EU (London) (eu-west-2):

arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

EU Frankfurt (eu-central-1):

arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

Asia Pacific (Tokyo) (ap-northeast-1):

arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

Asia Pacific (Seoul) (ap-northeast-2):

arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

Asia Pacific (Mumbai) (ap-south-1):

arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

Asia Pacific (Singapore) (ap-southeast-1):

arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

Asia Pacific (Sydney) (ap-southeast-2):

arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

PublicWorkforceTaskPrice

Type: PublicWorkforceTaskPrice structure

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

TaskAvailabilityLifetimeInSeconds

Type: int

The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

TaskDescription

Required: Yes

Type: string

A description of the task for your human workers.

TaskKeywords

Type: Array of strings

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

TaskTimeLimitInSeconds

Required: Yes

Type: int

The amount of time that a worker has to complete a task.

TaskTitle

Required: Yes

Type: string

A title for the task for your human workers.

UiConfig

Required: Yes

Type: UiConfig structure

Information about the user interface that workers use to complete the labeling task.

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

HyperParameterAlgorithmSpecification

Description

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

Members

AlgorithmName

Type: string

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

MetricDefinitions

Type: Array of MetricDefinition structures

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

TrainingImage

Type: string

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

TrainingInputMode

Required: Yes

Type: string

The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

HyperParameterSpecification

Description

Defines a hyperparameter to be used by an algorithm.

Members

DefaultValue

Type: string

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Description

Type: string

A brief description of the hyperparameter.

IsRequired

Type: boolean

Indicates whether this hyperparameter is required.

IsTunable

Type: boolean

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Name

Required: Yes

Type: string

The name of this hyperparameter. The name must be unique.

Range

Type: ParameterRange structure

The allowed range for this hyperparameter.

Type

Required: Yes

Type: string

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

HyperParameterTrainingJobDefinition

Description

Defines the training jobs launched by a hyperparameter tuning job.

Members

AlgorithmSpecification

Required: Yes

Type: HyperParameterAlgorithmSpecification structure

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

CheckpointConfig

Type: CheckpointConfig structure

Contains information about the output location for managed spot training checkpoint data.

EnableInterContainerTrafficEncryption

Type: boolean

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

EnableManagedSpotTraining

Type: boolean

A Boolean indicating whether managed spot training is enabled (True) or not (False).

EnableNetworkIsolation

Type: boolean

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

The Semantic Segmentation built-in algorithm does not support network isolation.

InputDataConfig

Type: Array of Channel structures

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

OutputDataConfig

Required: Yes

Type: OutputDataConfig structure

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

ResourceConfig

Required: Yes

Type: ResourceConfig structure

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

RoleArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

StaticHyperParameters

Type: Associative array of custom strings keys (ParameterKey) to strings

Specifies the values of hyperparameters that do not change for the tuning job.

StoppingCondition

Required: Yes

Type: StoppingCondition structure

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

VpcConfig

Type: VpcConfig structure

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

HyperParameterTrainingJobSummary

Description

Specifies summary information about a training job.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the training job was created.

FailureReason

Type: string

The reason that the training job failed.

FinalHyperParameterTuningJobObjectiveMetric

Type: FinalHyperParameterTuningJobObjectiveMetric structure

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

ObjectiveStatus

Type: string

The status of the objective metric for the training job:

Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

Pending: The training job is in progress and evaluation of its final objective metric is pending.

Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

TrainingEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

TrainingJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the training job.

TrainingJobName

Required: Yes

Type: string

The name of the training job.

TrainingJobStatus

Required: Yes

Type: string

The status of the training job.

TrainingStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the training job started.

TunedHyperParameters

Required: Yes

Type: Associative array of custom strings keys (ParameterKey) to strings

A list of the hyperparameters for which you specified ranges to search.

TuningJobName

Type: string

The HyperParameter tuning job that launched the training job.

HyperParameterTuningJobConfig

Description

Configures a hyperparameter tuning job.

Members

HyperParameterTuningJobObjective

Type: HyperParameterTuningJobObjective structure

The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

ParameterRanges

Type: ParameterRanges structure

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

ResourceLimits

Required: Yes

Type: ResourceLimits structure

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

Strategy

Required: Yes

Type: string

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.

TrainingJobEarlyStoppingType

Type: string

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

HyperParameterTuningJobObjective

Description

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

Members

MetricName

Required: Yes

Type: string

The name of the metric to use for the objective metric.

Type

Required: Yes

Type: string

Whether to minimize or maximize the objective metric.

HyperParameterTuningJobSummary

Description

Provides summary information about a hyperparameter tuning job.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the tuning job was created.

HyperParameterTuningEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the tuning job ended.

HyperParameterTuningJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the tuning job.

HyperParameterTuningJobName

Required: Yes

Type: string

The name of the tuning job.

HyperParameterTuningJobStatus

Required: Yes

Type: string

The status of the tuning job.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the tuning job was modified.

ObjectiveStatusCounters

Required: Yes

Type: ObjectiveStatusCounters structure

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

ResourceLimits

Type: ResourceLimits structure

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

Strategy

Required: Yes

Type: string

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.

TrainingJobStatusCounters

Required: Yes

Type: TrainingJobStatusCounters structure

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

HyperParameterTuningJobWarmStartConfig

Description

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

Members

ParentHyperParameterTuningJobs

Required: Yes

Type: Array of ParentHyperParameterTuningJob structures

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

WarmStartType

Required: Yes

Type: string

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

InferenceSpecification

Description

Defines how to perform inference generation after a training job is run.

Members

Containers

Required: Yes

Type: Array of ModelPackageContainerDefinition structures

The Amazon ECR registry path of the Docker image that contains the inference code.

SupportedContentTypes

Required: Yes

Type: Array of strings

The supported MIME types for the input data.

SupportedRealtimeInferenceInstanceTypes

Required: Yes

Type: Array of strings

A list of the instance types that are used to generate inferences in real-time.

SupportedResponseMIMETypes

Required: Yes

Type: Array of strings

The supported MIME types for the output data.

SupportedTransformInstanceTypes

Required: Yes

Type: Array of strings

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

InputConfig

Description

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Members

DataInputConfig

Required: Yes

Type: string

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

Examples for one input:

If using the console, {"input":[1,1024,1024,3]}

If using the CLI, {\"input\":[1,1024,1024,3]}

Examples for two inputs:

If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

Examples for one input:

If using the console, {"data":[1,3,1024,1024]}

If using the CLI, {\"data\":[1,3,1024,1024]}

Examples for two inputs:

If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

Examples for one input in dictionary format:

If using the console, {"input0":[1,3,224,224]}

If using the CLI, {\"input0\":[1,3,224,224]}

Example for one input in list format: [[1,3,224,224]]

Examples for two inputs in dictionary format:

If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

XGBOOST: input data name and shape are not needed.

Framework

Required: Yes

Type: string

Identifies the framework in which the model was trained. For example: TENSORFLOW.

S3Uri

Required: Yes

Type: string

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

IntegerParameterRange

Description

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

Members

MaxValue

Required: Yes

Type: string

The maximum value of the hyperparameter to search.

MinValue

Required: Yes

Type: string

The minimum value of the hyperparameter to search.

Name

Required: Yes

Type: string

The name of the hyperparameter to search.

ScalingType

Type: string

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

IntegerParameterRangeSpecification

Description

Defines the possible values for an integer hyperparameter.

Members

MaxValue

Required: Yes

Type: string

The maximum integer value allowed.

MinValue

Required: Yes

Type: string

The minimum integer value allowed.

LabelCounters

Description

Provides a breakdown of the number of objects labeled.

Members

FailedNonRetryableError

Type: int

The total number of objects that could not be labeled due to an error.

HumanLabeled

Type: int

The total number of objects labeled by a human worker.

MachineLabeled

Type: int

The total number of objects labeled by automated data labeling.

TotalLabeled

Type: int

The total number of objects labeled.

Unlabeled

Type: int

The total number of objects not yet labeled.

LabelCountersForWorkteam

Description

Provides counts for human-labeled tasks in the labeling job.

Members

HumanLabeled

Type: int

The total number of data objects labeled by a human worker.

PendingHuman

Type: int

The total number of data objects that need to be labeled by a human worker.

Total

Type: int

The total number of tasks in the labeling job.

LabelingJobAlgorithmsConfig

Description

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

Members

InitialActiveLearningModelArn

Type: string

At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

LabelingJobAlgorithmSpecificationArn

Required: Yes

Type: string

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

Image classification

arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

Text classification

arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

Object detection

arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

Semantic Segmentation

arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

LabelingJobResourceConfig

Type: LabelingJobResourceConfig structure

Provides configuration information for a labeling job.

LabelingJobDataAttributes

Description

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

Members

ContentClassifiers

Type: Array of strings

Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

LabelingJobDataSource

Description

Provides information about the location of input data.

Members

S3DataSource

Required: Yes

Type: LabelingJobS3DataSource structure

The Amazon S3 location of the input data objects.

LabelingJobForWorkteamSummary

Description

Provides summary information for a work team.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the labeling job was created.

JobReferenceCode

Required: Yes

Type: string

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

LabelCounters

Type: LabelCountersForWorkteam structure

Provides information about the progress of a labeling job.

LabelingJobName

Type: string

The name of the labeling job that the work team is assigned to.

NumberOfHumanWorkersPerDataObject

Type: int

The configured number of workers per data object.

WorkRequesterAccountId

Required: Yes

Type: string

LabelingJobInputConfig

Description

Input configuration information for a labeling job.

Members

DataAttributes

Type: LabelingJobDataAttributes structure

Attributes of the data specified by the customer.

DataSource

Required: Yes

Type: LabelingJobDataSource structure

The location of the input data.

LabelingJobOutput

Description

Specifies the location of the output produced by the labeling job.

Members

FinalActiveLearningModelArn

Type: string

The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.

OutputDatasetS3Uri

Required: Yes

Type: string

The Amazon S3 bucket location of the manifest file for labeled data.

LabelingJobOutputConfig

Description

Output configuration information for a labeling job.

Members

KmsKeyId

Type: string

The AWS Key Management Service ID of the key used to encrypt the output data, if any.

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

S3OutputPath

Required: Yes

Type: string

The Amazon S3 location to write output data.

LabelingJobResourceConfig

Description

Provides configuration information for labeling jobs.

Members

VolumeKmsKeyId

Type: string

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

// KMS Key ID

"1234abcd-12ab-34cd-56ef-1234567890ab"

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

LabelingJobS3DataSource

Description

The Amazon S3 location of the input data objects.

Members

ManifestS3Uri

Required: Yes

Type: string

The Amazon S3 location of the manifest file that describes the input data objects.

LabelingJobStoppingConditions

Description

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Members

MaxHumanLabeledObjectCount

Type: int

The maximum number of objects that can be labeled by human workers.

MaxPercentageOfInputDatasetLabeled

Type: int

The maximum number of input data objects that should be labeled.

LabelingJobSummary

Description

Provides summary information about a labeling job.

Members

AnnotationConsolidationLambdaArn

Type: string

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the job was created (timestamp).

FailureReason

Type: string

If the LabelingJobStatus field is Failed, this field contains a description of the error.

InputConfig

Type: LabelingJobInputConfig structure

Input configuration for the labeling job.

LabelCounters

Required: Yes

Type: LabelCounters structure

Counts showing the progress of the labeling job.

LabelingJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

LabelingJobName

Required: Yes

Type: string

The name of the labeling job.

LabelingJobOutput

Type: LabelingJobOutput structure

The location of the output produced by the labeling job.

LabelingJobStatus

Required: Yes

Type: string

The current status of the labeling job.

LastModifiedTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the job was last modified (timestamp).

PreHumanTaskLambdaArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the work team assigned to the job.

MemberDefinition

Description

Defines the Amazon Cognito user group that is part of a work team.

Members

CognitoMemberDefinition

Type: CognitoMemberDefinition structure

The Amazon Cognito user group that is part of the work team.

MetricData

Description

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

Members

MetricName

Type: string

The name of the metric.

Timestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the algorithm emitted the metric.

Value

Type: float

The value of the metric.

MetricDefinition

Description

Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

Members

Name

Required: Yes

Type: string

The name of the metric.

Regex

Required: Yes

Type: string

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

ModelArtifacts

Description

Provides information about the location that is configured for storing model artifacts.

Members

S3ModelArtifacts

Required: Yes

Type: string

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

ModelPackageContainerDefinition

Description

Describes the Docker container for the model package.

Members

ContainerHostname

Type: string

The DNS host name for the Docker container.

Image

Required: Yes

Type: string

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

ImageDigest

Type: string

An MD5 hash of the training algorithm that identifies the Docker image used for training.

ModelDataUrl

Type: string

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

ProductId

Type: string

The AWS Marketplace product ID of the model package.

ModelPackageStatusDetails

Description

Specifies the validation and image scan statuses of the model package.

Members

ImageScanStatuses

Type: Array of ModelPackageStatusItem structures

The status of the scan of the Docker image container for the model package.

ValidationStatuses

Required: Yes

Type: Array of ModelPackageStatusItem structures

The validation status of the model package.

ModelPackageStatusItem

Description

Represents the overall status of a model package.

Members

FailureReason

Type: string

if the overall status is Failed, the reason for the failure.

Name

Required: Yes

Type: string

The name of the model package for which the overall status is being reported.

Status

Required: Yes

Type: string

The current status.

ModelPackageSummary

Description

Provides summary information about a model package.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the model package was created.

ModelPackageArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model package.

ModelPackageDescription

Type: string

A brief description of the model package.

ModelPackageName

Required: Yes

Type: string

The name of the model package.

ModelPackageStatus

Required: Yes

Type: string

The overall status of the model package.

ModelPackageValidationProfile

Description

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on AWS Marketplace.

Members

ProfileName

Required: Yes

Type: string

The name of the profile for the model package.

TransformJobDefinition

Required: Yes

Type: TransformJobDefinition structure

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

ModelPackageValidationSpecification

Description

Specifies batch transform jobs that Amazon SageMaker runs to validate your model package.

Members

ValidationProfiles

Required: Yes

Type: Array of ModelPackageValidationProfile structures

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.

ValidationRole

Required: Yes

Type: string

The IAM roles to be used for the validation of the model package.

ModelSummary

Description

Provides summary information about a model.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the model was created.

ModelArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model.

ModelName

Required: Yes

Type: string

The name of the model that you want a summary for.

NestedFilters

Description

Defines a list of NestedFilters objects. To satisfy the conditions specified in the NestedFilters call, a resource must satisfy the conditions of all of the filters.

For example, you could define a NestedFilters using the training job's InputDataConfig property to filter on Channel objects.

A NestedFilters object contains multiple filters. For example, to find all training jobs whose name contains train and that have cat/data in their S3Uri (specified in InputDataConfig), you need to create a NestedFilters object that specifies the InputDataConfig property with the following Filter objects:

'{Name:"InputDataConfig.ChannelName", "Operator":"EQUALS", "Value":"train"}',

'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"CONTAINS", "Value":"cat/data"}'

Members

Filters

Required: Yes

Type: Array of Filter structures

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

NestedPropertyName

Required: Yes

Type: string

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .

NotebookInstanceLifecycleConfigSummary

Description

Provides a summary of a notebook instance lifecycle configuration.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that tells when the lifecycle configuration was created.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that tells when the lifecycle configuration was last modified.

NotebookInstanceLifecycleConfigArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the lifecycle configuration.

NotebookInstanceLifecycleConfigName

Required: Yes

Type: string

The name of the lifecycle configuration.

NotebookInstanceLifecycleHook

Description

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Members

Content

Type: string

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

NotebookInstanceSummary

Description

Provides summary information for an Amazon SageMaker notebook instance.

Members

AdditionalCodeRepositories

Type: Array of strings

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the notebook instance was created.

DefaultCodeRepository

Type: string

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

InstanceType

Type: string

The type of ML compute instance that the notebook instance is running on.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the notebook instance was last modified.

NotebookInstanceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the notebook instance.

NotebookInstanceLifecycleConfigName

Type: string

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

NotebookInstanceName

Required: Yes

Type: string

The name of the notebook instance that you want a summary for.

NotebookInstanceStatus

Type: string

The status of the notebook instance.

Url

Type: string

The URL that you use to connect to the Jupyter instance running in your notebook instance.

NotificationConfiguration

Description

Configures SNS notifications of available or expiring work items for work teams.

Members

NotificationTopicArn

Type: string

The ARN for the SNS topic to which notifications should be published.

ObjectiveStatusCounters

Description

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

Members

Failed

Type: int

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

Pending

Type: int

The number of training jobs that are in progress and pending evaluation of their final objective metric.

Succeeded

Type: int

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

OutputConfig

Description

Contains information about the output location for the compiled model and the device (target) that the model runs on.

Members

S3OutputLocation

Required: Yes

Type: string

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

TargetDevice

Required: Yes

Type: string

Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.

OutputDataConfig

Description

Provides information about how to store model training results (model artifacts).

Members

KmsKeyId

Type: string

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

// KMS Key ID

"1234abcd-12ab-34cd-56ef-1234567890ab"

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

// KMS Key Alias

"alias/ExampleAlias"

// Amazon Resource Name (ARN) of a KMS Key Alias

"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

S3OutputPath

Required: Yes

Type: string

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

ParameterRange

Description

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

Members

CategoricalParameterRangeSpecification

Type: CategoricalParameterRangeSpecification structure

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

ContinuousParameterRangeSpecification

Type: ContinuousParameterRangeSpecification structure

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

IntegerParameterRangeSpecification

Type: IntegerParameterRangeSpecification structure

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

ParameterRanges

Description

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.

Members

CategoricalParameterRanges

Type: Array of CategoricalParameterRange structures

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

ContinuousParameterRanges

Type: Array of ContinuousParameterRange structures

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

IntegerParameterRanges

Type: Array of IntegerParameterRange structures

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

ParentHyperParameterTuningJob

Description

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

Members

HyperParameterTuningJobName

Type: string

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

ProductionVariant

Description

Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

Members

AcceleratorType

Type: string

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

InitialInstanceCount

Required: Yes

Type: int

Number of instances to launch initially.

InitialVariantWeight

Type: float

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

InstanceType

Required: Yes

Type: string

The ML compute instance type.

ModelName

Required: Yes

Type: string

The name of the model that you want to host. This is the name that you specified when creating the model.

VariantName

Required: Yes

Type: string

The name of the production variant.

ProductionVariantSummary

Description

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

Members

CurrentInstanceCount

Type: int

The number of instances associated with the variant.

CurrentWeight

Type: float

The weight associated with the variant.

DeployedImages

Type: Array of DeployedImage structures

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

DesiredInstanceCount

Type: int

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

DesiredWeight

Type: float

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

VariantName

Required: Yes

Type: string

The name of the variant.

PropertyNameQuery

Description

A type of SuggestionQuery. A suggestion query for retrieving property names that match the specified hint.

Members

PropertyNameHint

Required: Yes

Type: string

Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint.

PropertyNameSuggestion

Description

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

Members

PropertyName

Type: string

A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.

PublicWorkforceTaskPrice

Description

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

0.036

0.048

0.060

0.072

0.120

0.240

0.360

0.480

0.600

0.720

0.840

0.960

1.080

1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

0.012

0.024

0.036

0.048

0.060

0.072

0.120

0.240

0.360

0.480

0.600

0.720

0.840

0.960

1.080

1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

0.840

0.960

1.080

1.200

Members

AmountInUsd

Type: USD structure

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

RenderableTask

Description

Contains input values for a task.

Members

Input

Required: Yes

Type: string

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

RenderingError

Description

A description of an error that occurred while rendering the template.

Members

Code

Required: Yes

Type: string

A unique identifier for a specific class of errors.

Message

Required: Yes

Type: string

A human-readable message describing the error.

ResourceConfig

Description

Describes the resources, including ML compute instances and ML storage volumes, to use for model training.

Members

InstanceCount

Required: Yes

Type: int

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

InstanceType

Required: Yes

Type: string

The ML compute instance type.

VolumeKmsKeyId

Type: string

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

// KMS Key ID

"1234abcd-12ab-34cd-56ef-1234567890ab"

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VolumeSizeInGB

Required: Yes

Type: int

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

You must specify sufficient ML storage for your scenario.

Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.

ResourceInUse

Description

Resource being accessed is in use.

Members

Message

Type: string

ResourceLimitExceeded

Description

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

Members

Message

Type: string

ResourceLimits

Description

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

Members

MaxNumberOfTrainingJobs

Required: Yes

Type: int

The maximum number of training jobs that a hyperparameter tuning job can launch.

MaxParallelTrainingJobs

Required: Yes

Type: int

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

ResourceNotFound

Description

Resource being access is not found.

Members

Message

Type: string

S3DataSource

Description

Describes the S3 data source.

Members

AttributeNames

Type: Array of strings

A list of one or more attribute names to use that are found in a specified augmented manifest file.

S3DataDistributionType

Type: string

If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

S3DataType

Required: Yes

Type: string

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

S3Uri

Required: Yes

Type: string

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

A key name prefix might look like this: s3://bucketname/exampleprefix.

A manifest might look like this: s3://bucketname/example.manifest

The manifest is an S3 object which is a JSON file with the following format:

[

{"prefix": "s3://customer_bucket/some/prefix/"},

"relative/path/to/custdata-1",

"relative/path/custdata-2",

...

]

The preceding JSON matches the following s3Uris:

s3://customer_bucket/some/prefix/relative/path/to/custdata-1

s3://customer_bucket/some/prefix/relative/path/custdata-2

...

The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

SearchExpression

Description

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

A Boolean operator: And or Or.

Members

Filters

Type: Array of Filter structures

A list of filter objects.

NestedFilters

Type: Array of NestedFilters structures

A list of nested filter objects.

Operator

Type: string

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

SubExpressions

Type: Array of SearchExpression structures

A list of search expression objects.

SearchRecord

Description

An individual search result record that contains a single resource object.

Members

TrainingJob

Type: TrainingJob structure

A TrainingJob object that is returned as part of a Search request.

SecondaryStatusTransition

Description

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

StartTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the training job transitioned to the current secondary status state.

Status

Required: Yes

Type: string

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

Starting - Starting the training job.

Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

Training - Training is in progress.

Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

Completed - The training job has completed.

Failed

Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

Stopped - The training job has stopped.

Stopping

Stopping - Stopping the training job.

We no longer support the following secondary statuses:

LaunchingMLInstances

PreparingTrainingStack

DownloadingTrainingImage

StatusMessage

Type: string

A detailed description of the progress within a secondary status.

Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

Starting the training job.

Launching requested ML instances.

Insufficient capacity error from EC2 while launching instances, retrying!

Launched instance was unhealthy, replacing it!

Preparing the instances for training.

Training

Downloading the training image.

Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

TrainingJobStatus - InProgress

SecondaryStatus - Training

StatusMessage - Downloading the training image

ShuffleConfig

Description

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

Members

Seed

Required: Yes

Type: long (int|float)

Determines the shuffling order in ShuffleConfig value.

SourceAlgorithm

Description

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

Members

AlgorithmName

Required: Yes

Type: string

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

ModelDataUrl

Type: string

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

SourceAlgorithmSpecification

Description

A list of algorithms that were used to create a model package.

Members

SourceAlgorithms

Required: Yes

Type: Array of SourceAlgorithm structures

A list of the algorithms that were used to create a model package.

StoppingCondition

Description

Specifies a limit to how long a model training or compilation job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

Members

MaxRuntimeInSeconds

Type: int

The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

MaxWaitTimeInSeconds

Type: int

The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

SubscribedWorkteam

Description

Describes a work team of a vendor that does the a labelling job.

Members

ListingId

Type: string

MarketplaceDescription

Type: string

The description of the vendor from the Amazon Marketplace.

MarketplaceTitle

Type: string

The title of the service provided by the vendor in the Amazon Marketplace.

SellerName

Type: string

The name of the vendor in the Amazon Marketplace.

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

SuggestionQuery

Description

Limits the property names that are included in the response.

Members

PropertyNameQuery

Type: PropertyNameQuery structure

A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response.

Tag

Description

Describes a tag.

Members

Key

Required: Yes

Type: string

The tag key.

Value

Required: Yes

Type: string

The tag value.

TrainingJob

Description

Contains information about a training job.

Members

AlgorithmSpecification

Type: AlgorithmSpecification structure

Information about the algorithm used for training, and algorithm metadata.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the training job was created.

EnableInterContainerTrafficEncryption

Type: boolean

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

EnableNetworkIsolation

Type: boolean

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

FailureReason

Type: string

If the training job failed, the reason it failed.

FinalMetricDataList

Type: Array of MetricData structures

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

HyperParameters

Type: Associative array of custom strings keys (ParameterKey) to strings

Algorithm-specific parameters.

InputDataConfig

Type: Array of Channel structures

An array of Channel objects that describes each data input channel.

LabelingJobArn

Type: string

The Amazon Resource Name (ARN) of the labeling job.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the status of the training job was last modified.

ModelArtifacts

Type: ModelArtifacts structure

Information about the Amazon S3 location that is configured for storing model artifacts.

OutputDataConfig

Type: OutputDataConfig structure

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

ResourceConfig

Type: ResourceConfig structure

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

RoleArn

Type: string

The AWS Identity and Access Management (IAM) role configured for the training job.

SecondaryStatus

Type: string

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

Starting - Starting the training job.

Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

Training - Training is in progress.

Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

Completed - The training job has completed.

Failed

Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

Stopped - The training job has stopped.

Stopping

Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

LaunchingMLInstances

PreparingTrainingStack

DownloadingTrainingImage

SecondaryStatusTransitions

Type: Array of SecondaryStatusTransition structures

A history of all of the secondary statuses that the training job has transitioned through.

StoppingCondition

Type: StoppingCondition structure

Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Tags

Type: Array of Tag structures

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

TrainingEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

TrainingJobArn

Type: string

The Amazon Resource Name (ARN) of the training job.

TrainingJobName

Type: string

The name of the training job.

TrainingJobStatus

Type: string

The status of the training job.

Training job statuses are:

InProgress - The training is in progress.

Completed - The training job has completed.

Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

Stopping - The training job is stopping.

Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

TrainingStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

TuningJobArn

Type: string

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

VpcConfig

Type: VpcConfig structure

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

TrainingJobDefinition

Description

Defines the input needed to run a training job using the algorithm.

Members

HyperParameters

Type: Associative array of custom strings keys (ParameterKey) to strings

The hyperparameters used for the training job.

InputDataConfig

Required: Yes

Type: Array of Channel structures

An array of Channel objects, each of which specifies an input source.

OutputDataConfig

Required: Yes

Type: OutputDataConfig structure

the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

ResourceConfig

Required: Yes

Type: ResourceConfig structure

The resources, including the ML compute instances and ML storage volumes, to use for model training.

StoppingCondition

Required: Yes

Type: StoppingCondition structure

Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

TrainingInputMode

Required: Yes

Type: string

The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

TrainingJobStatusCounters

Description

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

Members

Completed

Type: int

The number of completed training jobs launched by the hyperparameter tuning job.

InProgress

Type: int

The number of in-progress training jobs launched by a hyperparameter tuning job.

NonRetryableError

Type: int

The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

RetryableError

Type: int

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

Stopped

Type: int

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

TrainingJobSummary

Description

Provides summary information about a training job.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the training job was created.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp when the training job was last modified.

TrainingEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

TrainingJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the training job.

TrainingJobName

Required: Yes

Type: string

The name of the training job that you want a summary for.

TrainingJobStatus

Required: Yes

Type: string

The status of the training job.

TrainingSpecification

Description

Defines how the algorithm is used for a training job.

Members

MetricDefinitions

Type: Array of MetricDefinition structures

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

SupportedHyperParameters

Type: Array of HyperParameterSpecification structures

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

SupportedTrainingInstanceTypes

Required: Yes

Type: Array of strings

A list of the instance types that this algorithm can use for training.

SupportedTuningJobObjectiveMetrics

Type: Array of HyperParameterTuningJobObjective structures

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

SupportsDistributedTraining

Type: boolean

Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.

TrainingChannels

Required: Yes

Type: Array of ChannelSpecification structures

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

TrainingImage

Required: Yes

Type: string

The Amazon ECR registry path of the Docker image that contains the training algorithm.

TrainingImageDigest

Type: string

An MD5 hash of the training algorithm that identifies the Docker image used for training.

TransformDataSource

Description

Describes the location of the channel data.

Members

S3DataSource

Required: Yes

Type: TransformS3DataSource structure

The S3 location of the data source that is associated with a channel.

TransformInput

Description

Describes the input source of a transform job and the way the transform job consumes it.

Members

CompressionType

Type: string

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

ContentType

Type: string

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

DataSource

Required: Yes

Type: TransformDataSource structure

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

SplitType

Type: string

The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

TransformJobDefinition

Description

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

Members

BatchStrategy

Type: string

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

Environment

Type: Associative array of custom strings keys (TransformEnvironmentKey) to strings

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

MaxConcurrentTransforms

Type: int

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

MaxPayloadInMB

Type: int

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

TransformInput

Required: Yes

Type: TransformInput structure

A description of the input source and the way the transform job consumes it.

TransformOutput

Required: Yes

Type: TransformOutput structure

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

TransformResources

Required: Yes

Type: TransformResources structure

Identifies the ML compute instances for the transform job.

TransformJobSummary

Description

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

Members

CreationTime

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that shows when the transform Job was created.

FailureReason

Type: string

If the transform job failed, the reason it failed.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates when the transform job was last modified.

TransformEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

TransformJobArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the transform job.

TransformJobName

Required: Yes

Type: string

The name of the transform job.

TransformJobStatus

Required: Yes

Type: string

The status of the transform job.

TransformOutput

Description

Describes the results of a transform job.

Members

Accept

Type: string

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

AssembleWith

Type: string

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

KmsKeyId

Type: string

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

// KMS Key ID

"1234abcd-12ab-34cd-56ef-1234567890ab"

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

// KMS Key Alias

"alias/ExampleAlias"

// Amazon Resource Name (ARN) of a KMS Key Alias

"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

S3OutputPath

Required: Yes

Type: string

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

TransformResources

Description

Describes the resources, including ML instance types and ML instance count, to use for transform job.

Members

InstanceCount

Required: Yes

Type: int

The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

InstanceType

Required: Yes

Type: string

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

VolumeKmsKeyId

Type: string

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

// KMS Key ID

"1234abcd-12ab-34cd-56ef-1234567890ab"

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

TransformS3DataSource

Description

Describes the S3 data source.

Members

S3DataType

Required: Yes

Type: string

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

S3Uri

Required: Yes

Type: string

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

A key name prefix might look like this: s3://bucketname/exampleprefix.

A manifest might look like this: s3://bucketname/example.manifest

The manifest is an S3 object which is a JSON file with the following format:

[

{"prefix": "s3://customer_bucket/some/prefix/"},

"relative/path/to/custdata-1",

"relative/path/custdata-2",

...

]

The preceding JSON matches the following S3Uris:

s3://customer_bucket/some/prefix/relative/path/to/custdata-1

s3://customer_bucket/some/prefix/relative/path/custdata-1

...

The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

USD

Description

Represents an amount of money in United States dollars/

Members

Cents

Type: int

The fractional portion, in cents, of the amount.

Dollars

Type: int

The whole number of dollars in the amount.

TenthFractionsOfACent

Type: int

Fractions of a cent, in tenths.

UiConfig

Description

Provided configuration information for the worker UI for a labeling job.

Members

UiTemplateS3Uri

Required: Yes

Type: string

The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

UiTemplate

Description

The Liquid template for the worker user interface.

Members

Content

Required: Yes

Type: string

The content of the Liquid template for the worker user interface.

VpcConfig

Description

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Members

SecurityGroupIds

Required: Yes

Type: Array of strings

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

Subnets

Required: Yes

Type: Array of strings

The ID of the subnets in the VPC to which you want to connect your training job or model.

Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.

Workteam

Description

Provides details about a labeling work team.

Members

CreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the work team was created (timestamp).

Description

Required: Yes

Type: string

A description of the work team.

LastUpdatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the work team was last updated (timestamp).

MemberDefinitions

Required: Yes

Type: Array of MemberDefinition structures

The Amazon Cognito user groups that make up the work team.

NotificationConfiguration

Type: NotificationConfiguration structure

Configures SNS notifications of available or expiring work items for work teams.

ProductListingIds

Type: Array of strings

The Amazon Marketplace identifier for a vendor's work team.

SubDomain

Type: string

The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

WorkteamArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) that identifies the work team.

WorkteamName

Required: Yes

Type: string

The name of the work team.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon SageMaker Service 2017-07-24

Operation Summary

Paginators

Waiters

Operations

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAlgorithm

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCodeRepository

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCompilationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEndpointConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateHyperParameterTuningJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLabelingJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateModel

Parameter Syntax

Parameter Details

Members

Result Syntax