File size: 7,024 Bytes
4021124 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""This module contains code to create and manage SageMaker ``Artifact``."""
from __future__ import absolute_import
from typing import Optional, Iterator
from datetime import datetime
import logging
from sagemaker.apiutils import _base_types
from sagemaker.lineage import _api_types
from sagemaker.lineage._api_types import AssociationSummary
logger = logging.getLogger(__name__)
class Association(_base_types.Record):
"""An Amazon SageMaker artifact, which is part of a SageMaker lineage.
Examples:
.. code-block:: python
from sagemaker.lineage import association
my_association = association.Association.create(
source_arn=artifact_arn,
destination_arn=trial_component_arn,
association_type='ContributedTo')
for assoctn in association.Association.list():
print(assoctn)
my_association.delete()
Attributes:
source_arn (str): The ARN of the source entity.
source_type (str): The type of the source entity.
destination_arn (str): The ARN of the destination entity.
destination_type (str): The type of the destination entity.
association_type (str): the type of the association.
"""
source_arn: str = None
destination_arn: str = None
_boto_create_method: str = "add_association"
_boto_delete_method: str = "delete_association"
_custom_boto_types: dict = {}
_boto_delete_members = [
"source_arn",
"destination_arn",
]
def delete(self):
"""Delete this Association from SageMaker."""
self._invoke_api(self._boto_delete_method, self._boto_delete_members)
def set_tag(self, tag=None):
"""Add a tag to the object.
Args:
tag (obj): Key value pair to set tag.
Returns:
list({str:str}): a list of key value pairs
"""
logger.warning(
"set_tag on Association is deprecated. Use set_tag on the source or destination\
entity instead."
)
return self._set_tags(resource_arn=self.source_arn, tags=[tag])
def set_tags(self, tags=None):
"""Add tags to the object.
Args:
tags ([{key:value}]): list of key value pairs.
Returns:
list({str:str}): a list of key value pairs
"""
logger.warning(
"set_tags on Association is deprecated. Use set_tags on the source or destination\
entity instead."
)
return self._set_tags(resource_arn=self.source_arn, tags=tags)
@classmethod
def create(
cls,
source_arn: str,
destination_arn: str,
association_type: str = None,
sagemaker_session=None,
) -> "Association":
"""Add an association and return an ``Association`` object representing it.
Args:
source_arn (str): The ARN of the source.
destination_arn (str): The ARN of the destination.
association_type (str): The type of the association. ContributedTo, AssociatedWith,
DerivedFrom, or Produced.
sagemaker_session (sagemaker.session.Session): Session object which
manages interactions with Amazon SageMaker APIs and any other
AWS services needed. If not specified, one is created using the
default AWS configuration chain.
Returns:
association: A SageMaker ``Association`` object.
"""
return super(Association, cls)._construct(
cls._boto_create_method,
source_arn=source_arn,
destination_arn=destination_arn,
association_type=association_type,
sagemaker_session=sagemaker_session,
)
@classmethod
def list(
cls,
source_arn: str = None,
destination_arn: str = None,
source_type: str = None,
destination_type: str = None,
association_type: str = None,
created_after: Optional[datetime] = None,
created_before: Optional[datetime] = None,
sort_by: Optional[str] = None,
sort_order: Optional[str] = None,
max_results: Optional[int] = None,
next_token: Optional[str] = None,
sagemaker_session=None,
) -> Iterator[AssociationSummary]:
"""Return a list of context summaries.
Args:
source_arn (str): The ARN of the source entity.
destination_arn (str): The ARN of the destination entity.
source_type (str): The type of the source entity.
destination_type (str): The type of the destination entity.
association_type (str): The type of the association.
created_after (datetime.datetime, optional): Return contexts created after this
instant.
created_before (datetime.datetime, optional): Return contexts created before this
instant.
sort_by (str, optional): Which property to sort results by.
One of 'SourceArn', 'CreatedBefore', 'CreatedAfter'
sort_order (str, optional): One of 'Ascending', or 'Descending'.
max_results (int, optional): maximum number of contexts to retrieve
next_token (str, optional): token for next page of results
sagemaker_session (sagemaker.session.Session): Session object which
manages interactions with Amazon SageMaker APIs and any other
AWS services needed. If not specified, one is created using the
default AWS configuration chain.
Returns:
collections.Iterator[AssociationSummary]: An iterator
over ``AssociationSummary`` objects.
"""
return super(Association, cls)._list(
"list_associations",
_api_types.AssociationSummary.from_boto,
"AssociationSummaries",
source_arn=source_arn,
destination_arn=destination_arn,
source_type=source_type,
destination_type=destination_type,
association_type=association_type,
created_after=created_after,
created_before=created_before,
sort_by=sort_by,
sort_order=sort_order,
max_results=max_results,
next_token=next_token,
sagemaker_session=sagemaker_session,
)
|