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.APIGateway.GetApiKeys

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the current ApiKeys resource.

This operation returns paginated results.

Synopsis

data GetApiKeys = GetApiKeys' {
- customerId :: Maybe Text
- includeValues :: Maybe Bool
- limit :: Maybe Int
- nameQuery :: Maybe Text
- position :: Maybe Text
}
newGetApiKeys :: GetApiKeys
getApiKeys_customerId :: Lens' GetApiKeys (Maybe Text)
getApiKeys_includeValues :: Lens' GetApiKeys (Maybe Bool)
getApiKeys_limit :: Lens' GetApiKeys (Maybe Int)
getApiKeys_nameQuery :: Lens' GetApiKeys (Maybe Text)
getApiKeys_position :: Lens' GetApiKeys (Maybe Text)
data GetApiKeysResponse = GetApiKeysResponse' {
- items :: Maybe [ApiKey]
- position :: Maybe Text
- warnings :: Maybe [Text]
- httpStatus :: Int
}
newGetApiKeysResponse :: Int -> GetApiKeysResponse
getApiKeysResponse_items :: Lens' GetApiKeysResponse (Maybe [ApiKey])
getApiKeysResponse_position :: Lens' GetApiKeysResponse (Maybe Text)
getApiKeysResponse_warnings :: Lens' GetApiKeysResponse (Maybe [Text])
getApiKeysResponse_httpStatus :: Lens' GetApiKeysResponse Int

Creating a Request

data GetApiKeys Source #

A request to get information about the current ApiKeys resource.

See: newGetApiKeys smart constructor.

Constructors

GetApiKeys'

Fields

customerId :: Maybe Text
The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
includeValues :: Maybe Bool
A boolean flag to specify whether (true) or not (false) the result contains key values.
limit :: Maybe Int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
nameQuery :: Maybe Text
The name of queried API keys.
position :: Maybe Text
The current pagination position in the paged result set.

Instances

Instances details

ToHeaders GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toHeaders :: GetApiKeys -> [Header] #
ToPath GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toPath :: GetApiKeys -> ByteString #
ToQuery GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toQuery :: GetApiKeys -> QueryString #
AWSPager GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods page :: GetApiKeys -> AWSResponse GetApiKeys -> Maybe GetApiKeys #
AWSRequest GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type AWSResponse GetApiKeys # Methods request :: (Service -> Service) -> GetApiKeys -> Request GetApiKeys # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApiKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApiKeys))) #
Generic GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type Rep GetApiKeys :: Type -> Type # Methods from :: GetApiKeys -> Rep GetApiKeys x # to :: Rep GetApiKeys x -> GetApiKeys #
Read GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods readsPrec :: Int -> ReadS GetApiKeys # readList :: ReadS [GetApiKeys] # readPrec :: ReadPrec GetApiKeys # readListPrec :: ReadPrec [GetApiKeys] #
Show GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods showsPrec :: Int -> GetApiKeys -> ShowS # show :: GetApiKeys -> String # showList :: [GetApiKeys] -> ShowS #
NFData GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods rnf :: GetApiKeys -> () #
Eq GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods (==) :: GetApiKeys -> GetApiKeys -> Bool # (/=) :: GetApiKeys -> GetApiKeys -> Bool #
Hashable GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods hashWithSalt :: Int -> GetApiKeys -> Int # hash :: GetApiKeys -> Int #
type AWSResponse GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type AWSResponse GetApiKeys = GetApiKeysResponse
type Rep GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type Rep GetApiKeys = D1 ('MetaData "GetApiKeys" "Amazonka.APIGateway.GetApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetApiKeys'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "includeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nameQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGetApiKeys :: GetApiKeys Source #

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

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

$sel:includeValues:GetApiKeys', getApiKeys_includeValues - A boolean flag to specify whether (true) or not (false) the result contains key values.

GetApiKeys, getApiKeys_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:nameQuery:GetApiKeys', getApiKeys_nameQuery - The name of queried API keys.

GetApiKeys, getApiKeys_position - The current pagination position in the paged result set.

Request Lenses

getApiKeys_customerId :: Lens' GetApiKeys (Maybe Text) Source #

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

getApiKeys_includeValues :: Lens' GetApiKeys (Maybe Bool) Source #

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

getApiKeys_limit :: Lens' GetApiKeys (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getApiKeys_nameQuery :: Lens' GetApiKeys (Maybe Text) Source #

The name of queried API keys.

getApiKeys_position :: Lens' GetApiKeys (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

data GetApiKeysResponse Source #

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

See: newGetApiKeysResponse smart constructor.

Constructors

GetApiKeysResponse'
Fields items :: Maybe [ApiKey] The current page of elements from this collection. position :: Maybe Text warnings :: Maybe [Text] A list of warning messages logged during the import of API keys when the `failOnWarnings` option is set to true. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type Rep GetApiKeysResponse :: Type -> Type # Methods from :: GetApiKeysResponse -> Rep GetApiKeysResponse x # to :: Rep GetApiKeysResponse x -> GetApiKeysResponse #
Read GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods readsPrec :: Int -> ReadS GetApiKeysResponse # readList :: ReadS [GetApiKeysResponse] # readPrec :: ReadPrec GetApiKeysResponse # readListPrec :: ReadPrec [GetApiKeysResponse] #
Show GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods showsPrec :: Int -> GetApiKeysResponse -> ShowS # show :: GetApiKeysResponse -> String # showList :: [GetApiKeysResponse] -> ShowS #
NFData GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods rnf :: GetApiKeysResponse -> () #
Eq GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods (==) :: GetApiKeysResponse -> GetApiKeysResponse -> Bool # (/=) :: GetApiKeysResponse -> GetApiKeysResponse -> Bool #
type Rep GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type Rep GetApiKeysResponse = D1 ('MetaData "GetApiKeysResponse" "Amazonka.APIGateway.GetApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetApiKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiKey])) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetApiKeysResponse Source #

Arguments

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

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

GetApiKeysResponse, getApiKeysResponse_items - The current page of elements from this collection.

GetApiKeys, getApiKeysResponse_position - Undocumented member.

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

$sel:httpStatus:GetApiKeysResponse', getApiKeysResponse_httpStatus - The response's http status code.

Response Lenses

getApiKeysResponse_items :: Lens' GetApiKeysResponse (Maybe [ApiKey]) Source #

The current page of elements from this collection.

getApiKeysResponse_position :: Lens' GetApiKeysResponse (Maybe Text) Source #

Undocumented member.

getApiKeysResponse_warnings :: Lens' GetApiKeysResponse (Maybe [Text]) Source #

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

getApiKeysResponse_httpStatus :: Lens' GetApiKeysResponse Int Source #

The response's http status code.