Skip to content

list_catalog_items

list_catalog_items(
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults1000] = None,
    item_class_filter: Optional[CatalogItemClassList] = None,
    supported_storage_filter: Optional[SupportedStorageList] = None,
    ec2_family_filter: Optional[EC2FamilyList] = None,
) -> ListCatalogItemsOutput

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Parameters:

Raises:

Source code in docs_src/capo_outposts/_services/outposts.py
def list_catalog_items(
    self,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    next_token: Optional["capo_outposts.types.token.Token"] = None,
    max_results: Optional[
        "capo_outposts.types.max_results1000.MaxResults1000"
    ] = None,
    item_class_filter: Optional[
        "capo_outposts.types.catalog_item_class_list.CatalogItemClassList"
    ] = None,
    supported_storage_filter: Optional[
        "capo_outposts.types.supported_storage_list.SupportedStorageList"
    ] = None,
    ec2_family_filter: Optional[
        "capo_outposts.types.ec2_family_list.EC2FamilyList"
    ] = None,
) -> "capo_outposts.types.list_catalog_items_output.ListCatalogItemsOutput":
    """<p>Lists the items in the catalog.</p> <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.</p>

    Args:
        item_class_filter: <p>Filters the results by item class.</p>
        supported_storage_filter: <p>Filters the results by storage option.</p>
        ec2_family_filter: <p>Filters the results by EC2 family (for example, M5).</p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_outposts.types.list_catalog_items_input.ListCatalogItemsInput]",
    ) -> OperationResponse[
        "capo_outposts.types.list_catalog_items_output.ListCatalogItemsOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.list_catalog_items

        output, http_response = (
            capo_outposts._operations.outposts_olaf_service.list_catalog_items.list_catalog_items(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCatalogItems")
    )
    input_: capo_outposts.types.list_catalog_items_input.ListCatalogItemsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if item_class_filter is not None:
        input_["item_class_filter"] = item_class_filter
    if supported_storage_filter is not None:
        input_["supported_storage_filter"] = supported_storage_filter
    if ec2_family_filter is not None:
        input_["ec2_family_filter"] = ec2_family_filter

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