SageMaker / Client / describe_artifact
describe_artifact#
- SageMaker.Client.describe_artifact(**kwargs)#
Describes an artifact.
See also: AWS API Documentation
Request Syntax
response = client.describe_artifact( ArtifactArn='string' )
- Parameters:
ArtifactArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the artifact to describe.
- Return type:
dict
- Returns:
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.
Exceptions
SageMaker.Client.exceptions.ResourceNotFound