Amazonka.MarketplaceEntitlement.GetEntitlements

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.

Creating a Request

data GetEntitlements

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

See: newGetEntitlements smart constructor.

Constructors

GetEntitlements'

Fields

• filter' :: Maybe (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.

• maxResults :: Maybe Int

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

• nextToken :: Maybe Text

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

• productCode :: 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.

Instances

ToJSON GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

toJSON :: GetEntitlements -> Value

toEncoding :: GetEntitlements -> Encoding

toJSONList :: [GetEntitlements] -> Value

toEncodingList :: [GetEntitlements] -> Encoding

ToHeaders GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

toHeaders :: GetEntitlements -> [Header]

ToPath GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

toPath :: GetEntitlements -> ByteString

ToQuery GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

toQuery :: GetEntitlements -> QueryString

AWSPager GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

page :: GetEntitlements -> AWSResponse GetEntitlements -> Maybe GetEntitlements

AWSRequest GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type AWSResponse GetEntitlements

Methods

request :: (Service -> Service) -> GetEntitlements -> Request GetEntitlements

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetEntitlements -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEntitlements)))

Generic GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type Rep GetEntitlements :: Type -> Type

Methods

from :: GetEntitlements -> Rep GetEntitlements x

to :: Rep GetEntitlements x -> GetEntitlements

Read GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

readsPrec :: Int -> ReadS GetEntitlements

readList :: ReadS [GetEntitlements]

readPrec :: ReadPrec GetEntitlements

readListPrec :: ReadPrec [GetEntitlements]

Show GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

showsPrec :: Int -> GetEntitlements -> ShowS

show :: GetEntitlements -> String

showList :: [GetEntitlements] -> ShowS

NFData GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

rnf :: GetEntitlements -> ()

Eq GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

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

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

Hashable GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

hashWithSalt :: Int -> GetEntitlements -> Int

hash :: GetEntitlements -> Int

type AWSResponse GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type AWSResponse GetEntitlements = GetEntitlementsResponse

type Rep GetEntitlements

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type Rep GetEntitlements = D1 ('MetaData "GetEntitlements" "Amazonka.MarketplaceEntitlement.GetEntitlements" "amazonka-marketplace-entitlement-2.0-KGpdCcitMPM9yhrIGqywn9" 'False) (C1 ('MetaCons "GetEntitlements'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap GetEntitlementFilterName (NonEmpty Text)))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetEntitlements

Arguments

:: Text

GetEntitlements

-> 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: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.

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

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_filter :: Lens' GetEntitlements (Maybe (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.

getEntitlements_maxResults :: 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.

getEntitlements_nextToken :: Lens' GetEntitlements (Maybe Text)

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

getEntitlements_productCode :: 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

data GetEntitlementsResponse

The GetEntitlementsRequest contains results from the GetEntitlements operation.

See: newGetEntitlementsResponse smart constructor.

Constructors

GetEntitlementsResponse'

Fields

• entitlements :: Maybe [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.

• nextToken :: 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type Rep GetEntitlementsResponse :: Type -> Type

Methods

from :: GetEntitlementsResponse -> Rep GetEntitlementsResponse x

to :: Rep GetEntitlementsResponse x -> GetEntitlementsResponse

Read GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

readsPrec :: Int -> ReadS GetEntitlementsResponse

readList :: ReadS [GetEntitlementsResponse]

readPrec :: ReadPrec GetEntitlementsResponse

readListPrec :: ReadPrec [GetEntitlementsResponse]

Show GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

showsPrec :: Int -> GetEntitlementsResponse -> ShowS

show :: GetEntitlementsResponse -> String

showList :: [GetEntitlementsResponse] -> ShowS

NFData GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

rnf :: GetEntitlementsResponse -> ()

Eq GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

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

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

type Rep GetEntitlementsResponse

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type Rep GetEntitlementsResponse = D1 ('MetaData "GetEntitlementsResponse" "Amazonka.MarketplaceEntitlement.GetEntitlements" "amazonka-marketplace-entitlement-2.0-KGpdCcitMPM9yhrIGqywn9" 'False) (C1 ('MetaCons "GetEntitlementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitlements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Entitlement])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetEntitlementsResponse

Arguments

:: Int

$sel:httpStatus:GetEntitlementsResponse'

-> GetEntitlementsResponse

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: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.

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:httpStatus:GetEntitlementsResponse', getEntitlementsResponse_httpStatus - The response's http status code.

Response Lenses

getEntitlementsResponse_entitlements :: Lens' GetEntitlementsResponse (Maybe [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.

getEntitlementsResponse_nextToken :: 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.

getEntitlementsResponse_httpStatus :: Lens' GetEntitlementsResponse Int

The response's http status code.