Skip to content

list_lineage_groups

list_lineage_groups(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    created_after: Optional[Timestamp] = None,
    created_before: Optional[Timestamp] = None,
    sort_by: Optional[SortLineageGroupsBy] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListLineageGroupsResponse

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

Parameters:

  • created_after (Optional[Timestamp], default: None ) –

    A timestamp to filter against lineage groups created after a certain point in time.

  • created_before (Optional[Timestamp], default: None ) –

    A timestamp to filter against lineage groups created before a certain point in time.

  • sort_by (Optional[SortLineageGroupsBy], default: None ) –

    The parameter by which to sort the results. The default is CreationTime.

  • sort_order (Optional[SortOrder], default: None ) –

    The sort order for the results. The default is Ascending.

  • next_token (Optional[NextToken], default: None ) –

    If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of endpoints to return in the response. This value defaults to 10.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_lineage_groups(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    created_after: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    created_before: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    sort_by: Optional[
        "capo_sagemaker.types.sort_lineage_groups_by.SortLineageGroupsBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_lineage_groups_response.ListLineageGroupsResponse":
    """<p>A list of lineage groups shared with your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html"> Cross-Account Lineage Tracking </a> in the <i>Amazon SageMaker Developer Guide</i>.</p>

    Args:
        created_after: <p>A timestamp to filter against lineage groups created after a certain point in time.</p>
        created_before: <p>A timestamp to filter against lineage groups created before a certain point in time.</p>
        sort_by: <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for the results. The default is <code>Ascending</code>.</p>
        next_token: <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.</p>
        max_results: <p>The maximum number of endpoints to return in the response. This value defaults to 10.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_lineage_groups_request.ListLineageGroupsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_lineage_groups_response.ListLineageGroupsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_lineage_groups

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_lineage_groups.list_lineage_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLineageGroups")
    )
    input_: capo_sagemaker.types.list_lineage_groups_request.ListLineageGroupsRequest = {}
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output