Skip to content

list_resource_catalogs

list_resource_catalogs(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    name_contains: Optional[ResourceCatalogName] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    sort_order: Optional[ResourceCatalogSortOrder] = None,
    sort_by: Optional[ResourceCatalogSortBy] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListResourceCatalogsResponse

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

Parameters:

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

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

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

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

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

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

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

    The order in which the resource catalogs are listed.

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

    The value on which the resource catalog list is sorted.

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

    The maximum number of results returned by ListResourceCatalogs.

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

    A token to resume pagination of ListResourceCatalogs results.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_resource_catalogs(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    name_contains: Optional[
        "capo_sagemaker.types.resource_catalog_name.ResourceCatalogName"
    ] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.resource_catalog_sort_order.ResourceCatalogSortOrder"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.resource_catalog_sort_by.ResourceCatalogSortBy"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.list_resource_catalogs_response.ListResourceCatalogsResponse":
    """<p> Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of <code>ResourceCatalog</code>s viewable is 1000. </p>

    Args:
        name_contains: <p> A string that partially matches one or more <code>ResourceCatalog</code>s names. Filters <code>ResourceCatalog</code> by name. </p>
        creation_time_after: <p> Use this parameter to search for <code>ResourceCatalog</code>s created after a specific date and time. </p>
        creation_time_before: <p> Use this parameter to search for <code>ResourceCatalog</code>s created before a specific date and time. </p>
        sort_order: <p> The order in which the resource catalogs are listed. </p>
        sort_by: <p> The value on which the resource catalog list is sorted. </p>
        max_results: <p> The maximum number of results returned by <code>ListResourceCatalogs</code>. </p>
        next_token: <p> A token to resume pagination of <code>ListResourceCatalogs</code> results. </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_resource_catalogs_request.ListResourceCatalogsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_resource_catalogs_response.ListResourceCatalogsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_resource_catalogs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResourceCatalogs")
    )
    input_: capo_sagemaker.types.list_resource_catalogs_request.ListResourceCatalogsRequest = {}
    if name_contains is not None:
        input_["name_contains"] = name_contains
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output