Skip to content

describe_lineage_group

describe_lineage_group(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    lineage_group_name: Optional[ExperimentEntityName] = None,
) -> DescribeLineageGroupResponse

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_lineage_group(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    lineage_group_name: Optional[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ] = None,
) -> "capo_sagemaker.types.describe_lineage_group_response.DescribeLineageGroupResponse":
    """<p>Provides a list of properties for the requested lineage group. 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:
        lineage_group_name: <p>The name of the lineage group.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_lineage_group_request.DescribeLineageGroupRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_lineage_group_response.DescribeLineageGroupResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_lineage_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLineageGroup")
    )
    input_: capo_sagemaker.types.describe_lineage_group_request.DescribeLineageGroupRequest = {}
    if lineage_group_name is not None:
        input_["lineage_group_name"] = lineage_group_name

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