Network.AWS.APIGateway.GetRestAPI

Lists the RestApi resource in the collection.

Creating a Request

getRestAPI

Arguments

:: Text

graRestAPIId

-> GetRestAPI

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

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

• graRestAPIId - [Required] The string identifier of the associated RestApi .

data GetRestAPI

The GET request to list an existing RestApi defined for your collection.

See: getRestAPI smart constructor.

Instances

Eq GetRestAPI

Methods

(==) :: GetRestAPI -> GetRestAPI -> Bool

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

Data GetRestAPI

Methods

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

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

toConstr :: GetRestAPI -> Constr

dataTypeOf :: GetRestAPI -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetRestAPI

Methods

readsPrec :: Int -> ReadS GetRestAPI

readList :: ReadS [GetRestAPI]

readPrec :: ReadPrec GetRestAPI

readListPrec :: ReadPrec [GetRestAPI]

Show GetRestAPI

Methods

showsPrec :: Int -> GetRestAPI -> ShowS

show :: GetRestAPI -> String

showList :: [GetRestAPI] -> ShowS

Generic GetRestAPI

Associated Types

type Rep GetRestAPI :: * -> *

Methods

from :: GetRestAPI -> Rep GetRestAPI x

to :: Rep GetRestAPI x -> GetRestAPI

Hashable GetRestAPI

Methods

hashWithSalt :: Int -> GetRestAPI -> Int

hash :: GetRestAPI -> Int

NFData GetRestAPI

Methods

rnf :: GetRestAPI -> ()

AWSRequest GetRestAPI

Associated Types

type Rs GetRestAPI :: *

Methods

request :: GetRestAPI -> Request GetRestAPI

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetRestAPI -> ClientResponse -> m (Response GetRestAPI)

ToHeaders GetRestAPI

Methods

toHeaders :: GetRestAPI -> [Header]

ToPath GetRestAPI

Methods

toPath :: GetRestAPI -> ByteString

ToQuery GetRestAPI

Methods

toQuery :: GetRestAPI -> QueryString

type Rep GetRestAPI

type Rep GetRestAPI = D1 * (MetaData "GetRestAPI" "Network.AWS.APIGateway.GetRestAPI" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" True) (C1 * (MetaCons "GetRestAPI'" PrefixI True) (S1 * (MetaSel (Just Symbol "_graRestAPIId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs GetRestAPI

type Rs GetRestAPI = RestAPI

Request Lenses

graRestAPIId :: Lens' GetRestAPI Text

Required

The string identifier of the associated RestApi .

Destructuring the Response

restAPI :: RestAPI

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

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

• raMinimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
• raBinaryMediaTypes - The list of binary media types supported by the RestApi . By default, the RestApi supports only UTF-8-encoded text payloads.
• raWarnings - The warning messages reported when failonwarnings is turned on during API import.
• raCreatedDate - The timestamp when the API was created.
• raName - The API's name.
• raVersion - A version identifier for the API.
• raApiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: * HEADER to read the API key from the X-API-Key header of a request. * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
• raId - The API's identifier. This identifier is unique across all of your APIs in API Gateway.
• raPolicy - Method
• raEndpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
• raDescription - The API's description.

data RestAPI

Represents a REST API.

Create an API

See: restAPI smart constructor.

Instances

Eq RestAPI

Methods

(==) :: RestAPI -> RestAPI -> Bool

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

Data RestAPI

Methods

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

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

toConstr :: RestAPI -> Constr

dataTypeOf :: RestAPI -> DataType

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

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

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

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

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

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

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

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

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

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

Read RestAPI

Methods

readsPrec :: Int -> ReadS RestAPI

readList :: ReadS [RestAPI]

readPrec :: ReadPrec RestAPI

readListPrec :: ReadPrec [RestAPI]

Show RestAPI

Methods

showsPrec :: Int -> RestAPI -> ShowS

show :: RestAPI -> String

showList :: [RestAPI] -> ShowS

Generic RestAPI

Associated Types

type Rep RestAPI :: * -> *

Methods

from :: RestAPI -> Rep RestAPI x

to :: Rep RestAPI x -> RestAPI

Hashable RestAPI

Methods

hashWithSalt :: Int -> RestAPI -> Int

hash :: RestAPI -> Int

FromJSON RestAPI

Methods

parseJSON :: Value -> Parser RestAPI

parseJSONList :: Value -> Parser [RestAPI]

NFData RestAPI

Methods

rnf :: RestAPI -> ()

type Rep RestAPI

type Rep RestAPI = D1 * (MetaData "RestAPI" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "RestAPI'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_raMinimumCompressionSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_raBinaryMediaTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_raWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_raCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_raName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_raVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_raApiKeySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe APIKeySourceType))) (S1 * (MetaSel (Just Symbol "_raId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_raPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_raEndpointConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointConfiguration))) (S1 * (MetaSel (Just Symbol "_raDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

Response Lenses

raMinimumCompressionSize :: Lens' RestAPI (Maybe Int)

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

raBinaryMediaTypes :: Lens' RestAPI [Text]

The list of binary media types supported by the RestApi . By default, the RestApi supports only UTF-8-encoded text payloads.

raWarnings :: Lens' RestAPI [Text]

The warning messages reported when failonwarnings is turned on during API import.

raCreatedDate :: Lens' RestAPI (Maybe UTCTime)

The timestamp when the API was created.

raName :: Lens' RestAPI (Maybe Text)

The API's name.

raVersion :: Lens' RestAPI (Maybe Text)

A version identifier for the API.

raApiKeySource :: Lens' RestAPI (Maybe APIKeySourceType)

The source of the API key for metering requests according to a usage plan. Valid values are: * HEADER to read the API key from the X-API-Key header of a request. * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

raId :: Lens' RestAPI (Maybe Text)

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

raPolicy :: Lens' RestAPI (Maybe Text)

Method

raEndpointConfiguration :: Lens' RestAPI (Maybe EndpointConfiguration)

The endpoint configuration of this RestApi showing the endpoint types of the API.

raDescription :: Lens' RestAPI (Maybe Text)

The API's description.