Network.AWS.APIGateway.CreateRestAPI

Creates a new RestApi resource.

Creating a Request

createRestAPI

Arguments

:: Text

craName

-> CreateRestAPI

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

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

• craMinimumCompressionSize - 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.
• craBinaryMediaTypes - The list of binary media types supported by the RestApi . By default, the RestApi supports only UTF-8-encoded text payloads.
• craVersion - A version identifier for the API.
• craApiKeySource - 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.
• craCloneFrom - The ID of the RestApi that you want to clone from.
• craPolicy - Method
• craEndpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
• craDescription - The description of the RestApi .
• craName - [Required] The name of the RestApi .

data CreateRestAPI

The POST Request to add a new RestApi resource to your collection.

See: createRestAPI smart constructor.

Instances

Eq CreateRestAPI

Methods

(==) :: CreateRestAPI -> CreateRestAPI -> Bool

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

Data CreateRestAPI

Methods

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

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

toConstr :: CreateRestAPI -> Constr

dataTypeOf :: CreateRestAPI -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateRestAPI

Methods

readsPrec :: Int -> ReadS CreateRestAPI

readList :: ReadS [CreateRestAPI]

readPrec :: ReadPrec CreateRestAPI

readListPrec :: ReadPrec [CreateRestAPI]

Show CreateRestAPI

Methods

showsPrec :: Int -> CreateRestAPI -> ShowS

show :: CreateRestAPI -> String

showList :: [CreateRestAPI] -> ShowS

Generic CreateRestAPI

Associated Types

type Rep CreateRestAPI :: * -> *

Methods

from :: CreateRestAPI -> Rep CreateRestAPI x

to :: Rep CreateRestAPI x -> CreateRestAPI

Hashable CreateRestAPI

Methods

hashWithSalt :: Int -> CreateRestAPI -> Int

hash :: CreateRestAPI -> Int

ToJSON CreateRestAPI

Methods

toJSON :: CreateRestAPI -> Value

toEncoding :: CreateRestAPI -> Encoding

toJSONList :: [CreateRestAPI] -> Value

toEncodingList :: [CreateRestAPI] -> Encoding

NFData CreateRestAPI

Methods

rnf :: CreateRestAPI -> ()

AWSRequest CreateRestAPI

Associated Types

type Rs CreateRestAPI :: *

Methods

request :: CreateRestAPI -> Request CreateRestAPI

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

ToHeaders CreateRestAPI

Methods

toHeaders :: CreateRestAPI -> [Header]

ToPath CreateRestAPI

Methods

toPath :: CreateRestAPI -> ByteString

ToQuery CreateRestAPI

Methods

toQuery :: CreateRestAPI -> QueryString

type Rep CreateRestAPI

type Rep CreateRestAPI = D1 * (MetaData "CreateRestAPI" "Network.AWS.APIGateway.CreateRestAPI" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "CreateRestAPI'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_craMinimumCompressionSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_craBinaryMediaTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_craVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_craApiKeySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe APIKeySourceType))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_craCloneFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_craPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_craEndpointConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointConfiguration))) ((:*:) * (S1 * (MetaSel (Just Symbol "_craDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_craName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs CreateRestAPI

type Rs CreateRestAPI = RestAPI

Request Lenses

craMinimumCompressionSize :: Lens' CreateRestAPI (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.

craBinaryMediaTypes :: Lens' CreateRestAPI [Text]

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

craVersion :: Lens' CreateRestAPI (Maybe Text)

A version identifier for the API.

craApiKeySource :: Lens' CreateRestAPI (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.

craCloneFrom :: Lens' CreateRestAPI (Maybe Text)

The ID of the RestApi that you want to clone from.

craPolicy :: Lens' CreateRestAPI (Maybe Text)

Method

craEndpointConfiguration :: Lens' CreateRestAPI (Maybe EndpointConfiguration)

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

craDescription :: Lens' CreateRestAPI (Maybe Text)

The description of the RestApi .

craName :: Lens' CreateRestAPI Text

Required

The name of the 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.