Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
- getEntitlements :: Text -> GetEntitlements
- data GetEntitlements
- geNextToken :: Lens' GetEntitlements (Maybe Text)
- geFilter :: Lens' GetEntitlements (HashMap GetEntitlementFilterName (NonEmpty Text))
- geMaxResults :: Lens' GetEntitlements (Maybe Int)
- geProductCode :: Lens' GetEntitlements Text
- getEntitlementsResponse :: Int -> GetEntitlementsResponse
- data GetEntitlementsResponse
- gersNextToken :: Lens' GetEntitlementsResponse (Maybe Text)
- gersEntitlements :: Lens' GetEntitlementsResponse [Entitlement]
- gersResponseStatus :: Lens' GetEntitlementsResponse Int
Creating a Request
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 Source #
The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
See: getEntitlements
smart constructor.
Request Lenses
geNextToken :: Lens' GetEntitlements (Maybe Text) Source #
For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
geFilter :: Lens' GetEntitlements (HashMap GetEntitlementFilterName (NonEmpty Text)) Source #
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) Source #
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 Source #
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 Source #
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 Source #
The GetEntitlementsRequest contains results from the GetEntitlements operation.
See: getEntitlementsResponse
smart constructor.
Response Lenses
gersNextToken :: Lens' GetEntitlementsResponse (Maybe Text) Source #
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] Source #
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 Source #
- - | The response status code.