2026/11/09 - Amazon SageMaker Service - 5 new11 updated api methods
Changes Adds support for pipelines that AWS manages, filter ListPipelines by ManagedBy and run them with your own role via RoleArn on StartPipelineExecution. Adds pipeline version aliases to reference versions by name. Adds HubContent step metadata to ListPipelineExecutionSteps.
Deletes an extension from a SageMaker HyperPod cluster. SageMaker HyperPod removes the extension's software from every node in the cluster. While SageMaker HyperPod removes the extension, its status is Deleting. After SageMaker HyperPod removes the extension from all nodes, it no longer appears in ListClusterExtensions, and DescribeClusterExtension returns a ResourceNotFound error.
Deleting an extension doesn't delete data that the extension sent to other Amazon Web Services services, such as metrics in Amazon CloudWatch or Amazon Managed Service for Prometheus.
See also: AWS API Documentation
Request Syntax
client.delete_cluster_extension(
ClusterArn='string',
ExtensionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the extension to delete.
dict
Response Syntax
{
'ExtensionArn': 'string'
}
Response Structure
(dict) --
ExtensionArn (string) --
The Amazon Resource Name (ARN) of the extension that is being deleted.
Retrieves information about an extension installed on a SageMaker HyperPod cluster. The information includes the extension's version, configuration, and status, and a summary of how many cluster nodes are running the current version and configuration of the extension.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_extension(
ClusterArn='string',
ExtensionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the extension to describe. CreateClusterExtension returns this ARN, and ListClusterExtensions lists it. If you delete an extension and create it again, the new extension has a new ARN.
dict
Response Syntax
{
'ExtensionDetails': {
'ClusterArn': 'string',
'ExtensionArn': 'string',
'ExtensionName': 'string',
'ExtensionVersion': 'string',
'Status': 'Creating'|'Active'|'CreateFailed'|'Updating'|'Deleting'|'DeleteFailed'|'Degraded'|'UpdateFailed',
'ConfigurationValues': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
'NodeSummary': {
'TotalCount': 123,
'ActiveCount': 123
}
}
Response Structure
(dict) --
ExtensionDetails (dict) --
The details of the extension.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.
ExtensionArn (string) --
The Amazon Resource Name (ARN) of the extension.
ExtensionName (string) --
The name of the extension.
ExtensionVersion (string) --
The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary.
Status (string) --
The status of the extension can be one of the following values:
Creating
SageMaker HyperPod is installing the extension on the cluster's nodes.
Active
The extension runs its current version and configuration on all of the cluster's nodes.
Updating
SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.
Degraded
The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.
CreateFailed
SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.
UpdateFailed
SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.
Deleting
SageMaker HyperPod is removing the extension from the cluster's nodes.
DeleteFailed
SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.
ConfigurationValues (string) --
The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn't specify.
CreationTime (datetime) --
The time when the extension was created.
LastModifiedTime (datetime) --
The time when the extension was last updated.
NodeSummary (dict) --
A summary of how many nodes in your cluster the extension targets, and how many of them run the extension's current version and configuration.
TotalCount (integer) --
The number of nodes in your cluster that the extension targets. SageMaker HyperPod targets every running node in your cluster, including nodes that you add after you create the extension.
ActiveCount (integer) --
The number of nodes that are running the extension's current version and configuration. While SageMaker HyperPod creates or updates the extension, ActiveCount is lower than TotalCount.
Updates the configuration or the version of an extension installed on a SageMaker HyperPod cluster. SageMaker HyperPod applies the change to every node in the cluster. You can change the configuration, the version, or both in one request.
Configuration: You can change settings by sending ConfigurationValues. Settings that you include are changed. Settings that you omit keep their current values. A setting with the value null is removed and returns to its default value.
Version: You can update to a later version. You can't update to an earlier version. To use an earlier version, delete the extension and create it again with that version.
You can't update an extension while it is being deleted.
See also: AWS API Documentation
Request Syntax
client.update_cluster_extension(
ClusterArn='string',
ExtensionArn='string',
ExtensionVersion='string',
ConfigurationValues='string',
ClientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the extension to update.
string
The version to update the extension to, in MAJOR.MINOR.PATCH format. The version must be later than the extension's current version. If you omit this parameter, the extension keeps its current version.
string
The configuration changes to apply, as a JSON object serialized as a string. Settings that you include are changed, settings that you omit are unchanged, and a setting with the value null returns to its default value. The resulting configuration must be valid for the target extension version. If you omit ConfigurationValues, the configuration is unchanged.
string
A unique, case-sensitive identifier that you provide so that the request is idempotent. If you send the same update more than once, SageMaker HyperPod applies it once and doesn't return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ExtensionArn': 'string'
}
Response Structure
(dict) --
ExtensionArn (string) --
The Amazon Resource Name (ARN) of the extension that is being updated. To track the update, call DescribeClusterExtension.
Lists the extensions installed on a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.list_cluster_extensions(
ClusterArn='string',
MaxResults=123,
NextToken='string',
CreationTimeAfter=datetime(2015, 1, 1),
CreationTimeBefore=datetime(2015, 1, 1)
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster whose extensions you want to list.
integer
The maximum number of extensions to return in the response. If you don't specify a value, SageMaker HyperPod returns up to 100 extensions.
string
If the result of the previous ListClusterExtensions request was truncated, the response includes a NextToken. To retrieve the next set of extensions, use the token in the next request. When you use the CreationTimeAfter or CreationTimeBefore filters, a response can contain fewer extensions than MaxResults, or none, and still include a NextToken. Continue until the response doesn't include a NextToken.
datetime
A filter that returns extensions created at or after the specified time. Timestamps are formatted according to the ISO 8601 standard.
datetime
A filter that returns extensions created at or before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter.
dict
Response Syntax
{
'Extensions': [
{
'ExtensionArn': 'string',
'ExtensionName': 'string',
'ExtensionVersion': 'string',
'Status': 'Creating'|'Active'|'CreateFailed'|'Updating'|'Deleting'|'DeleteFailed'|'Degraded'|'UpdateFailed',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Extensions (list) --
The list of extensions installed on the cluster.
(dict) --
A summary of an extension installed on a SageMaker HyperPod cluster.
ExtensionArn (string) --
The Amazon Resource Name (ARN) of the extension.
ExtensionName (string) --
The name of the extension.
ExtensionVersion (string) --
The version of the extension.
Status (string) --
The status of the extension. For the meaning of each status, see ExtensionDetails.
CreationTime (datetime) --
The time when the extension was created.
NextToken (string) --
The next token specified for listing extensions on a SageMaker HyperPod cluster.
Installs an extension, such as sagemaker-observability, on a SageMaker HyperPod cluster orchestrated by Slurm. The cluster must have NodeProvisioningMode set to Continuous and can have only one extension with a given name. To track the installation, call DescribeClusterExtension.
See also: AWS API Documentation
Request Syntax
client.create_cluster_extension(
ClusterArn='string',
ExtensionName='string',
ExtensionVersion='string',
ConfigurationValues='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which to install the extension. The cluster must use Slurm as the orchestrator and have NodeProvisioningMode set to Continuous.
string
[REQUIRED]
The name of the extension to install, for example sagemaker-observability.
string
The version of the extension to install, in MAJOR.MINOR.PATCH format, for example 1.0.0. If you don't specify a version, SageMaker HyperPod installs the latest available version of the extension.
string
The configuration settings for the extension, as a JSON object serialized as a string, for example {"metricsProvider":{"nodeMetrics":{"level":"ADVANCED"}}}. Each extension version defines which settings it accepts. SageMaker HyperPod validates the settings against that definition, and rejects the request if a setting is unknown or has an invalid value. Settings that you omit use the extension's default values. If you omit ConfigurationValues, all settings use their default values.
list
Custom tags for managing the extension as an Amazon Web Services resource. You can add tags to your extension in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide. To use this operation to add tags when you create an extension, you must have the sagemaker:AddTags permission.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
string
A unique, case-sensitive identifier that you provide so that the operation completes no more than one time. This token is valid for 8 hours. If you retry the request with the same client token and the same parameters within this time, the API returns the Amazon Resource Name (ARN) of the extension that the original request created, without creating a duplicate. If you use the same client token with different parameters, the request fails.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ExtensionArn': 'string'
}
Response Structure
(dict) --
ExtensionArn (string) --
The Amazon Resource Name (ARN) of the extension that you created. Use this ARN to describe, update, or delete the extension.
{'PipelineVersionAliases': ['string']}
Creates a pipeline using a JSON pipeline definition.
See also: AWS API Documentation
Request Syntax
client.create_pipeline(
PipelineName='string',
PipelineDisplayName='string',
PipelineDefinition='string',
PipelineDefinitionS3Location={
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
PipelineDescription='string',
ClientRequestToken='string',
RoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ParallelismConfiguration={
'MaxParallelExecutionSteps': 123
},
PipelineVersionAliases=[
'string',
]
)
string
[REQUIRED]
The name of the pipeline.
string
The display name of the pipeline.
string
The JSON pipeline definition of the pipeline.
dict
The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
Bucket (string) -- [REQUIRED]
Name of the S3 bucket.
ObjectKey (string) -- [REQUIRED]
The object key (or key name) uniquely identifies the object in an S3 bucket.
VersionId (string) --
Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
string
A description of the pipeline.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
list
A list of tags to apply to the created pipeline.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
MaxParallelExecutionSteps (integer) -- [REQUIRED]
The max number of steps that can be executed in parallel.
list
The aliases to assign to the first version of the pipeline. You can use an alias instead of a pipeline version ID to start an execution, describe the pipeline, or list its executions. Each alias can contain 1-128 letters, numbers, periods (.), hyphens (-), and underscores (_), and can't consist of numbers only. An alias must be unique within the pipeline, and a version can have up to 10 aliases.
(string) --
dict
Response Syntax
{
'PipelineArn': 'string'
}
Response Structure
(dict) --
PipelineArn (string) --
The Amazon Resource Name (ARN) of the created pipeline.
{'PipelineVersionAlias': 'string'}
Response {'PipelineVersionAliases': ['string']}
Describes the details of a pipeline.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline(
PipelineName='string',
PipelineVersionId=123,
PipelineVersionAlias='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the pipeline to describe.
integer
The ID of the pipeline version to describe. You can't specify this with PipelineVersionAlias.
string
The alias of the pipeline version to describe. You can't specify this with PipelineVersionId. If no version of the pipeline has this alias, the request fails with a ResourceNotFound error. If you specify neither, SageMaker describes the latest version of the pipeline.
dict
Response Syntax
{
'PipelineArn': 'string',
'PipelineName': 'string',
'PipelineDisplayName': 'string',
'PipelineDefinition': 'string',
'PipelineDescription': 'string',
'RoleArn': 'string',
'PipelineStatus': 'Active'|'Deleting',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastRunTime': datetime(2015, 1, 1),
'CreatedBy': {
'UserProfileArn': 'string',
'UserProfileName': 'string',
'DomainId': 'string',
'IamIdentity': {
'Arn': 'string',
'PrincipalId': 'string',
'SourceIdentity': 'string'
}
},
'LastModifiedBy': {
'UserProfileArn': 'string',
'UserProfileName': 'string',
'DomainId': 'string',
'IamIdentity': {
'Arn': 'string',
'PrincipalId': 'string',
'SourceIdentity': 'string'
}
},
'ParallelismConfiguration': {
'MaxParallelExecutionSteps': 123
},
'PipelineVersionDisplayName': 'string',
'PipelineVersionDescription': 'string',
'PipelineVersionAliases': [
'string',
]
}
Response Structure
(dict) --
PipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
PipelineName (string) --
The name of the pipeline.
PipelineDisplayName (string) --
The display name of the pipeline.
PipelineDefinition (string) --
The JSON pipeline definition.
PipelineDescription (string) --
The description of the pipeline.
RoleArn (string) --
The Amazon Resource Name (ARN) that the pipeline uses to execute.
PipelineStatus (string) --
The status of the pipeline execution.
CreationTime (datetime) --
The time when the pipeline was created.
LastModifiedTime (datetime) --
The time when the pipeline was last modified.
LastRunTime (datetime) --
The time when the pipeline was last run.
CreatedBy (dict) --
Information about the user who created or modified a SageMaker resource.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
IamIdentity (dict) --
The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
Arn (string) --
The Amazon Resource Name (ARN) of the IAM identity.
PrincipalId (string) --
The ID of the principal that assumes the IAM identity.
SourceIdentity (string) --
The person or application which assumes the IAM identity.
LastModifiedBy (dict) --
Information about the user who created or modified a SageMaker resource.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
IamIdentity (dict) --
The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
Arn (string) --
The Amazon Resource Name (ARN) of the IAM identity.
PrincipalId (string) --
The ID of the principal that assumes the IAM identity.
SourceIdentity (string) --
The person or application which assumes the IAM identity.
ParallelismConfiguration (dict) --
Lists the parallelism configuration applied to the pipeline.
MaxParallelExecutionSteps (integer) --
The max number of steps that can be executed in parallel.
PipelineVersionDisplayName (string) --
The display name of the pipeline version.
PipelineVersionDescription (string) --
The description of the pipeline version.
PipelineVersionAliases (list) --
The aliases assigned to the pipeline version.
(string) --
{'PipelineVersionAliases': ['string'], 'RoleArn': 'string'}
Describes the details of a pipeline execution.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline_execution(
PipelineExecutionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the pipeline execution.
dict
Response Syntax
{
'PipelineArn': 'string',
'PipelineExecutionArn': 'string',
'PipelineExecutionDisplayName': 'string',
'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded'|'CompletedWithFailures',
'PipelineExecutionDescription': 'string',
'PipelineExperimentConfig': {
'ExperimentName': 'string',
'TrialName': 'string'
},
'FailureReason': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedBy': {
'UserProfileArn': 'string',
'UserProfileName': 'string',
'DomainId': 'string',
'IamIdentity': {
'Arn': 'string',
'PrincipalId': 'string',
'SourceIdentity': 'string'
}
},
'LastModifiedBy': {
'UserProfileArn': 'string',
'UserProfileName': 'string',
'DomainId': 'string',
'IamIdentity': {
'Arn': 'string',
'PrincipalId': 'string',
'SourceIdentity': 'string'
}
},
'ParallelismConfiguration': {
'MaxParallelExecutionSteps': 123
},
'SelectiveExecutionConfig': {
'SourcePipelineExecutionArn': 'string',
'SelectedSteps': [
{
'StepName': 'string'
},
]
},
'PipelineVersionId': 123,
'MLflowConfig': {
'MlflowResourceArn': 'string',
'MlflowExperimentName': 'string'
},
'PipelineVersionAliases': [
'string',
],
'RoleArn': 'string'
}
Response Structure
(dict) --
PipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
PipelineExecutionArn (string) --
The Amazon Resource Name (ARN) of the pipeline execution.
PipelineExecutionDisplayName (string) --
The display name of the pipeline execution.
PipelineExecutionStatus (string) --
The status of the pipeline execution.
PipelineExecutionDescription (string) --
The description of the pipeline execution.
PipelineExperimentConfig (dict) --
Specifies the names of the experiment and trial created by a pipeline.
ExperimentName (string) --
The name of the experiment.
TrialName (string) --
The name of the trial.
FailureReason (string) --
If the execution failed, a message describing why.
CreationTime (datetime) --
The time when the pipeline execution was created.
LastModifiedTime (datetime) --
The time when the pipeline execution was modified last.
CreatedBy (dict) --
Information about the user who created or modified a SageMaker resource.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
IamIdentity (dict) --
The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
Arn (string) --
The Amazon Resource Name (ARN) of the IAM identity.
PrincipalId (string) --
The ID of the principal that assumes the IAM identity.
SourceIdentity (string) --
The person or application which assumes the IAM identity.
LastModifiedBy (dict) --
Information about the user who created or modified a SageMaker resource.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
IamIdentity (dict) --
The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
Arn (string) --
The Amazon Resource Name (ARN) of the IAM identity.
PrincipalId (string) --
The ID of the principal that assumes the IAM identity.
SourceIdentity (string) --
The person or application which assumes the IAM identity.
ParallelismConfiguration (dict) --
The parallelism configuration applied to the pipeline.
MaxParallelExecutionSteps (integer) --
The max number of steps that can be executed in parallel.
SelectiveExecutionConfig (dict) --
The selective execution configuration applied to the pipeline run.
SourcePipelineExecutionArn (string) --
The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.
This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.
SelectedSteps (list) --
A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
(dict) --
A step selected to run in selective execution mode.
StepName (string) --
The name of the pipeline step.
PipelineVersionId (integer) --
The ID of the pipeline version.
MLflowConfig (dict) --
The MLflow configuration of the pipeline execution.
MlflowResourceArn (string) --
The Amazon Resource Name (ARN) of MLflow configuration resource.
MlflowExperimentName (string) --
The name of the MLflow configuration.
PipelineVersionAliases (list) --
The aliases currently assigned to the pipeline version that the execution ran.
(string) --
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the execution uses. SageMaker returns this value only for executions of pipelines that AWS manages.
{'PipelineExecutionSteps': {'Metadata': {'HubContent': {'HubArn': 'string',
'HubContentArn': 'string'}}}}
Gets a list of PipeLineExecutionStep objects.
See also: AWS API Documentation
Request Syntax
client.list_pipeline_execution_steps(
PipelineExecutionArn='string',
NextToken='string',
MaxResults=123,
SortOrder='Ascending'|'Descending'
)
string
The Amazon Resource Name (ARN) of the pipeline execution.
string
If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
integer
The maximum number of pipeline execution steps to return in the response.
string
The field by which to sort results. The default is CreatedTime.
dict
Response Syntax
{
'PipelineExecutionSteps': [
{
'StepName': 'string',
'StepDisplayName': 'string',
'StepDescription': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'StepStatus': 'Starting'|'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
'CacheHitResult': {
'SourcePipelineExecutionArn': 'string'
},
'FailureReason': 'string',
'Metadata': {
'TrainingJob': {
'Arn': 'string'
},
'ProcessingJob': {
'Arn': 'string'
},
'TransformJob': {
'Arn': 'string'
},
'TuningJob': {
'Arn': 'string'
},
'Model': {
'Arn': 'string'
},
'RegisterModel': {
'Arn': 'string'
},
'Condition': {
'Outcome': 'True'|'False'
},
'Callback': {
'CallbackToken': 'string',
'SqsQueueUrl': 'string',
'OutputParameters': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Lambda': {
'Arn': 'string',
'OutputParameters': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'EMR': {
'ClusterId': 'string',
'StepId': 'string',
'StepName': 'string',
'LogFilePath': 'string'
},
'EMRServerless': {
'ApplicationId': 'string',
'JobRunId': 'string',
'JobRunName': 'string',
'LogFilePath': 'string'
},
'QualityCheck': {
'CheckType': 'string',
'BaselineUsedForDriftCheckStatistics': 'string',
'BaselineUsedForDriftCheckConstraints': 'string',
'CalculatedBaselineStatistics': 'string',
'CalculatedBaselineConstraints': 'string',
'ModelPackageGroupName': 'string',
'ViolationReport': 'string',
'CheckJobArn': 'string',
'SkipCheck': True|False,
'RegisterNewBaseline': True|False
},
'ClarifyCheck': {
'CheckType': 'string',
'BaselineUsedForDriftCheckConstraints': 'string',
'CalculatedBaselineConstraints': 'string',
'ModelPackageGroupName': 'string',
'ViolationReport': 'string',
'CheckJobArn': 'string',
'SkipCheck': True|False,
'RegisterNewBaseline': True|False
},
'Fail': {
'ErrorMessage': 'string'
},
'AutoMLJob': {
'Arn': 'string'
},
'Endpoint': {
'Arn': 'string'
},
'EndpointConfig': {
'Arn': 'string'
},
'BedrockCustomModel': {
'Arn': 'string'
},
'BedrockCustomModelDeployment': {
'Arn': 'string'
},
'BedrockProvisionedModelThroughput': {
'Arn': 'string'
},
'BedrockModelImport': {
'Arn': 'string'
},
'InferenceComponent': {
'Arn': 'string'
},
'Lineage': {
'ActionArns': {
'string': 'string'
},
'ArtifactArns': {
'string': 'string'
},
'ContextArns': {
'string': 'string'
},
'Associations': [
{
'SourceArn': 'string',
'DestinationArn': 'string'
},
]
},
'Job': {
'Arn': 'string'
},
'Athena': {
'QueryExecutionId': 'string',
'S3OutputLocation': 'string'
},
'Cleanup': {
'CleanedSteps': [
'string',
],
'FailedSteps': [
{
'StepName': 'string',
'ErrorCode': 'ClientError'|'InternalFailure',
'ErrorMessage': 'string'
},
],
'SkippedSteps': [
'string',
]
},
'ForEach': {
'Status': 'Succeeded'|'Failed'|'Stopped',
'InputItemCount': 123,
'TotalStepCount': 123,
'SucceededStepCount': 123,
'FailedStepCount': 123,
'StoppedStepCount': 123,
'Selector': {
'StepName': 'string',
'Index': 123
}
},
'HubContent': {
'HubArn': 'string',
'HubContentArn': 'string'
}
},
'AttemptCount': 123,
'SelectiveExecutionResult': {
'SourcePipelineExecutionArn': 'string'
},
'IterationContext': {
'ParentStepName': 'string',
'Index': 123,
'Item': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PipelineExecutionSteps (list) --
A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.
(dict) --
An execution of a step in a pipeline.
StepName (string) --
The name of the step that is executed.
StepDisplayName (string) --
The display name of the step.
StepDescription (string) --
The description of the step.
StartTime (datetime) --
The time that the step started executing.
EndTime (datetime) --
The time that the step stopped executing.
StepStatus (string) --
The status of the step execution.
CacheHitResult (dict) --
If this pipeline execution step was cached, details on the cache hit.
SourcePipelineExecutionArn (string) --
The Amazon Resource Name (ARN) of the pipeline execution.
FailureReason (string) --
The reason why the step failed execution. This is only returned if the step failed its execution.
Metadata (dict) --
Metadata to run the pipeline step.
TrainingJob (dict) --
The Amazon Resource Name (ARN) of the training job that was run by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the training job that was run by this step execution.
ProcessingJob (dict) --
The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the processing job.
TransformJob (dict) --
The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
TuningJob (dict) --
The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
Model (dict) --
The Amazon Resource Name (ARN) of the model that was created by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the created model.
RegisterModel (dict) --
The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the model package.
Condition (dict) --
The outcome of the condition evaluation that was run by this step execution.
Outcome (string) --
The outcome of the Condition step evaluation.
Callback (dict) --
The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
CallbackToken (string) --
The pipeline generated token from the Amazon SQS queue.
SqsQueueUrl (string) --
The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.
OutputParameters (list) --
A list of the output parameters of the callback step.
(dict) --
An output parameter of a pipeline step.
Name (string) --
The name of the output parameter.
Value (string) --
The value of the output parameter.
Lambda (dict) --
The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
Arn (string) --
The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
OutputParameters (list) --
A list of the output parameters of the Lambda step.
(dict) --
An output parameter of a pipeline step.
Name (string) --
The name of the output parameter.
Value (string) --
The value of the output parameter.
EMR (dict) --
The configurations and outcomes of an Amazon EMR step execution.
ClusterId (string) --
The identifier of the EMR cluster.
StepId (string) --
The identifier of the EMR cluster step.
StepName (string) --
The name of the EMR cluster step.
LogFilePath (string) --
The path to the log file where the cluster step's failure root cause is recorded.
EMRServerless (dict) --
The configurations and outcomes of an Amazon EMR Serverless step execution.
ApplicationId (string) --
The identifier of the Amazon EMR Serverless application.
JobRunId (string) --
The identifier of the Amazon EMR Serverless job run.
JobRunName (string) --
The name of the Amazon EMR Serverless job run.
LogFilePath (string) --
The path to the log file for the Amazon EMR Serverless job run.
QualityCheck (dict) --
The configurations and outcomes of the check step execution. This includes:
The type of the check conducted.
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The Boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
CheckType (string) --
The type of the Quality check step.
BaselineUsedForDriftCheckStatistics (string) --
The Amazon S3 URI of the baseline statistics file used for the drift check.
BaselineUsedForDriftCheckConstraints (string) --
The Amazon S3 URI of the baseline constraints file used for the drift check.
CalculatedBaselineStatistics (string) --
The Amazon S3 URI of the newly calculated baseline statistics file.
CalculatedBaselineConstraints (string) --
The Amazon S3 URI of the newly calculated baseline constraints file.
ModelPackageGroupName (string) --
The model package group name.
ViolationReport (string) --
The Amazon S3 URI of violation report if violations are detected.
CheckJobArn (string) --
The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
SkipCheck (boolean) --
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
RegisterNewBaseline (boolean) --
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.
ClarifyCheck (dict) --
Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:
The type of the check conducted,
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
CheckType (string) --
The type of the Clarify Check step
BaselineUsedForDriftCheckConstraints (string) --
The Amazon S3 URI of baseline constraints file to be used for the drift check.
CalculatedBaselineConstraints (string) --
The Amazon S3 URI of the newly calculated baseline constraints file.
ModelPackageGroupName (string) --
The model package group name.
ViolationReport (string) --
The Amazon S3 URI of the violation report if violations are detected.
CheckJobArn (string) --
The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
SkipCheck (boolean) --
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
RegisterNewBaseline (boolean) --
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.
Fail (dict) --
The configurations and outcomes of a Fail step execution.
ErrorMessage (string) --
A message that you define and then is processed and rendered by the Fail step when the error occurs.
AutoMLJob (dict) --
The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
Arn (string) --
The Amazon Resource Name (ARN) of the AutoML job.
Endpoint (dict) --
The endpoint that was invoked during this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the endpoint in the step.
EndpointConfig (dict) --
The endpoint configuration used to create an endpoint during this step execution.
Arn (string) --
The Amazon Resource Name (ARN) of the endpoint configuration used in the step.
BedrockCustomModel (dict) --
The metadata of the Amazon Bedrock custom model used in the pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock custom model.
BedrockCustomModelDeployment (dict) --
The metadata of the Amazon Bedrock custom model deployment used in pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) for the Amazon Bedrock custom model deployment.
BedrockProvisionedModelThroughput (dict) --
The metadata of the Amazon Bedrock provisioned model throughput used in the pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock provisioned model throughput.
BedrockModelImport (dict) --
The metadata of Amazon Bedrock model import used in pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock model import.
InferenceComponent (dict) --
The metadata of the inference component used in pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) of the inference component.
Lineage (dict) --
The metadata of the lineage used in pipeline execution step.
ActionArns (dict) --
The Amazon Resource Name (ARN) of the lineage action.
(string) --
(string) --
ArtifactArns (dict) --
The Amazon Resource Name (ARN) of the lineage artifact.
(string) --
(string) --
ContextArns (dict) --
The Amazon Resource Name (ARN) of the lineage context.
(string) --
(string) --
Associations (list) --
The lineage associations.
(dict) --
The data type used to describe the relationship between different sources.
SourceArn (string) --
The Amazon Resource Name (ARN) of the AssociationInfo source.
DestinationArn (string) --
The Amazon Resource Name (ARN) of the AssociationInfo destination.
Job (dict) --
The metadata for a SageMaker job used in a pipeline execution step.
Arn (string) --
The Amazon Resource Name (ARN) of the SageMaker job that was run by this step execution.
Athena (dict) --
The metadata for the Athena step execution.
QueryExecutionId (string) --
The unique identifier of the Amazon Athena query execution that was run by this step execution.
S3OutputLocation (string) --
The Amazon S3 location of the Amazon Athena query results. This is the effective output location reported by GetQueryExecution for the query. This value can be absent when the query uses Athena managed query results.
Cleanup (dict) --
The metadata for the cleanup step execution.
CleanedSteps (list) --
The names of upstream steps whose Amazon S3 output resources the Cleanup step deleted successfully.
(string) --
FailedSteps (list) --
The upstream steps whose Amazon S3 output resources the Cleanup step could not delete.
(dict) --
The Amazon S3 output resources associated with an upstream step that the Cleanup step could not delete.
StepName (string) --
The name of the upstream step whose Amazon S3 output resources the Cleanup step could not delete.
ErrorCode (string) --
The error code that identifies why the Cleanup step could not delete the output resources associated with the upstream step.
ErrorMessage (string) --
A message describing why the Cleanup step could not delete the output resources associated with the upstream step.
SkippedSteps (list) --
The names of upstream steps that the Cleanup step skipped. The Cleanup step skips a step when the output properties needed to locate its resources are unavailable.
(string) --
ForEach (dict) --
The metadata for the ForEach step execution.
Status (string) --
The status of the ForEach step execution.
InputItemCount (integer) --
The number of input items that the ForEach step iterates over.
TotalStepCount (integer) --
The total number of steps generated across all iterations of the ForEach step.
SucceededStepCount (integer) --
The number of iteration steps that completed successfully.
FailedStepCount (integer) --
The number of iteration steps that failed.
StoppedStepCount (integer) --
The number of iteration steps that were stopped.
Selector (dict) --
Identifies the body step and iteration selected within the ForEach step.
StepName (string) --
The name of the step associated with the iteration.
Index (integer) --
The index of the iteration within the ForEach step.
HubContent (dict) --
The metadata for the HubContent step execution.
HubArn (string) --
The Amazon Resource Name (ARN) of the hub that the step imported the content into.
HubContentArn (string) --
The Amazon Resource Name (ARN) of the hub content that was imported by this step execution.
AttemptCount (integer) --
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
SelectiveExecutionResult (dict) --
The ARN from an execution of the current pipeline from which results are reused for this step.
SourcePipelineExecutionArn (string) --
The ARN from an execution of the current pipeline.
IterationContext (dict) --
The context for the iteration of a ForEach step that generated this step execution.
ParentStepName (string) --
The name of the ForEach step that generated this iteration.
Index (integer) --
The index of the iteration within the ForEach step.
Item (string) --
The input item that is being processed in this iteration.
NextToken (string) --
If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
{'PipelineVersionAlias': 'string'}
Response {'PipelineExecutionSummaries': {'PipelineVersionAliases': ['string']}}
Gets a list of the pipeline executions.
See also: AWS API Documentation
Request Syntax
client.list_pipeline_executions(
PipelineName='string',
CreatedAfter=datetime(2015, 1, 1),
CreatedBefore=datetime(2015, 1, 1),
SortBy='CreationTime'|'PipelineExecutionArn',
SortOrder='Ascending'|'Descending',
NextToken='string',
MaxResults=123,
PipelineVersionAlias='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the pipeline.
datetime
A filter that returns the pipeline executions that were created after a specified time.
datetime
A filter that returns the pipeline executions that were created before a specified time.
string
The field by which to sort results. The default is CreatedTime.
string
The sort order for results.
string
If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
integer
The maximum number of pipeline executions to return in the response.
string
The alias of a pipeline version. The response includes only the executions of the version that has this alias when you make the request. If no version of the pipeline has this alias, the request fails with a ResourceNotFound error.
dict
Response Syntax
{
'PipelineExecutionSummaries': [
{
'PipelineExecutionArn': 'string',
'StartTime': datetime(2015, 1, 1),
'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded'|'CompletedWithFailures',
'PipelineExecutionDescription': 'string',
'PipelineExecutionDisplayName': 'string',
'PipelineExecutionFailureReason': 'string',
'PipelineVersionAliases': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PipelineExecutionSummaries (list) --
Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
(dict) --
A pipeline execution summary.
PipelineExecutionArn (string) --
The Amazon Resource Name (ARN) of the pipeline execution.
StartTime (datetime) --
The start time of the pipeline execution.
PipelineExecutionStatus (string) --
The status of the pipeline execution.
PipelineExecutionDescription (string) --
The description of the pipeline execution.
PipelineExecutionDisplayName (string) --
The display name of the pipeline execution.
PipelineExecutionFailureReason (string) --
A message generated by SageMaker Pipelines describing why the pipeline execution failed.
PipelineVersionAliases (list) --
The aliases currently assigned to the pipeline version that the execution ran.
(string) --
NextToken (string) --
If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
{'PipelineVersionSummaries': {'PipelineVersionAliases': ['string']}}
Gets a list of all versions of the pipeline.
See also: AWS API Documentation
Request Syntax
client.list_pipeline_versions(
PipelineName='string',
CreatedAfter=datetime(2015, 1, 1),
CreatedBefore=datetime(2015, 1, 1),
SortOrder='Ascending'|'Descending',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the pipeline.
datetime
A filter that returns the pipeline versions that were created after a specified time.
datetime
A filter that returns the pipeline versions that were created before a specified time.
string
The sort order for the results.
string
If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.
integer
The maximum number of pipeline versions to return in the response.
dict
Response Syntax
{
'PipelineVersionSummaries': [
{
'PipelineArn': 'string',
'PipelineVersionId': 123,
'CreationTime': datetime(2015, 1, 1),
'PipelineVersionDescription': 'string',
'PipelineVersionDisplayName': 'string',
'LastExecutionPipelineExecutionArn': 'string',
'PipelineVersionAliases': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PipelineVersionSummaries (list) --
Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.
(dict) --
The summary of the pipeline version.
PipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
PipelineVersionId (integer) --
The ID of the pipeline version.
CreationTime (datetime) --
The creation time of the pipeline version.
PipelineVersionDescription (string) --
The description of the pipeline version.
PipelineVersionDisplayName (string) --
The display name of the pipeline version.
LastExecutionPipelineExecutionArn (string) --
The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.
PipelineVersionAliases (list) --
The aliases assigned to the pipeline version.
(string) --
NextToken (string) --
If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.
{'ManagedBy': 'AWS | CUSTOMER'}
Gets a list of pipelines.
See also: AWS API Documentation
Request Syntax
client.list_pipelines(
PipelineNamePrefix='string',
CreatedAfter=datetime(2015, 1, 1),
CreatedBefore=datetime(2015, 1, 1),
SortBy='Name'|'CreationTime',
SortOrder='Ascending'|'Descending',
NextToken='string',
MaxResults=123,
ManagedBy='AWS'|'CUSTOMER'
)
string
The prefix of the pipeline name.
datetime
A filter that returns the pipelines that were created after a specified time.
datetime
A filter that returns the pipelines that were created before a specified time.
string
The field by which to sort results. The default is CreatedTime.
string
The sort order for results.
string
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
integer
The maximum number of pipelines to return in the response.
string
Filters the pipelines by who manages them. Specify AWS to return pipelines that AWS manages, or CUSTOMER to return pipelines that you created. If you don't specify a value, the response includes both.
dict
Response Syntax
{
'PipelineSummaries': [
{
'PipelineArn': 'string',
'PipelineName': 'string',
'PipelineDisplayName': 'string',
'PipelineDescription': 'string',
'RoleArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastExecutionTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PipelineSummaries (list) --
Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.
(dict) --
A summary of a pipeline.
PipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
PipelineName (string) --
The name of the pipeline.
PipelineDisplayName (string) --
The display name of the pipeline.
PipelineDescription (string) --
The description of the pipeline.
RoleArn (string) --
The Amazon Resource Name (ARN) that the pipeline used to execute.
CreationTime (datetime) --
The creation time of the pipeline.
LastModifiedTime (datetime) --
The time that the pipeline was last modified.
LastExecutionTime (datetime) --
The last time that a pipeline execution began.
NextToken (string) --
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
{'Results': {'PipelineVersion': {'PipelineVersionAliases': ['string']}}}
Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord 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: numeric, text, Boolean, and timestamp.
See also: AWS API Documentation
Request Syntax
client.search(
Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'Model'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'FeatureMetadata'|'Image'|'ImageVersion'|'Project'|'HyperParameterTuningJob'|'ModelCard'|'PipelineVersion'|'Job'|'HubContent',
SearchExpression={
'Filters': [
{
'Name': 'string',
'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In',
'Value': 'string'
},
],
'NestedFilters': [
{
'NestedPropertyName': 'string',
'Filters': [
{
'Name': 'string',
'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In',
'Value': 'string'
},
]
},
],
'SubExpressions': [
{'... recursive ...'},
],
'Operator': 'And'|'Or'
},
SortBy='string',
SortOrder='Ascending'|'Descending',
NextToken='string',
MaxResults=123,
CrossAccountFilterOption='SameAccount'|'CrossAccount',
VisibilityConditions=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the SageMaker resource to search for.
dict
A Boolean conditional statement. Resources 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.
Filters (list) --
A list of filter objects.
(dict) --
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value, but not an Operator, SageMaker uses the equals operator.
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": "GreaterThan",
"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": "LessThan",
"Value": "0.5"
}
Tags
To define a tag filter, enter a value with the form Tags.<key>.
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value.
NotEquals
The value of Name doesn't equal Value.
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value. Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value. Not supported for text properties.
LessThan
The value of Name is less than Value. Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value. Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
Contains
The value of Name contains the string Value. Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: " 'CONTAINS' operator usage limit of 1 exceeded."
Value (string) --
A value used with Name and Operator to determine which resources 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.
NestedFilters (list) --
A list of nested filter objects.
(dict) --
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:
'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}',
'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}'
NestedPropertyName (string) -- [REQUIRED]
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
Filters (list) -- [REQUIRED]
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.
(dict) --
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value, but not an Operator, SageMaker uses the equals operator.
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": "GreaterThan",
"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": "LessThan",
"Value": "0.5"
}
Tags
To define a tag filter, enter a value with the form Tags.<key>.
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value.
NotEquals
The value of Name doesn't equal Value.
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value. Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value. Not supported for text properties.
LessThan
The value of Name is less than Value. Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value. Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
Contains
The value of Name contains the string Value. Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: " 'CONTAINS' operator usage limit of 1 exceeded."
Value (string) --
A value used with Name and Operator to determine which resources 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.
SubExpressions (list) --
A list of search expression objects.
(dict) --
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.
Operator (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.
string
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
string
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
string
If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.
integer
The maximum number of results to return.
string
A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ``ResourceCatalog``s viewable is 1000.
list
Limits the results of your search request to the resources that you can access.
(dict) --
The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
Key (string) --
The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags.<key>.
Value (string) --
The value for the tag that you're using to filter the search results.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'PipelineVersionAlias': 'string', 'RoleArn': 'string'}
Starts a pipeline execution.
See also: AWS API Documentation
Request Syntax
client.start_pipeline_execution(
PipelineName='string',
PipelineExecutionDisplayName='string',
PipelineParameters=[
{
'Name': 'string',
'Value': 'string'
},
],
PipelineExecutionDescription='string',
ClientRequestToken='string',
ParallelismConfiguration={
'MaxParallelExecutionSteps': 123
},
SelectiveExecutionConfig={
'SourcePipelineExecutionArn': 'string',
'SelectedSteps': [
{
'StepName': 'string'
},
]
},
PipelineVersionId=123,
MlflowExperimentName='string',
PipelineVersionAlias='string',
RoleArn='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the pipeline.
string
The display name of the pipeline execution.
list
Contains a list of pipeline parameters. This list can be empty.
(dict) --
Assigns a value to a named Pipeline parameter.
Name (string) -- [REQUIRED]
The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
Value (string) -- [REQUIRED]
The literal value for the parameter.
string
The description of the pipeline execution.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
This field is autopopulated if not provided.
dict
This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
MaxParallelExecutionSteps (integer) -- [REQUIRED]
The max number of steps that can be executed in parallel.
dict
The selective execution configuration applied to the pipeline run.
SourcePipelineExecutionArn (string) --
The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.
This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.
SelectedSteps (list) -- [REQUIRED]
A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
(dict) --
A step selected to run in selective execution mode.
StepName (string) -- [REQUIRED]
The name of the pipeline step.
integer
The ID of the pipeline version to start execution from. You can't specify this with PipelineVersionAlias.
string
The MLflow experiment name of the pipeline execution.
string
The alias of the pipeline version to start the execution from. You can't specify this with PipelineVersionId. If no version of the pipeline has this alias, the request fails with a ResourceNotFound error.
string
The Amazon Resource Name (ARN) of the IAM role that the execution uses. You must specify this parameter when you start an execution of a pipeline that AWS manages. You can't specify it for a pipeline that you create, because its executions use the pipeline's role.
dict
Response Syntax
{
'PipelineExecutionArn': 'string'
}
Response Structure
(dict) --
PipelineExecutionArn (string) --
The Amazon Resource Name (ARN) of the pipeline execution.
{'PipelineVersionAliases': ['string']}
Updates a pipeline.
See also: AWS API Documentation
Request Syntax
client.update_pipeline(
PipelineName='string',
PipelineDisplayName='string',
PipelineDefinition='string',
PipelineDefinitionS3Location={
'Bucket': 'string',
'ObjectKey': 'string',
'VersionId': 'string'
},
PipelineDescription='string',
RoleArn='string',
ParallelismConfiguration={
'MaxParallelExecutionSteps': 123
},
PipelineVersionAliases=[
'string',
]
)
string
[REQUIRED]
The name of the pipeline to update.
string
The display name of the pipeline.
string
The JSON pipeline definition.
dict
The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
Bucket (string) -- [REQUIRED]
Name of the S3 bucket.
ObjectKey (string) -- [REQUIRED]
The object key (or key name) uniquely identifies the object in an S3 bucket.
VersionId (string) --
Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
string
The description of the pipeline.
string
The Amazon Resource Name (ARN) that the pipeline uses to execute.
dict
If specified, it applies to all executions of this pipeline by default.
MaxParallelExecutionSteps (integer) -- [REQUIRED]
The max number of steps that can be executed in parallel.
list
The aliases to assign to the new pipeline version that this update creates. You can specify aliases only when the update changes the pipeline definition. To change the aliases of an existing version, use UpdatePipelineVersion.
An alias must be unique within the pipeline. To move an alias from an existing version to the new version, first remove the alias from the existing version with UpdatePipelineVersion.
(string) --
dict
Response Syntax
{
'PipelineArn': 'string',
'PipelineVersionId': 123
}
Response Structure
(dict) --
PipelineArn (string) --
The Amazon Resource Name (ARN) of the updated pipeline.
PipelineVersionId (integer) --
The ID of the pipeline version.
{'PipelineVersionAliasOperations': {'Add': ['string'], 'Remove': ['string']}}
Updates a pipeline version.
See also: AWS API Documentation
Request Syntax
client.update_pipeline_version(
PipelineArn='string',
PipelineVersionId=123,
PipelineVersionDisplayName='string',
PipelineVersionDescription='string',
PipelineVersionAliasOperations={
'Add': [
'string',
],
'Remove': [
'string',
]
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the pipeline.
integer
[REQUIRED]
The pipeline version ID to update.
string
The display name of the pipeline version.
string
The description of the pipeline version.
dict
The aliases to add to or remove from the pipeline version.
Add (list) --
The aliases to add to the pipeline version. If you assigned an alias to another version of the same pipeline, you must remove it from that version before you add it here.
(string) --
Remove (list) --
The aliases to remove from the pipeline version.
(string) --
dict
Response Syntax
{
'PipelineArn': 'string',
'PipelineVersionId': 123
}
Response Structure
(dict) --
PipelineArn (string) --
The Amazon Resource Name (ARN) of the pipeline.
PipelineVersionId (integer) --
The ID of the pipeline version.