DescribeArtifact
Describes an artifact.
Request Syntax
{
"ArtifactArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ArtifactArn
-
The Amazon Resource Name (ARN) of the artifact to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*Required: Yes
Response Syntax
{
"ArtifactArn": "string",
"ArtifactName": "string",
"ArtifactType": "string",
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"LastModifiedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"LastModifiedTime": number,
"LineageGroupArn": "string",
"MetadataProperties": {
"CommitId": "string",
"GeneratedBy": "string",
"ProjectId": "string",
"Repository": "string"
},
"Properties": {
"string" : "string"
},
"Source": {
"SourceTypes": [
{
"SourceIdType": "string",
"Value": "string"
}
],
"SourceUri": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ArtifactArn
-
The Amazon Resource Name (ARN) of the artifact.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.* - ArtifactName
-
The name of the artifact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}) - ArtifactType
-
The type of the artifact.
Type: String
Length Constraints: Maximum length of 256.
- CreatedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- CreationTime
-
When the artifact was created.
Type: Timestamp
- LastModifiedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- LastModifiedTime
-
When the artifact was last modified.
Type: Timestamp
- LineageGroupArn
-
The Amazon Resource Name (ARN) of the lineage group.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.* - MetadataProperties
-
Metadata properties of the tracking entity, trial, or trial component.
Type: MetadataProperties object
- Properties
-
A list of the artifact's properties.
Type: String to string map
Map Entries: Maximum number of 30 items.
Key Length Constraints: Maximum length of 2500.
Key Pattern:
.*Value Length Constraints: Maximum length of 2500.
Value Pattern:
.* - Source
-
The source of the artifact.
Type: ArtifactSource object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
