Skip to content

list_feature_groups async

list_feature_groups(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    name_contains: Optional[FeatureGroupNameContains] = None,
    feature_group_status_equals: Optional[FeatureGroupStatus] = None,
    offline_store_status_equals: Optional[OfflineStoreStatusValue] = None,
    creation_time_after: Optional[CreationTime] = None,
    creation_time_before: Optional[CreationTime] = None,
    sort_order: Optional[FeatureGroupSortOrder] = None,
    sort_by: Optional[FeatureGroupSortBy] = None,
    max_results: Optional[FeatureGroupMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListFeatureGroupsResponse

List FeatureGroups based on given filter and order.

Parameters:

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

    A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

  • feature_group_status_equals (Optional[FeatureGroupStatus], default: None ) –

    A FeatureGroup status. Filters by FeatureGroup status.

  • offline_store_status_equals (Optional[OfflineStoreStatusValue], default: None ) –

    An OfflineStore status. Filters by OfflineStore status.

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

    Use this parameter to search for FeatureGroupss created after a specific date and time.

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

    Use this parameter to search for FeatureGroupss created before a specific date and time.

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

    The order in which feature groups are listed.

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

    The value on which the feature group list is sorted.

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

    The maximum number of results returned by ListFeatureGroups.

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

    A token to resume pagination of ListFeatureGroups results.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_feature_groups(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    name_contains: Optional[
        "capo_sagemaker.types.feature_group_name_contains.FeatureGroupNameContains"
    ] = None,
    feature_group_status_equals: Optional[
        "capo_sagemaker.types.feature_group_status.FeatureGroupStatus"
    ] = None,
    offline_store_status_equals: Optional[
        "capo_sagemaker.types.offline_store_status_value.OfflineStoreStatusValue"
    ] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.feature_group_sort_order.FeatureGroupSortOrder"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.feature_group_sort_by.FeatureGroupSortBy"
    ] = None,
    max_results: Optional[
        "capo_sagemaker.types.feature_group_max_results.FeatureGroupMaxResults"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.list_feature_groups_response.ListFeatureGroupsResponse":
    """<p>List <code>FeatureGroup</code>s based on given filter and order.</p>

    Args:
        name_contains: <p>A string that partially matches one or more <code>FeatureGroup</code>s names. Filters <code>FeatureGroup</code>s by name. </p>
        feature_group_status_equals: <p>A <code>FeatureGroup</code> status. Filters by <code>FeatureGroup</code> status. </p>
        offline_store_status_equals: <p>An <code>OfflineStore</code> status. Filters by <code>OfflineStore</code> status. </p>
        creation_time_after: <p>Use this parameter to search for <code>FeatureGroups</code>s created after a specific date and time.</p>
        creation_time_before: <p>Use this parameter to search for <code>FeatureGroups</code>s created before a specific date and time.</p>
        sort_order: <p>The order in which feature groups are listed.</p>
        sort_by: <p>The value on which the feature group list is sorted.</p>
        max_results: <p>The maximum number of results returned by <code>ListFeatureGroups</code>.</p>
        next_token: <p>A token to resume pagination of <code>ListFeatureGroups</code> results.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.list_feature_groups_request.ListFeatureGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_feature_groups_response.ListFeatureGroupsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_feature_groups

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.list_feature_groups.async_list_feature_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFeatureGroups")
    )
    input_: capo_sagemaker.types.list_feature_groups_request.ListFeatureGroupsRequest = {}
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if feature_group_status_equals is not None:
        input_["feature_group_status_equals"] = feature_group_status_equals
    if offline_store_status_equals is not None:
        input_["offline_store_status_equals"] = offline_store_status_equals
    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 sort_order is not None:
        input_["sort_order"] = sort_order
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output