Network.AWS.MarketplaceEntitlement.GetEntitlements

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

Creating a Request

getEntitlements

Arguments

:: Text

geProductCode

-> GetEntitlements

Creates a value of GetEntitlements with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• geNextToken - For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
• geFilter - Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.
• geMaxResults - The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.
• geProductCode - Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

data GetEntitlements

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

See: getEntitlements smart constructor.

Instances

Eq GetEntitlements

Methods

(==) :: GetEntitlements -> GetEntitlements -> Bool

(/=) :: GetEntitlements -> GetEntitlements -> Bool

Data GetEntitlements

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetEntitlements -> c GetEntitlements

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetEntitlements

toConstr :: GetEntitlements -> Constr

dataTypeOf :: GetEntitlements -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetEntitlements)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetEntitlements)

gmapT :: (forall b. Data b => b -> b) -> GetEntitlements -> GetEntitlements

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetEntitlements -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetEntitlements -> r

gmapQ :: (forall d. Data d => d -> u) -> GetEntitlements -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetEntitlements -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetEntitlements -> m GetEntitlements

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetEntitlements -> m GetEntitlements

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetEntitlements -> m GetEntitlements

Read GetEntitlements

Methods

readsPrec :: Int -> ReadS GetEntitlements

readList :: ReadS [GetEntitlements]

readPrec :: ReadPrec GetEntitlements

readListPrec :: ReadPrec [GetEntitlements]

Show GetEntitlements

Methods

showsPrec :: Int -> GetEntitlements -> ShowS

show :: GetEntitlements -> String

showList :: [GetEntitlements] -> ShowS

Generic GetEntitlements

Associated Types

type Rep GetEntitlements :: * -> *

Methods

from :: GetEntitlements -> Rep GetEntitlements x

to :: Rep GetEntitlements x -> GetEntitlements

Hashable GetEntitlements

Methods

hashWithSalt :: Int -> GetEntitlements -> Int

hash :: GetEntitlements -> Int

ToJSON GetEntitlements

Methods

toJSON :: GetEntitlements -> Value

toEncoding :: GetEntitlements -> Encoding

toJSONList :: [GetEntitlements] -> Value

toEncodingList :: [GetEntitlements] -> Encoding

NFData GetEntitlements

Methods

rnf :: GetEntitlements -> ()

AWSRequest GetEntitlements

Associated Types

type Rs GetEntitlements :: *

Methods

request :: GetEntitlements -> Request GetEntitlements

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetEntitlements -> ClientResponse -> m (Response GetEntitlements)

ToHeaders GetEntitlements

Methods

toHeaders :: GetEntitlements -> [Header]

ToPath GetEntitlements

Methods

toPath :: GetEntitlements -> ByteString

ToQuery GetEntitlements

Methods

toQuery :: GetEntitlements -> QueryString

type Rep GetEntitlements

type Rep GetEntitlements = D1 * (MetaData "GetEntitlements" "Network.AWS.MarketplaceEntitlement.GetEntitlements" "amazonka-marketplace-entitlement-1.6.0-5CWUo1Wi53RGG1H4JXPUL5" False) (C1 * (MetaCons "GetEntitlements'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_geNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_geFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map GetEntitlementFilterName (List1 Text)))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_geMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_geProductCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs GetEntitlements

type Rs GetEntitlements = GetEntitlementsResponse

Request Lenses

geNextToken :: Lens' GetEntitlements (Maybe Text)

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

geFilter :: Lens' GetEntitlements (HashMap GetEntitlementFilterName (NonEmpty Text))

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

geMaxResults :: Lens' GetEntitlements (Maybe Int)

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

geProductCode :: Lens' GetEntitlements Text

Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

Destructuring the Response

getEntitlementsResponse

Arguments

:: Int

gersResponseStatus

-> GetEntitlementsResponse

Creates a value of GetEntitlementsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gersNextToken - For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.
• gersEntitlements - The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.
• gersResponseStatus - -- | The response status code.

data GetEntitlementsResponse

The GetEntitlementsRequest contains results from the GetEntitlements operation.

See: getEntitlementsResponse smart constructor.

Instances

Eq GetEntitlementsResponse

Methods

(==) :: GetEntitlementsResponse -> GetEntitlementsResponse -> Bool

(/=) :: GetEntitlementsResponse -> GetEntitlementsResponse -> Bool

Data GetEntitlementsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetEntitlementsResponse -> c GetEntitlementsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetEntitlementsResponse

toConstr :: GetEntitlementsResponse -> Constr

dataTypeOf :: GetEntitlementsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetEntitlementsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetEntitlementsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetEntitlementsResponse -> GetEntitlementsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetEntitlementsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetEntitlementsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetEntitlementsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetEntitlementsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetEntitlementsResponse -> m GetEntitlementsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetEntitlementsResponse -> m GetEntitlementsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetEntitlementsResponse -> m GetEntitlementsResponse

Read GetEntitlementsResponse

Methods

readsPrec :: Int -> ReadS GetEntitlementsResponse

readList :: ReadS [GetEntitlementsResponse]

readPrec :: ReadPrec GetEntitlementsResponse

readListPrec :: ReadPrec [GetEntitlementsResponse]

Show GetEntitlementsResponse

Methods

showsPrec :: Int -> GetEntitlementsResponse -> ShowS

show :: GetEntitlementsResponse -> String

showList :: [GetEntitlementsResponse] -> ShowS

Generic GetEntitlementsResponse

Associated Types

type Rep GetEntitlementsResponse :: * -> *

Methods

from :: GetEntitlementsResponse -> Rep GetEntitlementsResponse x

to :: Rep GetEntitlementsResponse x -> GetEntitlementsResponse

NFData GetEntitlementsResponse

Methods

rnf :: GetEntitlementsResponse -> ()

type Rep GetEntitlementsResponse

type Rep GetEntitlementsResponse = D1 * (MetaData "GetEntitlementsResponse" "Network.AWS.MarketplaceEntitlement.GetEntitlements" "amazonka-marketplace-entitlement-1.6.0-5CWUo1Wi53RGG1H4JXPUL5" False) (C1 * (MetaCons "GetEntitlementsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersEntitlements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Entitlement]))) (S1 * (MetaSel (Just Symbol "_gersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

gersNextToken :: Lens' GetEntitlementsResponse (Maybe Text)

For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

gersEntitlements :: Lens' GetEntitlementsResponse [Entitlement]

The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

gersResponseStatus :: Lens' GetEntitlementsResponse Int

• - | The response status code.