Network.AWS.APIGateway.UpdateRestAPI

Changes information about the specified API.

Creating a Request

updateRestAPI

Arguments

:: Text

uraRestAPIId

-> UpdateRestAPI

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

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

• uraPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uraRestAPIId - The string identifier of the associated RestApi .

data UpdateRestAPI

Request to update an existing RestApi resource in your collection.

See: updateRestAPI smart constructor.

Instances

Eq UpdateRestAPI

Methods

(==) :: UpdateRestAPI -> UpdateRestAPI -> Bool

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

Data UpdateRestAPI

Methods

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

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

toConstr :: UpdateRestAPI -> Constr

dataTypeOf :: UpdateRestAPI -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateRestAPI

Methods

readsPrec :: Int -> ReadS UpdateRestAPI

readList :: ReadS [UpdateRestAPI]

readPrec :: ReadPrec UpdateRestAPI

readListPrec :: ReadPrec [UpdateRestAPI]

Show UpdateRestAPI

Methods

showsPrec :: Int -> UpdateRestAPI -> ShowS

show :: UpdateRestAPI -> String

showList :: [UpdateRestAPI] -> ShowS

Generic UpdateRestAPI

Associated Types

type Rep UpdateRestAPI :: * -> *

Methods

from :: UpdateRestAPI -> Rep UpdateRestAPI x

to :: Rep UpdateRestAPI x -> UpdateRestAPI

Hashable UpdateRestAPI

Methods

hashWithSalt :: Int -> UpdateRestAPI -> Int

hash :: UpdateRestAPI -> Int

ToJSON UpdateRestAPI

Methods

toJSON :: UpdateRestAPI -> Value

toEncoding :: UpdateRestAPI -> Encoding

toJSONList :: [UpdateRestAPI] -> Value

toEncodingList :: [UpdateRestAPI] -> Encoding

NFData UpdateRestAPI

Methods

rnf :: UpdateRestAPI -> ()

AWSRequest UpdateRestAPI

Associated Types

type Rs UpdateRestAPI :: *

Methods

request :: UpdateRestAPI -> Request UpdateRestAPI

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

ToQuery UpdateRestAPI

Methods

toQuery :: UpdateRestAPI -> QueryString

ToPath UpdateRestAPI

Methods

toPath :: UpdateRestAPI -> ByteString

ToHeaders UpdateRestAPI

Methods

toHeaders :: UpdateRestAPI -> [Header]

type Rep UpdateRestAPI

type Rep UpdateRestAPI = D1 (MetaData "UpdateRestAPI" "Network.AWS.APIGateway.UpdateRestAPI" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "UpdateRestAPI'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uraPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) (S1 (MetaSel (Just Symbol "_uraRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateRestAPI

type Rs UpdateRestAPI = RestAPI

Request Lenses

uraPatchOperations :: Lens' UpdateRestAPI [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

uraRestAPIId :: Lens' UpdateRestAPI Text

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:

• 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.
• raId - The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
• 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.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "RestAPI'" PrefixI True) ((:*:) ((:*:) ((:*:) (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 "_raId") 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

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.

raId :: Lens' RestAPI (Maybe Text)

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

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.