| Copyright | (c) 2013-2021 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 |
Amazonka.MarketplaceEntitlement.GetEntitlements
Description
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
This operation returns paginated results.
Synopsis
- data GetEntitlements = GetEntitlements' {}
- newGetEntitlements :: Text -> GetEntitlements
- getEntitlements_nextToken :: Lens' GetEntitlements (Maybe Text)
- getEntitlements_filter :: Lens' GetEntitlements (Maybe (HashMap GetEntitlementFilterName (NonEmpty Text)))
- getEntitlements_maxResults :: Lens' GetEntitlements (Maybe Int)
- getEntitlements_productCode :: Lens' GetEntitlements Text
- data GetEntitlementsResponse = GetEntitlementsResponse' {
- nextToken :: Maybe Text
- entitlements :: Maybe [Entitlement]
- httpStatus :: Int
- newGetEntitlementsResponse :: Int -> GetEntitlementsResponse
- getEntitlementsResponse_nextToken :: Lens' GetEntitlementsResponse (Maybe Text)
- getEntitlementsResponse_entitlements :: Lens' GetEntitlementsResponse (Maybe [Entitlement])
- getEntitlementsResponse_httpStatus :: Lens' GetEntitlementsResponse Int
Creating a Request
data GetEntitlements Source #
The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
See: newGetEntitlements smart constructor.
Constructors
| GetEntitlements' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GetEntitlements |
Create a value of GetEntitlements 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:nextToken:GetEntitlements', getEntitlements_nextToken - For paginated calls to GetEntitlements, pass the NextToken from the
previous GetEntitlementsResult.
$sel:filter':GetEntitlements', getEntitlements_filter - 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.
$sel:maxResults:GetEntitlements', getEntitlements_maxResults - The maximum number of items to retrieve from the GetEntitlements
operation. For pagination, use the NextToken field in subsequent calls
to GetEntitlements.
$sel:productCode:GetEntitlements', getEntitlements_productCode - 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.
Request Lenses
getEntitlements_nextToken :: Lens' GetEntitlements (Maybe Text) Source #
For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
getEntitlements_filter :: Lens' GetEntitlements (Maybe (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.
getEntitlements_maxResults :: 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.
getEntitlements_productCode :: 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
data GetEntitlementsResponse Source #
The GetEntitlementsRequest contains results from the GetEntitlements operation.
See: newGetEntitlementsResponse smart constructor.
Constructors
| GetEntitlementsResponse' | |
Fields
| |
Instances
newGetEntitlementsResponse Source #
Create a value of GetEntitlementsResponse 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:nextToken:GetEntitlements', getEntitlementsResponse_nextToken - 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.
$sel:entitlements:GetEntitlementsResponse', getEntitlementsResponse_entitlements - 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.
$sel:httpStatus:GetEntitlementsResponse', getEntitlementsResponse_httpStatus - The response's http status code.
Response Lenses
getEntitlementsResponse_nextToken :: 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.
getEntitlementsResponse_entitlements :: Lens' GetEntitlementsResponse (Maybe [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.
getEntitlementsResponse_httpStatus :: Lens' GetEntitlementsResponse Int Source #
The response's http status code.