Skip to content

list_model_package_groups

list_model_package_groups(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[CreationTime] = None,
    creation_time_before: Optional[CreationTime] = None,
    max_results: Optional[MaxResults] = None,
    name_contains: Optional[NameContains] = None,
    next_token: Optional[NextToken] = None,
    sort_by: Optional[ModelPackageGroupSortBy] = None,
    sort_order: Optional[SortOrder] = None,
    cross_account_filter_option: Optional[CrossAccountFilterOption] = None,
) -> ListModelPackageGroupsOutput

Gets a list of the model groups in your Amazon Web Services account.

Parameters:

  • creation_time_after (Optional[CreationTime], default: None ) –

    A filter that returns only model groups created after the specified time.

  • creation_time_before (Optional[CreationTime], default: None ) –

    A filter that returns only model groups created before the specified time.

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

    The maximum number of results to return in the response.

  • name_contains (Optional[NameContains], default: None ) –

    A string in the model group name. This filter returns only model groups whose name contains the specified string.

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

    If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

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

    The field to sort results by. The default is CreationTime.

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

    The sort order for results. The default is Ascending.

  • cross_account_filter_option (Optional[CrossAccountFilterOption], default: None ) –

    A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_model_package_groups(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    sort_by: Optional[
        "capo_sagemaker.types.model_package_group_sort_by.ModelPackageGroupSortBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    cross_account_filter_option: Optional[
        "capo_sagemaker.types.cross_account_filter_option.CrossAccountFilterOption"
    ] = None,
) -> "capo_sagemaker.types.list_model_package_groups_output.ListModelPackageGroupsOutput":
    """<p>Gets a list of the model groups in your Amazon Web Services account.</p>

    Args:
        creation_time_after: <p>A filter that returns only model groups created after the specified time.</p>
        creation_time_before: <p>A filter that returns only model groups created before the specified time.</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        name_contains: <p>A string in the model group name. This filter returns only model groups whose name contains the specified string.</p>
        next_token: <p>If the result of the previous <code>ListModelPackageGroups</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model groups, use the token in the next request.</p>
        sort_by: <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for results. The default is <code>Ascending</code>.</p>
        cross_account_filter_option: <p>A filter that returns either model groups shared with you or model groups in your own account. When the value is <code>CrossAccount</code>, the results show the resources made discoverable to you from other accounts. When the value is <code>SameAccount</code> or <code>null</code>, the results show resources from your account. The default is <code>SameAccount</code>.</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_model_package_groups_input.ListModelPackageGroupsInput]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_model_package_groups_output.ListModelPackageGroupsOutput"
    ]:
        import capo_sagemaker._operations.sage_maker.list_model_package_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListModelPackageGroups")
    )
    input_: capo_sagemaker.types.list_model_package_groups_input.ListModelPackageGroupsInput = {}
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if max_results is not None:
        input_["max_results"] = max_results
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if cross_account_filter_option is not None:
        input_["cross_account_filter_option"] = cross_account_filter_option

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