Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Outposts.ListCatalogItems

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data ListCatalogItems = ListCatalogItems' {
- eC2FamilyFilter :: Maybe [Text]
- itemClassFilter :: Maybe [CatalogItemClass]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- supportedStorageFilter :: Maybe [SupportedStorageEnum]
}
newListCatalogItems :: ListCatalogItems
listCatalogItems_eC2FamilyFilter :: Lens' ListCatalogItems (Maybe [Text])
listCatalogItems_itemClassFilter :: Lens' ListCatalogItems (Maybe [CatalogItemClass])
listCatalogItems_maxResults :: Lens' ListCatalogItems (Maybe Natural)
listCatalogItems_nextToken :: Lens' ListCatalogItems (Maybe Text)
listCatalogItems_supportedStorageFilter :: Lens' ListCatalogItems (Maybe [SupportedStorageEnum])
data ListCatalogItemsResponse = ListCatalogItemsResponse' {
- catalogItems :: Maybe [CatalogItem]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListCatalogItemsResponse :: Int -> ListCatalogItemsResponse
listCatalogItemsResponse_catalogItems :: Lens' ListCatalogItemsResponse (Maybe [CatalogItem])
listCatalogItemsResponse_nextToken :: Lens' ListCatalogItemsResponse (Maybe Text)
listCatalogItemsResponse_httpStatus :: Lens' ListCatalogItemsResponse Int

Creating a Request

data ListCatalogItems Source #

See: newListCatalogItems smart constructor.

Constructors

ListCatalogItems'
Fields eC2FamilyFilter :: Maybe [Text] Filters the results by EC2 family (for example, M5). itemClassFilter :: Maybe [CatalogItemClass] Filters the results by item class. maxResults :: Maybe Natural nextToken :: Maybe Text supportedStorageFilter :: Maybe [SupportedStorageEnum] Filters the results by storage option.

Instances

Instances details

ToHeaders ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods toHeaders :: ListCatalogItems -> [Header] #
ToPath ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods toPath :: ListCatalogItems -> ByteString #
ToQuery ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods toQuery :: ListCatalogItems -> QueryString #
AWSRequest ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Associated Types type AWSResponse ListCatalogItems # Methods request :: (Service -> Service) -> ListCatalogItems -> Request ListCatalogItems # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCatalogItems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCatalogItems))) #
Generic ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Associated Types type Rep ListCatalogItems :: Type -> Type # Methods from :: ListCatalogItems -> Rep ListCatalogItems x # to :: Rep ListCatalogItems x -> ListCatalogItems #
Read ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods readsPrec :: Int -> ReadS ListCatalogItems # readList :: ReadS [ListCatalogItems] # readPrec :: ReadPrec ListCatalogItems # readListPrec :: ReadPrec [ListCatalogItems] #
Show ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods showsPrec :: Int -> ListCatalogItems -> ShowS # show :: ListCatalogItems -> String # showList :: [ListCatalogItems] -> ShowS #
NFData ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods rnf :: ListCatalogItems -> () #
Eq ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods (==) :: ListCatalogItems -> ListCatalogItems -> Bool # (/=) :: ListCatalogItems -> ListCatalogItems -> Bool #
Hashable ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods hashWithSalt :: Int -> ListCatalogItems -> Int # hash :: ListCatalogItems -> Int #
type AWSResponse ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems type AWSResponse ListCatalogItems = ListCatalogItemsResponse
type Rep ListCatalogItems Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems type Rep ListCatalogItems = D1 ('MetaData "ListCatalogItems" "Amazonka.Outposts.ListCatalogItems" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "ListCatalogItems'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eC2FamilyFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "itemClassFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CatalogItemClass]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "supportedStorageFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SupportedStorageEnum]))))))

newListCatalogItems :: ListCatalogItems Source #

Create a value of ListCatalogItems with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eC2FamilyFilter:ListCatalogItems', listCatalogItems_eC2FamilyFilter - Filters the results by EC2 family (for example, M5).

$sel:itemClassFilter:ListCatalogItems', listCatalogItems_itemClassFilter - Filters the results by item class.

$sel:maxResults:ListCatalogItems', listCatalogItems_maxResults - Undocumented member.

ListCatalogItems, listCatalogItems_nextToken - Undocumented member.

$sel:supportedStorageFilter:ListCatalogItems', listCatalogItems_supportedStorageFilter - Filters the results by storage option.

Request Lenses

listCatalogItems_eC2FamilyFilter :: Lens' ListCatalogItems (Maybe [Text]) Source #

Filters the results by EC2 family (for example, M5).

listCatalogItems_itemClassFilter :: Lens' ListCatalogItems (Maybe [CatalogItemClass]) Source #

Filters the results by item class.

listCatalogItems_maxResults :: Lens' ListCatalogItems (Maybe Natural) Source #

Undocumented member.

listCatalogItems_nextToken :: Lens' ListCatalogItems (Maybe Text) Source #

Undocumented member.

listCatalogItems_supportedStorageFilter :: Lens' ListCatalogItems (Maybe [SupportedStorageEnum]) Source #

Filters the results by storage option.

Destructuring the Response

data ListCatalogItemsResponse Source #

See: newListCatalogItemsResponse smart constructor.

Constructors

ListCatalogItemsResponse'
Fields catalogItems :: Maybe [CatalogItem] Information about the catalog items. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Associated Types type Rep ListCatalogItemsResponse :: Type -> Type # Methods from :: ListCatalogItemsResponse -> Rep ListCatalogItemsResponse x # to :: Rep ListCatalogItemsResponse x -> ListCatalogItemsResponse #
Read ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods readsPrec :: Int -> ReadS ListCatalogItemsResponse # readList :: ReadS [ListCatalogItemsResponse] # readPrec :: ReadPrec ListCatalogItemsResponse # readListPrec :: ReadPrec [ListCatalogItemsResponse] #
Show ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods showsPrec :: Int -> ListCatalogItemsResponse -> ShowS # show :: ListCatalogItemsResponse -> String # showList :: [ListCatalogItemsResponse] -> ShowS #
NFData ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods rnf :: ListCatalogItemsResponse -> () #
Eq ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems Methods (==) :: ListCatalogItemsResponse -> ListCatalogItemsResponse -> Bool # (/=) :: ListCatalogItemsResponse -> ListCatalogItemsResponse -> Bool #
type Rep ListCatalogItemsResponse Source #
Instance details Defined in Amazonka.Outposts.ListCatalogItems type Rep ListCatalogItemsResponse = D1 ('MetaData "ListCatalogItemsResponse" "Amazonka.Outposts.ListCatalogItems" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "ListCatalogItemsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "catalogItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CatalogItem])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCatalogItemsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListCatalogItemsResponse'`
-> ListCatalogItemsResponse

Create a value of ListCatalogItemsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:catalogItems:ListCatalogItemsResponse', listCatalogItemsResponse_catalogItems - Information about the catalog items.

ListCatalogItems, listCatalogItemsResponse_nextToken - Undocumented member.

$sel:httpStatus:ListCatalogItemsResponse', listCatalogItemsResponse_httpStatus - The response's http status code.

Response Lenses

listCatalogItemsResponse_catalogItems :: Lens' ListCatalogItemsResponse (Maybe [CatalogItem]) Source #

Information about the catalog items.

listCatalogItemsResponse_nextToken :: Lens' ListCatalogItemsResponse (Maybe Text) Source #

Undocumented member.

listCatalogItemsResponse_httpStatus :: Lens' ListCatalogItemsResponse Int Source #

The response's http status code.