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.DeviceFarm.GetOfferingStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

This operation returns paginated results.

Creating a Request

data GetOfferingStatus Source #

Represents the request to retrieve the offering status for the specified customer or account.

See: newGetOfferingStatus smart constructor.

Constructors

GetOfferingStatus'
Fields nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Instances

Instances details

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

newGetOfferingStatus :: GetOfferingStatus Source #

Create a value of GetOfferingStatus 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:

GetOfferingStatus, getOfferingStatus_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Request Lenses

getOfferingStatus_nextToken :: Lens' GetOfferingStatus (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Destructuring the Response

data GetOfferingStatusResponse Source #

Returns the status result for a device offering.

See: newGetOfferingStatusResponse smart constructor.

Constructors

GetOfferingStatusResponse'

Fields

current :: Maybe (HashMap Text OfferingStatus)
When specified, gets the offering status for the current period.
nextPeriod :: Maybe (HashMap Text OfferingStatus)
When specified, gets the offering status for the next period.
nextToken :: Maybe Text
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus Associated Types type Rep GetOfferingStatusResponse :: Type -> Type # Methods from :: GetOfferingStatusResponse -> Rep GetOfferingStatusResponse x # to :: Rep GetOfferingStatusResponse x -> GetOfferingStatusResponse #
Read GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus Methods readsPrec :: Int -> ReadS GetOfferingStatusResponse # readList :: ReadS [GetOfferingStatusResponse] # readPrec :: ReadPrec GetOfferingStatusResponse # readListPrec :: ReadPrec [GetOfferingStatusResponse] #
Show GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus Methods showsPrec :: Int -> GetOfferingStatusResponse -> ShowS # show :: GetOfferingStatusResponse -> String # showList :: [GetOfferingStatusResponse] -> ShowS #
NFData GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus Methods rnf :: GetOfferingStatusResponse -> () #
Eq GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus Methods (==) :: GetOfferingStatusResponse -> GetOfferingStatusResponse -> Bool # (/=) :: GetOfferingStatusResponse -> GetOfferingStatusResponse -> Bool #
type Rep GetOfferingStatusResponse Source #
Instance details Defined in Amazonka.DeviceFarm.GetOfferingStatus type Rep GetOfferingStatusResponse = D1 ('MetaData "GetOfferingStatusResponse" "Amazonka.DeviceFarm.GetOfferingStatus" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "GetOfferingStatusResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "current") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text OfferingStatus))) :: S1 ('MetaSel ('Just "nextPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text OfferingStatus)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetOfferingStatusResponse Source #

Arguments

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

Create a value of GetOfferingStatusResponse 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:current:GetOfferingStatusResponse', getOfferingStatusResponse_current - When specified, gets the offering status for the current period.

$sel:nextPeriod:GetOfferingStatusResponse', getOfferingStatusResponse_nextPeriod - When specified, gets the offering status for the next period.

GetOfferingStatus, getOfferingStatusResponse_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:httpStatus:GetOfferingStatusResponse', getOfferingStatusResponse_httpStatus - The response's http status code.

Response Lenses

getOfferingStatusResponse_current :: Lens' GetOfferingStatusResponse (Maybe (HashMap Text OfferingStatus)) Source #

When specified, gets the offering status for the current period.

getOfferingStatusResponse_nextPeriod :: Lens' GetOfferingStatusResponse (Maybe (HashMap Text OfferingStatus)) Source #

When specified, gets the offering status for the next period.

getOfferingStatusResponse_nextToken :: Lens' GetOfferingStatusResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

getOfferingStatusResponse_httpStatus :: Lens' GetOfferingStatusResponse Int Source #

The response's http status code.