Network.AWS.APIGateway.GetUsagePlans

Gets all the usage plans of the caller's account.

This operation returns paginated results.

Creating a Request

getUsagePlans :: GetUsagePlans

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

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

• gupKeyId - The identifier of the API key associated with the usage plans.
• gupLimit - The maximum number of returned results per page.
• gupPosition - The current pagination position in the paged result set.

data GetUsagePlans

The GET request to get all the usage plans of the caller's account.

See: getUsagePlans smart constructor.

Instances

Eq GetUsagePlans

Methods

(==) :: GetUsagePlans -> GetUsagePlans -> Bool

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

Data GetUsagePlans

Methods

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

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

toConstr :: GetUsagePlans -> Constr

dataTypeOf :: GetUsagePlans -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetUsagePlans

Methods

readsPrec :: Int -> ReadS GetUsagePlans

readList :: ReadS [GetUsagePlans]

readPrec :: ReadPrec GetUsagePlans

readListPrec :: ReadPrec [GetUsagePlans]

Show GetUsagePlans

Methods

showsPrec :: Int -> GetUsagePlans -> ShowS

show :: GetUsagePlans -> String

showList :: [GetUsagePlans] -> ShowS

Generic GetUsagePlans

Associated Types

type Rep GetUsagePlans :: * -> *

Methods

from :: GetUsagePlans -> Rep GetUsagePlans x

to :: Rep GetUsagePlans x -> GetUsagePlans

Hashable GetUsagePlans

Methods

hashWithSalt :: Int -> GetUsagePlans -> Int

hash :: GetUsagePlans -> Int

NFData GetUsagePlans

Methods

rnf :: GetUsagePlans -> ()

AWSPager GetUsagePlans

Methods

page :: GetUsagePlans -> Rs GetUsagePlans -> Maybe GetUsagePlans

AWSRequest GetUsagePlans

Associated Types

type Rs GetUsagePlans :: *

Methods

request :: GetUsagePlans -> Request GetUsagePlans

response :: MonadResource m => Logger -> Service -> Proxy * GetUsagePlans -> ClientResponse -> m (Response GetUsagePlans)

ToQuery GetUsagePlans

Methods

toQuery :: GetUsagePlans -> QueryString

ToPath GetUsagePlans

Methods

toPath :: GetUsagePlans -> ByteString

ToHeaders GetUsagePlans

Methods

toHeaders :: GetUsagePlans -> [Header]

type Rep GetUsagePlans

type Rep GetUsagePlans = D1 (MetaData "GetUsagePlans" "Network.AWS.APIGateway.GetUsagePlans" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetUsagePlans'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gupKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gupLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_gupPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs GetUsagePlans

type Rs GetUsagePlans = GetUsagePlansResponse

Request Lenses

gupKeyId :: Lens' GetUsagePlans (Maybe Text)

The identifier of the API key associated with the usage plans.

gupLimit :: Lens' GetUsagePlans (Maybe Int)

The maximum number of returned results per page.

gupPosition :: Lens' GetUsagePlans (Maybe Text)

The current pagination position in the paged result set.

Destructuring the Response

getUsagePlansResponse

Arguments

:: Int

guprsResponseStatus

-> GetUsagePlansResponse

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

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

• guprsItems - The current page of elements from this collection.
• guprsPosition - Undocumented member.
• guprsResponseStatus - -- | The response status code.

data GetUsagePlansResponse

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans

See: getUsagePlansResponse smart constructor.

Instances

Eq GetUsagePlansResponse

Methods

(==) :: GetUsagePlansResponse -> GetUsagePlansResponse -> Bool

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

Data GetUsagePlansResponse

Methods

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

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

toConstr :: GetUsagePlansResponse -> Constr

dataTypeOf :: GetUsagePlansResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetUsagePlansResponse

Methods

readsPrec :: Int -> ReadS GetUsagePlansResponse

readList :: ReadS [GetUsagePlansResponse]

readPrec :: ReadPrec GetUsagePlansResponse

readListPrec :: ReadPrec [GetUsagePlansResponse]

Show GetUsagePlansResponse

Methods

showsPrec :: Int -> GetUsagePlansResponse -> ShowS

show :: GetUsagePlansResponse -> String

showList :: [GetUsagePlansResponse] -> ShowS

Generic GetUsagePlansResponse

Associated Types

type Rep GetUsagePlansResponse :: * -> *

Methods

from :: GetUsagePlansResponse -> Rep GetUsagePlansResponse x

to :: Rep GetUsagePlansResponse x -> GetUsagePlansResponse

NFData GetUsagePlansResponse

Methods

rnf :: GetUsagePlansResponse -> ()

type Rep GetUsagePlansResponse

type Rep GetUsagePlansResponse = D1 (MetaData "GetUsagePlansResponse" "Network.AWS.APIGateway.GetUsagePlans" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetUsagePlansResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_guprsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsagePlan]))) ((:*:) (S1 (MetaSel (Just Symbol "_guprsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_guprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

guprsItems :: Lens' GetUsagePlansResponse [UsagePlan]

The current page of elements from this collection.

guprsPosition :: Lens' GetUsagePlansResponse (Maybe Text)

Undocumented member.

guprsResponseStatus :: Lens' GetUsagePlansResponse Int

• - | The response status code.