Network.AWS.APIGateway.GetAPIKeys

Gets information about the current ApiKeys resource.

This operation returns paginated results.

Creating a Request

getAPIKeys :: GetAPIKeys

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

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

• gakIncludeValues - A boolean flag to specify whether (true ) or not (false ) the result contains key values.
• gakCustomerId - The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
• gakNameQuery - The name of queried API keys.
• gakLimit - The maximum number of returned results per page.
• gakPosition - The current pagination position in the paged result set.

data GetAPIKeys

A request to get information about the current ApiKeys resource.

See: getAPIKeys smart constructor.

Instances

Eq GetAPIKeys

Methods

(==) :: GetAPIKeys -> GetAPIKeys -> Bool

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

Data GetAPIKeys

Methods

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

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

toConstr :: GetAPIKeys -> Constr

dataTypeOf :: GetAPIKeys -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetAPIKeys

Methods

readsPrec :: Int -> ReadS GetAPIKeys

readList :: ReadS [GetAPIKeys]

readPrec :: ReadPrec GetAPIKeys

readListPrec :: ReadPrec [GetAPIKeys]

Show GetAPIKeys

Methods

showsPrec :: Int -> GetAPIKeys -> ShowS

show :: GetAPIKeys -> String

showList :: [GetAPIKeys] -> ShowS

Generic GetAPIKeys

Associated Types

type Rep GetAPIKeys :: * -> *

Methods

from :: GetAPIKeys -> Rep GetAPIKeys x

to :: Rep GetAPIKeys x -> GetAPIKeys

Hashable GetAPIKeys

Methods

hashWithSalt :: Int -> GetAPIKeys -> Int

hash :: GetAPIKeys -> Int

NFData GetAPIKeys

Methods

rnf :: GetAPIKeys -> ()

AWSPager GetAPIKeys

Methods

page :: GetAPIKeys -> Rs GetAPIKeys -> Maybe GetAPIKeys

AWSRequest GetAPIKeys

Associated Types

type Rs GetAPIKeys :: *

Methods

request :: GetAPIKeys -> Request GetAPIKeys

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

ToQuery GetAPIKeys

Methods

toQuery :: GetAPIKeys -> QueryString

ToPath GetAPIKeys

Methods

toPath :: GetAPIKeys -> ByteString

ToHeaders GetAPIKeys

Methods

toHeaders :: GetAPIKeys -> [Header]

type Rep GetAPIKeys

type Rep GetAPIKeys = D1 (MetaData "GetAPIKeys" "Network.AWS.APIGateway.GetAPIKeys" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetAPIKeys'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gakIncludeValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gakCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gakNameQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gakLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_gakPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs GetAPIKeys

type Rs GetAPIKeys = GetAPIKeysResponse

Request Lenses

gakIncludeValues :: Lens' GetAPIKeys (Maybe Bool)

A boolean flag to specify whether (true ) or not (false ) the result contains key values.

gakCustomerId :: Lens' GetAPIKeys (Maybe Text)

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

gakNameQuery :: Lens' GetAPIKeys (Maybe Text)

The name of queried API keys.

gakLimit :: Lens' GetAPIKeys (Maybe Int)

The maximum number of returned results per page.

gakPosition :: Lens' GetAPIKeys (Maybe Text)

The current pagination position in the paged result set.

Destructuring the Response

getAPIKeysResponse

Arguments

:: Int

gakrsResponseStatus

-> GetAPIKeysResponse

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

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

• gakrsItems - The current page of elements from this collection.
• gakrsWarnings - A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
• gakrsPosition - Undocumented member.
• gakrsResponseStatus - -- | The response status code.

data GetAPIKeysResponse

Represents a collection of API keys as represented by an ApiKeys resource.

Use API Keys

See: getAPIKeysResponse smart constructor.

Instances

Eq GetAPIKeysResponse

Methods

(==) :: GetAPIKeysResponse -> GetAPIKeysResponse -> Bool

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

Data GetAPIKeysResponse

Methods

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

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

toConstr :: GetAPIKeysResponse -> Constr

dataTypeOf :: GetAPIKeysResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetAPIKeysResponse

Methods

readsPrec :: Int -> ReadS GetAPIKeysResponse

readList :: ReadS [GetAPIKeysResponse]

readPrec :: ReadPrec GetAPIKeysResponse

readListPrec :: ReadPrec [GetAPIKeysResponse]

Show GetAPIKeysResponse

Methods

showsPrec :: Int -> GetAPIKeysResponse -> ShowS

show :: GetAPIKeysResponse -> String

showList :: [GetAPIKeysResponse] -> ShowS

Generic GetAPIKeysResponse

Associated Types

type Rep GetAPIKeysResponse :: * -> *

Methods

from :: GetAPIKeysResponse -> Rep GetAPIKeysResponse x

to :: Rep GetAPIKeysResponse x -> GetAPIKeysResponse

NFData GetAPIKeysResponse

Methods

rnf :: GetAPIKeysResponse -> ()

type Rep GetAPIKeysResponse

type Rep GetAPIKeysResponse = D1 (MetaData "GetAPIKeysResponse" "Network.AWS.APIGateway.GetAPIKeys" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetAPIKeysResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gakrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [APIKey]))) (S1 (MetaSel (Just Symbol "_gakrsWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_gakrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gakrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gakrsItems :: Lens' GetAPIKeysResponse [APIKey]

The current page of elements from this collection.

gakrsWarnings :: Lens' GetAPIKeysResponse [Text]

A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

gakrsPosition :: Lens' GetAPIKeysResponse (Maybe Text)

Undocumented member.

gakrsResponseStatus :: Lens' GetAPIKeysResponse Int

• - | The response status code.