2023/03/08 - Amazon SageMaker Service - 16 updated api methods
Changes There needs to be a user identity to specify the SageMaker user who perform each action regarding the entity. However, these is a not a unified concept of user identity across SageMaker service that could be used today.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes an action.
See also: AWS API Documentation
Request Syntax
client.describe_action( ActionName='string' )
string
[REQUIRED]
The name of the action to describe.
dict
Response Syntax
{ 'ActionName': 'string', 'ActionArn': 'string', 'Source': { 'SourceUri': 'string', 'SourceType': 'string', 'SourceId': 'string' }, 'ActionType': 'string', 'Description': 'string', 'Status': 'Unknown'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'Properties': { 'string': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'LineageGroupArn': 'string' }
Response Structure
(dict) --
ActionName (string) --
The name of the action.
ActionArn (string) --
The Amazon Resource Name (ARN) of the action.
Source (dict) --
The source of the action.
SourceUri (string) --
The URI of the source.
SourceType (string) --
The type of the source.
SourceId (string) --
The ID of the source.
ActionType (string) --
The type of the action.
Description (string) --
The description of the action.
Status (string) --
The status of the action.
Properties (dict) --
A list of the action's properties.
(string) --
(string) --
CreationTime (datetime) --
When the action was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LastModifiedTime (datetime) --
When the action was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
MetadataProperties (dict) --
Metadata properties of the tracking entity, trial, or trial component.
CommitId (string) --
The commit ID.
Repository (string) --
The repository.
GeneratedBy (string) --
The entity this entity was generated by.
ProjectId (string) --
The project ID.
LineageGroupArn (string) --
The Amazon Resource Name (ARN) of the lineage group.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes an artifact.
See also: AWS API Documentation
Request Syntax
client.describe_artifact( ArtifactArn='string' )
string
[REQUIRED]
The Amazon Resource Name (ARN) of the artifact to describe.
dict
Response Syntax
{ 'ArtifactName': 'string', 'ArtifactArn': 'string', 'Source': { 'SourceUri': 'string', 'SourceTypes': [ { 'SourceIdType': 'MD5Hash'|'S3ETag'|'S3Version'|'Custom', 'Value': 'string' }, ] }, 'ArtifactType': 'string', 'Properties': { 'string': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'LineageGroupArn': 'string' }
Response Structure
(dict) --
ArtifactName (string) --
The name of the artifact.
ArtifactArn (string) --
The Amazon Resource Name (ARN) of the artifact.
Source (dict) --
The source of the artifact.
SourceUri (string) --
The URI of the source.
SourceTypes (list) --
A list of source types.
(dict) --
The ID and ID type of an artifact source.
SourceIdType (string) --
The type of ID.
Value (string) --
The ID.
ArtifactType (string) --
The type of the artifact.
Properties (dict) --
A list of the artifact's properties.
(string) --
(string) --
CreationTime (datetime) --
When the artifact was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LastModifiedTime (datetime) --
When the artifact was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
MetadataProperties (dict) --
Metadata properties of the tracking entity, trial, or trial component.
CommitId (string) --
The commit ID.
Repository (string) --
The repository.
GeneratedBy (string) --
The entity this entity was generated by.
ProjectId (string) --
The project ID.
LineageGroupArn (string) --
The Amazon Resource Name (ARN) of the lineage group.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes a context.
See also: AWS API Documentation
Request Syntax
client.describe_context( ContextName='string' )
string
[REQUIRED]
The name of the context to describe.
dict
Response Syntax
{ 'ContextName': 'string', 'ContextArn': 'string', 'Source': { 'SourceUri': 'string', 'SourceType': 'string', 'SourceId': 'string' }, 'ContextType': 'string', 'Description': 'string', 'Properties': { 'string': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LineageGroupArn': 'string' }
Response Structure
(dict) --
ContextName (string) --
The name of the context.
ContextArn (string) --
The Amazon Resource Name (ARN) of the context.
Source (dict) --
The source of the context.
SourceUri (string) --
The URI of the source.
SourceType (string) --
The type of the source.
SourceId (string) --
The ID of the source.
ContextType (string) --
The type of the context.
Description (string) --
The description of the context.
Properties (dict) --
A list of the context's properties.
(string) --
(string) --
CreationTime (datetime) --
When the context was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LastModifiedTime (datetime) --
When the context was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LineageGroupArn (string) --
The Amazon Resource Name (ARN) of the lineage group.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Provides a list of an experiment's properties.
See also: AWS API Documentation
Request Syntax
client.describe_experiment( ExperimentName='string' )
string
[REQUIRED]
The name of the experiment to describe.
dict
Response Syntax
{ 'ExperimentName': 'string', 'ExperimentArn': 'string', 'DisplayName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } } }
Response Structure
(dict) --
ExperimentName (string) --
The name of the experiment.
ExperimentArn (string) --
The Amazon Resource Name (ARN) of the experiment.
DisplayName (string) --
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
Source (dict) --
The Amazon Resource Name (ARN) of the source and, optionally, the type.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
SourceType (string) --
The source type.
Description (string) --
The description of the experiment.
CreationTime (datetime) --
When the experiment was created.
CreatedBy (dict) --
Who created the experiment.
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.
LastModifiedTime (datetime) --
When the experiment was last modified.
LastModifiedBy (dict) --
Who last modified the experiment.
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.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide .
See also: AWS API Documentation
Request Syntax
client.describe_lineage_group( LineageGroupName='string' )
string
[REQUIRED]
The name of the lineage group.
dict
Response Syntax
{ 'LineageGroupName': 'string', 'LineageGroupArn': 'string', 'DisplayName': 'string', 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } } }
Response Structure
(dict) --
LineageGroupName (string) --
The name of the lineage group.
LineageGroupArn (string) --
The Amazon Resource Name (ARN) of the lineage group.
DisplayName (string) --
The display name of the lineage group.
Description (string) --
The description of the lineage group.
CreationTime (datetime) --
The creation time of lineage group.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LastModifiedTime (datetime) --
The last modified time of the lineage group.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
See also: AWS API Documentation
Request Syntax
client.describe_model_card( ModelCardName='string', ModelCardVersion=123 )
string
[REQUIRED]
The name of the model card to describe.
integer
The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
dict
Response Syntax
{ 'ModelCardArn': 'string', 'ModelCardName': 'string', 'ModelCardVersion': 123, 'Content': 'string', 'ModelCardStatus': 'Draft'|'PendingReview'|'Approved'|'Archived', 'SecurityConfig': { 'KmsKeyId': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'ModelCardProcessingStatus': 'DeleteInProgress'|'DeletePending'|'ContentDeleted'|'ExportJobsDeleted'|'DeleteCompleted'|'DeleteFailed' }
Response Structure
(dict) --
ModelCardArn (string) --
The Amazon Resource Name (ARN) of the model card.
ModelCardName (string) --
The name of the model card.
ModelCardVersion (integer) --
The version of the model card.
Content (string) --
The content of the model card.
ModelCardStatus (string) --
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft : The model card is a work in progress.
PendingReview : The model card is pending review.
Approved : The model card is approved.
Archived : The model card is archived. No more updates should be made to the model card, but it can still be exported.
SecurityConfig (dict) --
The security configuration used to protect model card content.
KmsKeyId (string) --
A Key Management Service key ID to use for encrypting a model card.
CreationTime (datetime) --
The date and time the model card was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
LastModifiedTime (datetime) --
The date and time the model card was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
ModelCardProcessingStatus (string) --
The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
DeletePending : Model card deletion request received.
DeleteInProgress : Model card deletion is in progress.
ContentDeleted : Deleted model card content.
ExportJobsDeleted : Deleted all export jobs associated with the model card.
DeleteCompleted : Successfully deleted the model card.
DeleteFailed : The model card failed to delete.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
See also: AWS API Documentation
Request Syntax
client.describe_model_package( ModelPackageName='string' )
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the model package to describe.
When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
dict
Response Syntax
{ 'ModelPackageName': 'string', 'ModelPackageGroupName': 'string', 'ModelPackageVersion': 123, 'ModelPackageArn': 'string', 'ModelPackageDescription': 'string', 'CreationTime': datetime(2015, 1, 1), 'InferenceSpecification': { 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string', 'Environment': { 'string': 'string' }, 'ModelInput': { 'DataInputConfig': 'string' }, 'Framework': 'string', 'FrameworkVersion': 'string', 'NearestModelName': 'string' }, ], 'SupportedTransformInstanceTypes': [ 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge', ], 'SupportedRealtimeInferenceInstanceTypes': [ 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.p4d.24xlarge'|'ml.c7g.large'|'ml.c7g.xlarge'|'ml.c7g.2xlarge'|'ml.c7g.4xlarge'|'ml.c7g.8xlarge'|'ml.c7g.12xlarge'|'ml.c7g.16xlarge'|'ml.m6g.large'|'ml.m6g.xlarge'|'ml.m6g.2xlarge'|'ml.m6g.4xlarge'|'ml.m6g.8xlarge'|'ml.m6g.12xlarge'|'ml.m6g.16xlarge'|'ml.m6gd.large'|'ml.m6gd.xlarge'|'ml.m6gd.2xlarge'|'ml.m6gd.4xlarge'|'ml.m6gd.8xlarge'|'ml.m6gd.12xlarge'|'ml.m6gd.16xlarge'|'ml.c6g.large'|'ml.c6g.xlarge'|'ml.c6g.2xlarge'|'ml.c6g.4xlarge'|'ml.c6g.8xlarge'|'ml.c6g.12xlarge'|'ml.c6g.16xlarge'|'ml.c6gd.large'|'ml.c6gd.xlarge'|'ml.c6gd.2xlarge'|'ml.c6gd.4xlarge'|'ml.c6gd.8xlarge'|'ml.c6gd.12xlarge'|'ml.c6gd.16xlarge'|'ml.c6gn.large'|'ml.c6gn.xlarge'|'ml.c6gn.2xlarge'|'ml.c6gn.4xlarge'|'ml.c6gn.8xlarge'|'ml.c6gn.12xlarge'|'ml.c6gn.16xlarge'|'ml.r6g.large'|'ml.r6g.xlarge'|'ml.r6g.2xlarge'|'ml.r6g.4xlarge'|'ml.r6g.8xlarge'|'ml.r6g.12xlarge'|'ml.r6g.16xlarge'|'ml.r6gd.large'|'ml.r6gd.xlarge'|'ml.r6gd.2xlarge'|'ml.r6gd.4xlarge'|'ml.r6gd.8xlarge'|'ml.r6gd.12xlarge'|'ml.r6gd.16xlarge'|'ml.p4de.24xlarge', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, 'SourceAlgorithmSpecification': { 'SourceAlgorithms': [ { 'ModelDataUrl': 'string', 'AlgorithmName': 'string' }, ] }, 'ValidationSpecification': { 'ValidationRole': 'string', 'ValidationProfiles': [ { 'ProfileName': 'string', 'TransformJobDefinition': { 'MaxConcurrentTransforms': 123, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' } } }, ] }, 'ModelPackageStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting', 'ModelPackageStatusDetails': { 'ValidationStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ], 'ImageScanStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ] }, 'CertifyForMarketplace': True|False, 'ModelApprovalStatus': 'Approved'|'Rejected'|'PendingManualApproval', 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'ModelMetrics': { 'ModelQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'ModelDataQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'Bias': { 'Report': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'PreTrainingReport': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'PostTrainingReport': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'Explainability': { 'Report': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'ApprovalDescription': 'string', 'CustomerMetadataProperties': { 'string': 'string' }, 'DriftCheckBaselines': { 'Bias': { 'ConfigFile': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'PreTrainingConstraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'PostTrainingConstraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'Explainability': { 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'ConfigFile': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'ModelQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } }, 'ModelDataQuality': { 'Statistics': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' }, 'Constraints': { 'ContentType': 'string', 'ContentDigest': 'string', 'S3Uri': 'string' } } }, 'Domain': 'string', 'Task': 'string', 'SamplePayloadUrl': 'string', 'AdditionalInferenceSpecifications': [ { 'Name': 'string', 'Description': 'string', 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string', 'Environment': { 'string': 'string' }, 'ModelInput': { 'DataInputConfig': 'string' }, 'Framework': 'string', 'FrameworkVersion': 'string', 'NearestModelName': 'string' }, ], 'SupportedTransformInstanceTypes': [ 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge', ], 'SupportedRealtimeInferenceInstanceTypes': [ 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.p4d.24xlarge'|'ml.c7g.large'|'ml.c7g.xlarge'|'ml.c7g.2xlarge'|'ml.c7g.4xlarge'|'ml.c7g.8xlarge'|'ml.c7g.12xlarge'|'ml.c7g.16xlarge'|'ml.m6g.large'|'ml.m6g.xlarge'|'ml.m6g.2xlarge'|'ml.m6g.4xlarge'|'ml.m6g.8xlarge'|'ml.m6g.12xlarge'|'ml.m6g.16xlarge'|'ml.m6gd.large'|'ml.m6gd.xlarge'|'ml.m6gd.2xlarge'|'ml.m6gd.4xlarge'|'ml.m6gd.8xlarge'|'ml.m6gd.12xlarge'|'ml.m6gd.16xlarge'|'ml.c6g.large'|'ml.c6g.xlarge'|'ml.c6g.2xlarge'|'ml.c6g.4xlarge'|'ml.c6g.8xlarge'|'ml.c6g.12xlarge'|'ml.c6g.16xlarge'|'ml.c6gd.large'|'ml.c6gd.xlarge'|'ml.c6gd.2xlarge'|'ml.c6gd.4xlarge'|'ml.c6gd.8xlarge'|'ml.c6gd.12xlarge'|'ml.c6gd.16xlarge'|'ml.c6gn.large'|'ml.c6gn.xlarge'|'ml.c6gn.2xlarge'|'ml.c6gn.4xlarge'|'ml.c6gn.8xlarge'|'ml.c6gn.12xlarge'|'ml.c6gn.16xlarge'|'ml.r6g.large'|'ml.r6g.xlarge'|'ml.r6g.2xlarge'|'ml.r6g.4xlarge'|'ml.r6g.8xlarge'|'ml.r6g.12xlarge'|'ml.r6g.16xlarge'|'ml.r6gd.large'|'ml.r6gd.xlarge'|'ml.r6gd.2xlarge'|'ml.r6gd.4xlarge'|'ml.r6gd.8xlarge'|'ml.r6gd.12xlarge'|'ml.r6gd.16xlarge'|'ml.p4de.24xlarge', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, ] }
Response Structure
(dict) --
ModelPackageName (string) --
The name of the model package being described.
ModelPackageGroupName (string) --
If the model is a versioned model, the name of the model group that the versioned model belongs to.
ModelPackageVersion (integer) --
The version of the model package.
ModelPackageArn (string) --
The Amazon Resource Name (ARN) of the model package.
ModelPackageDescription (string) --
A brief summary of the model package.
CreationTime (datetime) --
A timestamp specifying when the model package was created.
InferenceSpecification (dict) --
Details about inference jobs that can be run with models based on this model package.
Containers (list) --
The Amazon ECR registry path of the Docker image that contains the inference code.
(dict) --
Describes the Docker container for the model package.
ContainerHostname (string) --
The DNS host name for the Docker container.
Image (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 SageMaker, the inference code must meet SageMaker requirements. 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 (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
ModelDataUrl (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).
Note
The model artifacts must be in an S3 bucket that is in the same region as the model package.
ProductId (string) --
The Amazon Web Services Marketplace product ID of the model package.
Environment (dict) --
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.
(string) --
(string) --
ModelInput (dict) --
A structure with Model Input details.
DataInputConfig (string) --
The input configuration object for the model.
Framework (string) --
The machine learning framework of the model package container image.
FrameworkVersion (string) --
The framework version of the Model Package Container Image.
NearestModelName (string) --
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata .
SupportedTransformInstanceTypes (list) --
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
This parameter is required for unversioned models, and optional for versioned models.
(string) --
SupportedRealtimeInferenceInstanceTypes (list) --
A list of the instance types that are used to generate inferences in real-time.
This parameter is required for unversioned models, and optional for versioned models.
(string) --
SupportedContentTypes (list) --
The supported MIME types for the input data.
(string) --
SupportedResponseMIMETypes (list) --
The supported MIME types for the output data.
(string) --
SourceAlgorithmSpecification (dict) --
Details about the algorithm that was used to create the model package.
SourceAlgorithms (list) --
A list of the algorithms that were used to create a model package.
(dict) --
Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
ModelDataUrl (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).
Note
The model artifacts must be in an S3 bucket that is in the same region as the algorithm.
AlgorithmName (string) --
The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
ValidationSpecification (dict) --
Configurations for one or more transform jobs that SageMaker runs to test the model package.
ValidationRole (string) --
The IAM roles to be used for the validation of the model package.
ValidationProfiles (list) --
An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
(dict) --
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 Amazon Web Services Marketplace.
ProfileName (string) --
The name of the profile for the model package.
TransformJobDefinition (dict) --
The TransformJobDefinition object that describes the transform job used for the validation of the model package.
MaxConcurrentTransforms (integer) --
The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
MaxPayloadInMB (integer) --
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
BatchStrategy (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 (dict) --
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
(string) --
(string) --
TransformInput (dict) --
A description of the input source and the way the transform job consumes it.
DataSource (dict) --
Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (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 (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", ... "relative/path/custdata-N" ] 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 ... s3://customer_bucket/some/prefix/relative/path/custdata-N 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.
ContentType (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.
CompressionType (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 .
SplitType (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. Currently, the supported record formats are:
RecordIO
TFRecord
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.
Note
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 RecordIO , see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord , see Consuming TFRecord data in the TensorFlow documentation.
TransformOutput (dict) --
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
S3OutputPath (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.
Accept (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 (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 (string) --
The Amazon Web Services Key Management Service (Amazon Web Services 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:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: 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 CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide .
TransformResources (dict) --
Identifies the ML compute instances for the transform job.
InstanceType (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.
InstanceCount (integer) --
The number of ML compute instances to use in the transform job. The default value is 1 , and the maximum is 100 . For distributed transform jobs, specify a value greater than 1 .
VolumeKmsKeyId (string) --
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
ModelPackageStatus (string) --
The current status of the model package.
ModelPackageStatusDetails (dict) --
Details about the current status of the model package.
ValidationStatuses (list) --
The validation status of the model package.
(dict) --
Represents the overall status of a model package.
Name (string) --
The name of the model package for which the overall status is being reported.
Status (string) --
The current status.
FailureReason (string) --
if the overall status is Failed , the reason for the failure.
ImageScanStatuses (list) --
The status of the scan of the Docker image container for the model package.
(dict) --
Represents the overall status of a model package.
Name (string) --
The name of the model package for which the overall status is being reported.
Status (string) --
The current status.
FailureReason (string) --
if the overall status is Failed , the reason for the failure.
CertifyForMarketplace (boolean) --
Whether the model package is certified for listing on Amazon Web Services Marketplace.
ModelApprovalStatus (string) --
The approval status of the model package.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
MetadataProperties (dict) --
Metadata properties of the tracking entity, trial, or trial component.
CommitId (string) --
The commit ID.
Repository (string) --
The repository.
GeneratedBy (string) --
The entity this entity was generated by.
ProjectId (string) --
The project ID.
ModelMetrics (dict) --
Metrics for the model.
ModelQuality (dict) --
Metrics that measure the quality of a model.
Statistics (dict) --
Model quality statistics.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Constraints (dict) --
Model quality constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
ModelDataQuality (dict) --
Metrics that measure the quality of the input data for a model.
Statistics (dict) --
Data quality statistics for a model.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Constraints (dict) --
Data quality constraints for a model.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Bias (dict) --
Metrics that measure bais in a model.
Report (dict) --
The bias report for a model
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
PreTrainingReport (dict) --
The pre-training bias report for a model.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
PostTrainingReport (dict) --
The post-training bias report for a model.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Explainability (dict) --
Metrics that help explain a model.
Report (dict) --
The explainability report for a model.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
LastModifiedTime (datetime) --
The last time that the model package was modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
ApprovalDescription (string) --
A description provided for the model approval.
CustomerMetadataProperties (dict) --
The metadata properties associated with the model package versions.
(string) --
(string) --
DriftCheckBaselines (dict) --
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide .
Bias (dict) --
Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
ConfigFile (dict) --
The bias config file for a model.
ContentType (string) --
The type of content stored in the file source.
ContentDigest (string) --
The digest of the file source.
S3Uri (string) --
The Amazon S3 URI for the file source.
PreTrainingConstraints (dict) --
The pre-training constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
PostTrainingConstraints (dict) --
The post-training constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Explainability (dict) --
Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
Constraints (dict) --
The drift check explainability constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
ConfigFile (dict) --
The explainability config file for the model.
ContentType (string) --
The type of content stored in the file source.
ContentDigest (string) --
The digest of the file source.
S3Uri (string) --
The Amazon S3 URI for the file source.
ModelQuality (dict) --
Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
Statistics (dict) --
The drift check model quality statistics.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Constraints (dict) --
The drift check model quality constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
ModelDataQuality (dict) --
Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
Statistics (dict) --
The drift check model data quality statistics.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Constraints (dict) --
The drift check model data quality constraints.
ContentType (string) --
The metric source content type.
ContentDigest (string) --
The hash key used for the metrics source.
S3Uri (string) --
The S3 URI for the metrics source.
Domain (string) --
The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
Task (string) --
The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
SamplePayloadUrl (string) --
The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).
AdditionalInferenceSpecifications (list) --
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
(dict) --
A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
Name (string) --
A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
Description (string) --
A description of the additional Inference specification
Containers (list) --
The Amazon ECR registry path of the Docker image that contains the inference code.
(dict) --
Describes the Docker container for the model package.
ContainerHostname (string) --
The DNS host name for the Docker container.
Image (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 SageMaker, the inference code must meet SageMaker requirements. 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 (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
ModelDataUrl (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).
Note
The model artifacts must be in an S3 bucket that is in the same region as the model package.
ProductId (string) --
The Amazon Web Services Marketplace product ID of the model package.
Environment (dict) --
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.
(string) --
(string) --
ModelInput (dict) --
A structure with Model Input details.
DataInputConfig (string) --
The input configuration object for the model.
Framework (string) --
The machine learning framework of the model package container image.
FrameworkVersion (string) --
The framework version of the Model Package Container Image.
NearestModelName (string) --
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata .
SupportedTransformInstanceTypes (list) --
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
(string) --
SupportedRealtimeInferenceInstanceTypes (list) --
A list of the instance types that are used to generate inferences in real-time.
(string) --
SupportedContentTypes (list) --
The supported MIME types for the input data.
(string) --
SupportedResponseMIMETypes (list) --
The supported MIME types for the output data.
(string) --
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Gets a description for the specified model group.
See also: AWS API Documentation
Request Syntax
client.describe_model_package_group( ModelPackageGroupName='string' )
string
[REQUIRED]
The name of gthe model group to describe.
dict
Response Syntax
{ 'ModelPackageGroupName': 'string', 'ModelPackageGroupArn': 'string', 'ModelPackageGroupDescription': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'ModelPackageGroupStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'|'DeleteFailed' }
Response Structure
(dict) --
ModelPackageGroupName (string) --
The name of the model group.
ModelPackageGroupArn (string) --
The Amazon Resource Name (ARN) of the model group.
ModelPackageGroupDescription (string) --
A description of the model group.
CreationTime (datetime) --
The time that the model group was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
ModelPackageGroupStatus (string) --
The status of the model group.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes the details of a pipeline.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline( PipelineName='string' )
string
[REQUIRED]
The name of the pipeline to describe.
dict
Response Syntax
{ 'PipelineArn': 'string', 'PipelineName': 'string', 'PipelineDisplayName': 'string', 'PipelineDefinition': 'string', 'PipelineDescription': 'string', 'RoleArn': 'string', 'PipelineStatus': 'Active', '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 } }
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 an experiment, trial, trial component, lineage group, project, or model card.
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 an experiment, trial, trial component, lineage group, project, or model card.
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.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': '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', '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 } }
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 an experiment, trial, trial component, lineage group, project, or model card.
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 an experiment, trial, trial component, lineage group, project, or model card.
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.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Describes the details of a project.
See also: AWS API Documentation
Request Syntax
client.describe_project( ProjectName='string' )
string
[REQUIRED]
The name of the project to describe.
dict
Response Syntax
{ 'ProjectArn': 'string', 'ProjectName': 'string', 'ProjectId': 'string', 'ProjectDescription': 'string', 'ServiceCatalogProvisioningDetails': { 'ProductId': 'string', 'ProvisioningArtifactId': 'string', 'PathId': 'string', 'ProvisioningParameters': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ServiceCatalogProvisionedProductDetails': { 'ProvisionedProductId': 'string', 'ProvisionedProductStatusMessage': 'string' }, 'ProjectStatus': 'Pending'|'CreateInProgress'|'CreateCompleted'|'CreateFailed'|'DeleteInProgress'|'DeleteFailed'|'DeleteCompleted'|'UpdateInProgress'|'UpdateCompleted'|'UpdateFailed', 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } } }
Response Structure
(dict) --
ProjectArn (string) --
The Amazon Resource Name (ARN) of the project.
ProjectName (string) --
The name of the project.
ProjectId (string) --
The ID of the project.
ProjectDescription (string) --
The description of the project.
ServiceCatalogProvisioningDetails (dict) --
Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
ProductId (string) --
The ID of the product to provision.
ProvisioningArtifactId (string) --
The ID of the provisioning artifact.
PathId (string) --
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
ProvisioningParameters (list) --
A list of key value pairs that you specify when you provision a product.
(dict) --
A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.
Key (string) --
The key that identifies a provisioning parameter.
Value (string) --
The value of the provisioning parameter.
ServiceCatalogProvisionedProductDetails (dict) --
Information about a provisioned service catalog product.
ProvisionedProductId (string) --
The ID of the provisioned product.
ProvisionedProductStatusMessage (string) --
The current status of the product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
ProjectStatus (string) --
The status of the project.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
CreationTime (datetime) --
The time when the project was created.
LastModifiedTime (datetime) --
The timestamp when project was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Provides a list of a trial's properties.
See also: AWS API Documentation
Request Syntax
client.describe_trial( TrialName='string' )
string
[REQUIRED]
The name of the trial to describe.
dict
Response Syntax
{ 'TrialName': 'string', 'TrialArn': 'string', 'DisplayName': 'string', 'ExperimentName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' } }
Response Structure
(dict) --
TrialName (string) --
The name of the trial.
TrialArn (string) --
The Amazon Resource Name (ARN) of the trial.
DisplayName (string) --
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
ExperimentName (string) --
The name of the experiment the trial is part of.
Source (dict) --
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
SourceType (string) --
The source job type.
CreationTime (datetime) --
When the trial was created.
CreatedBy (dict) --
Who created the trial.
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.
LastModifiedTime (datetime) --
When the trial was last modified.
LastModifiedBy (dict) --
Who last modified the trial.
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.
MetadataProperties (dict) --
Metadata properties of the tracking entity, trial, or trial component.
CommitId (string) --
The commit ID.
Repository (string) --
The repository.
GeneratedBy (string) --
The entity this entity was generated by.
ProjectId (string) --
The project ID.
{'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}
Provides a list of a trials component's properties.
See also: AWS API Documentation
Request Syntax
client.describe_trial_component( TrialComponentName='string' )
string
[REQUIRED]
The name of the trial component to describe.
dict
Response Syntax
{ 'TrialComponentName': 'string', 'TrialComponentArn': 'string', 'DisplayName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Status': { 'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'Message': 'string' }, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'Parameters': { 'string': { 'StringValue': 'string', 'NumberValue': 123.0 } }, 'InputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'OutputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'MetadataProperties': { 'CommitId': 'string', 'Repository': 'string', 'GeneratedBy': 'string', 'ProjectId': 'string' }, 'Metrics': [ { 'MetricName': 'string', 'SourceArn': 'string', 'TimeStamp': datetime(2015, 1, 1), 'Max': 123.0, 'Min': 123.0, 'Last': 123.0, 'Count': 123, 'Avg': 123.0, 'StdDev': 123.0 }, ], 'LineageGroupArn': 'string', 'Sources': [ { 'SourceArn': 'string', 'SourceType': 'string' }, ] }
Response Structure
(dict) --
TrialComponentName (string) --
The name of the trial component.
TrialComponentArn (string) --
The Amazon Resource Name (ARN) of the trial component.
DisplayName (string) --
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
Source (dict) --
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
SourceArn (string) --
The source Amazon Resource Name (ARN).
SourceType (string) --
The source job type.
Status (dict) --
The status of the component. States include:
InProgress
Completed
Failed
PrimaryStatus (string) --
The status of the trial component.
Message (string) --
If the component failed, a message describing why.
StartTime (datetime) --
When the component started.
EndTime (datetime) --
When the component ended.
CreationTime (datetime) --
When the component was created.
CreatedBy (dict) --
Who created the trial component.
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.
LastModifiedTime (datetime) --
When the component was last modified.
LastModifiedBy (dict) --
Who last modified the component.
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.
Parameters (dict) --
The hyperparameters of the component.
(string) --
(dict) --
The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
StringValue (string) --
The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.
NumberValue (float) --
The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
InputArtifacts (dict) --
The input artifacts of the component.
(string) --
(dict) --
Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
MediaType (string) --
The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
Value (string) --
The location of the artifact.
OutputArtifacts (dict) --
The output artifacts of the component.
(string) --
(dict) --
Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
MediaType (string) --
The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
Value (string) --
The location of the artifact.
MetadataProperties (dict) --
Metadata properties of the tracking entity, trial, or trial component.
CommitId (string) --
The commit ID.
Repository (string) --
The repository.
GeneratedBy (string) --
The entity this entity was generated by.
ProjectId (string) --
The project ID.
Metrics (list) --
The metrics for the component.
(dict) --
A summary of the metrics of a trial component.
MetricName (string) --
The name of the metric.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
TimeStamp (datetime) --
When the metric was last updated.
Max (float) --
The maximum value of the metric.
Min (float) --
The minimum value of the metric.
Last (float) --
The most recent value of the metric.
Count (integer) --
The number of samples used to generate the metric.
Avg (float) --
The average value of the metric.
StdDev (float) --
The standard deviation of the metric.
LineageGroupArn (string) --
The Amazon Resource Name (ARN) of the lineage group.
Sources (list) --
A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
(dict) --
The Amazon Resource Name (ARN) and job type of the source of a trial component.
SourceArn (string) --
The source Amazon Resource Name (ARN).
SourceType (string) --
The source job type.
{'AssociationSummaries': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}}
Lists the associations in your account and their properties.
See also: AWS API Documentation
Request Syntax
client.list_associations( SourceArn='string', DestinationArn='string', SourceType='string', DestinationType='string', AssociationType='ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced', CreatedAfter=datetime(2015, 1, 1), CreatedBefore=datetime(2015, 1, 1), SortBy='SourceArn'|'DestinationArn'|'SourceType'|'DestinationType'|'CreationTime', SortOrder='Ascending'|'Descending', NextToken='string', MaxResults=123 )
string
A filter that returns only associations with the specified source ARN.
string
A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
string
A filter that returns only associations with the specified source type.
string
A filter that returns only associations with the specified destination type.
string
A filter that returns only associations of the specified type.
datetime
A filter that returns only associations created on or after the specified time.
datetime
A filter that returns only associations created on or before the specified time.
string
The property used to sort results. The default value is CreationTime .
string
The sort order. The default value is Descending .
string
If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.
integer
The maximum number of associations to return in the response. The default value is 10.
dict
Response Syntax
{ 'AssociationSummaries': [ { 'SourceArn': 'string', 'DestinationArn': 'string', 'SourceType': 'string', 'DestinationType': 'string', 'AssociationType': 'ContributedTo'|'AssociatedWith'|'DerivedFrom'|'Produced', 'SourceName': 'string', 'DestinationName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } } }, ], 'NextToken': 'string' }
Response Structure
(dict) --
AssociationSummaries (list) --
A list of associations and their properties.
(dict) --
Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.
SourceArn (string) --
The ARN of the source.
DestinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
SourceType (string) --
The source type.
DestinationType (string) --
The destination type.
AssociationType (string) --
The type of the association.
SourceName (string) --
The name of the source.
DestinationName (string) --
The name of the destination.
CreationTime (datetime) --
When the association was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
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.
NextToken (string) --
A token for getting the next set of associations, if there are any.
{'TrialComponentSummaries': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}}
Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:
ExperimentName
SourceArn
TrialName
See also: AWS API Documentation
Request Syntax
client.list_trial_components( ExperimentName='string', TrialName='string', SourceArn='string', CreatedAfter=datetime(2015, 1, 1), CreatedBefore=datetime(2015, 1, 1), SortBy='Name'|'CreationTime', SortOrder='Ascending'|'Descending', MaxResults=123, NextToken='string' )
string
A filter that returns only components that are part of the specified experiment. If you specify ExperimentName , you can't filter by SourceArn or TrialName .
string
A filter that returns only components that are part of the specified trial. If you specify TrialName , you can't filter by ExperimentName or SourceArn .
string
A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn , you can't filter by ExperimentName or TrialName .
datetime
A filter that returns only components created after the specified time.
datetime
A filter that returns only components created before the specified time.
string
The property used to sort results. The default value is CreationTime .
string
The sort order. The default value is Descending .
integer
The maximum number of components to return in the response. The default value is 10.
string
If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.
dict
Response Syntax
{ 'TrialComponentSummaries': [ { 'TrialComponentName': 'string', 'TrialComponentArn': 'string', 'DisplayName': 'string', 'TrialComponentSource': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Status': { 'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'Message': 'string' }, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string', 'IamIdentity': { 'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string' } } }, ], 'NextToken': 'string' }
Response Structure
(dict) --
TrialComponentSummaries (list) --
A list of the summaries of your trial components.
(dict) --
A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName .
TrialComponentName (string) --
The name of the trial component.
TrialComponentArn (string) --
The Amazon Resource Name (ARN) of the trial component.
DisplayName (string) --
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
TrialComponentSource (dict) --
The Amazon Resource Name (ARN) and job type of the source of a trial component.
SourceArn (string) --
The source Amazon Resource Name (ARN).
SourceType (string) --
The source job type.
Status (dict) --
The status of the component. States include:
InProgress
Completed
Failed
PrimaryStatus (string) --
The status of the trial component.
Message (string) --
If the component failed, a message describing why.
StartTime (datetime) --
When the component started.
EndTime (datetime) --
When the component ended.
CreationTime (datetime) --
When the component was created.
CreatedBy (dict) --
Who created the trial component.
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.
LastModifiedTime (datetime) --
When the component was last modified.
LastModifiedBy (dict) --
Who last modified the component.
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.
NextToken (string) --
A token for getting the next set of components, if there are any.
{'Results': {'Experiment': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'Model': {'ModelCard': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}}, 'ModelCard': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'ModelPackage': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'ModelPackageGroup': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'Pipeline': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'PipelineExecution': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'Project': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}, 'Trial': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'TrialComponentSummaries': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}}}, 'TrialComponent': {'CreatedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': 'string'}}, 'LastModifiedBy': {'IamIdentity': {'Arn': 'string', 'PrincipalId': 'string', 'SourceIdentity': '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.
Note
The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.
See also: AWS API Documentation
Request Syntax
client.search( Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'Project'|'FeatureMetadata'|'HyperParameterTuningJob'|'ModelCard'|'Model', 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 )
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.
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.