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.MarketplaceCatalog.ListEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides the list of entities of a given type.

Synopsis

data ListEntities = ListEntities' {
- filterList :: Maybe (NonEmpty Filter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sort :: Maybe Sort
- catalog :: Text
- entityType :: Text
}
newListEntities :: Text -> Text -> ListEntities
listEntities_filterList :: Lens' ListEntities (Maybe (NonEmpty Filter))
listEntities_maxResults :: Lens' ListEntities (Maybe Natural)
listEntities_nextToken :: Lens' ListEntities (Maybe Text)
listEntities_sort :: Lens' ListEntities (Maybe Sort)
listEntities_catalog :: Lens' ListEntities Text
listEntities_entityType :: Lens' ListEntities Text
data ListEntitiesResponse = ListEntitiesResponse' {
- entitySummaryList :: Maybe [EntitySummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListEntitiesResponse :: Int -> ListEntitiesResponse
listEntitiesResponse_entitySummaryList :: Lens' ListEntitiesResponse (Maybe [EntitySummary])
listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text)
listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int

Creating a Request

data ListEntities Source #

See: newListEntities smart constructor.

Constructors

ListEntities'

Fields

filterList :: Maybe (NonEmpty Filter)
An array of filter objects. Each filter object contains two attributes, filterName and filterValues.
maxResults :: Maybe Natural
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
nextToken :: Maybe Text
The value of the next token, if it exists. Null if there are no more results.
sort :: Maybe Sort
An object that contains two attributes, SortBy and SortOrder.
catalog :: Text
The catalog related to the request. Fixed value: AWSMarketplace
entityType :: Text
The type of entities to retrieve.

Instances

Instances details

ToJSON ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods toJSON :: ListEntities -> Value # toEncoding :: ListEntities -> Encoding # toJSONList :: [ListEntities] -> Value # toEncodingList :: [ListEntities] -> Encoding #
ToHeaders ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods toHeaders :: ListEntities -> [Header] #
ToPath ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods toPath :: ListEntities -> ByteString #
ToQuery ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods toQuery :: ListEntities -> QueryString #
AWSRequest ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Associated Types type AWSResponse ListEntities # Methods request :: (Service -> Service) -> ListEntities -> Request ListEntities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListEntities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEntities))) #
Generic ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Associated Types type Rep ListEntities :: Type -> Type # Methods from :: ListEntities -> Rep ListEntities x # to :: Rep ListEntities x -> ListEntities #
Read ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods readsPrec :: Int -> ReadS ListEntities # readList :: ReadS [ListEntities] # readPrec :: ReadPrec ListEntities # readListPrec :: ReadPrec [ListEntities] #
Show ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods showsPrec :: Int -> ListEntities -> ShowS # show :: ListEntities -> String # showList :: [ListEntities] -> ShowS #
NFData ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods rnf :: ListEntities -> () #
Eq ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods (==) :: ListEntities -> ListEntities -> Bool # (/=) :: ListEntities -> ListEntities -> Bool #
Hashable ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods hashWithSalt :: Int -> ListEntities -> Int # hash :: ListEntities -> Int #
type AWSResponse ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities type AWSResponse ListEntities = ListEntitiesResponse
type Rep ListEntities Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities type Rep ListEntities = D1 ('MetaData "ListEntities" "Amazonka.MarketplaceCatalog.ListEntities" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "ListEntities'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Sort)) :: (S1 ('MetaSel ('Just "catalog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListEntities Source #

Arguments

:: Text	`$sel:catalog:ListEntities'`
-> Text	`ListEntities`
-> ListEntities

Create a value of ListEntities 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:filterList:ListEntities', listEntities_filterList - An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

$sel:maxResults:ListEntities', listEntities_maxResults - Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

ListEntities, listEntities_nextToken - The value of the next token, if it exists. Null if there are no more results.

$sel:sort:ListEntities', listEntities_sort - An object that contains two attributes, SortBy and SortOrder.

$sel:catalog:ListEntities', listEntities_catalog - The catalog related to the request. Fixed value: AWSMarketplace

ListEntities, listEntities_entityType - The type of entities to retrieve.

Request Lenses

listEntities_filterList :: Lens' ListEntities (Maybe (NonEmpty Filter)) Source #

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

listEntities_maxResults :: Lens' ListEntities (Maybe Natural) Source #

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

listEntities_nextToken :: Lens' ListEntities (Maybe Text) Source #

The value of the next token, if it exists. Null if there are no more results.

listEntities_sort :: Lens' ListEntities (Maybe Sort) Source #

An object that contains two attributes, SortBy and SortOrder.

listEntities_catalog :: Lens' ListEntities Text Source #

The catalog related to the request. Fixed value: AWSMarketplace

listEntities_entityType :: Lens' ListEntities Text Source #

The type of entities to retrieve.

Destructuring the Response

data ListEntitiesResponse Source #

See: newListEntitiesResponse smart constructor.

Constructors

ListEntitiesResponse'
Fields entitySummaryList :: Maybe [EntitySummary] Array of `EntitySummary` object. nextToken :: Maybe Text The value of the next token if it exists. Null if there is no more result. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Associated Types type Rep ListEntitiesResponse :: Type -> Type # Methods from :: ListEntitiesResponse -> Rep ListEntitiesResponse x # to :: Rep ListEntitiesResponse x -> ListEntitiesResponse #
Read ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods readsPrec :: Int -> ReadS ListEntitiesResponse # readList :: ReadS [ListEntitiesResponse] # readPrec :: ReadPrec ListEntitiesResponse # readListPrec :: ReadPrec [ListEntitiesResponse] #
Show ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods showsPrec :: Int -> ListEntitiesResponse -> ShowS # show :: ListEntitiesResponse -> String # showList :: [ListEntitiesResponse] -> ShowS #
NFData ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods rnf :: ListEntitiesResponse -> () #
Eq ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities Methods (==) :: ListEntitiesResponse -> ListEntitiesResponse -> Bool # (/=) :: ListEntitiesResponse -> ListEntitiesResponse -> Bool #
type Rep ListEntitiesResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.ListEntities type Rep ListEntitiesResponse = D1 ('MetaData "ListEntitiesResponse" "Amazonka.MarketplaceCatalog.ListEntities" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "ListEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitySummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntitySummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntitiesResponse Source #

Arguments

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

Create a value of ListEntitiesResponse 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:entitySummaryList:ListEntitiesResponse', listEntitiesResponse_entitySummaryList - Array of EntitySummary object.

ListEntities, listEntitiesResponse_nextToken - The value of the next token if it exists. Null if there is no more result.

$sel:httpStatus:ListEntitiesResponse', listEntitiesResponse_httpStatus - The response's http status code.

Response Lenses

listEntitiesResponse_entitySummaryList :: Lens' ListEntitiesResponse (Maybe [EntitySummary]) Source #

Array of EntitySummary object.

listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text) Source #

The value of the next token if it exists. Null if there is no more result.

listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int Source #

The response's http status code.