Network.AWS.AppSync.CreateAPIKey

Creates a unique key that you can distribute to clients who are executing your API.

Creating a Request

createAPIKey

Arguments

:: Text

cakApiId

-> CreateAPIKey

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

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

• cakExpires - The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .
• cakDescription - A description of the purpose of the API key.
• cakApiId - The ID for your GraphQL API.

data CreateAPIKey

See: createAPIKey smart constructor.

Instances

Eq CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

(==) :: CreateAPIKey -> CreateAPIKey -> Bool

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

Data CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

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

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

toConstr :: CreateAPIKey -> Constr

dataTypeOf :: CreateAPIKey -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

readsPrec :: Int -> ReadS CreateAPIKey

readList :: ReadS [CreateAPIKey]

readPrec :: ReadPrec CreateAPIKey

readListPrec :: ReadPrec [CreateAPIKey]

Show CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

showsPrec :: Int -> CreateAPIKey -> ShowS

show :: CreateAPIKey -> String

showList :: [CreateAPIKey] -> ShowS

Generic CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Associated Types

type Rep CreateAPIKey :: Type -> Type

Methods

from :: CreateAPIKey -> Rep CreateAPIKey x

to :: Rep CreateAPIKey x -> CreateAPIKey

Hashable CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

hashWithSalt :: Int -> CreateAPIKey -> Int

hash :: CreateAPIKey -> Int

ToJSON CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

toJSON :: CreateAPIKey -> Value

toEncoding :: CreateAPIKey -> Encoding

toJSONList :: [CreateAPIKey] -> Value

toEncodingList :: [CreateAPIKey] -> Encoding

AWSRequest CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Associated Types

type Rs CreateAPIKey :: Type

Methods

request :: CreateAPIKey -> Request CreateAPIKey

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

ToHeaders CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

toHeaders :: CreateAPIKey -> [Header]

ToPath CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

toPath :: CreateAPIKey -> ByteString

ToQuery CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

toQuery :: CreateAPIKey -> QueryString

NFData CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

rnf :: CreateAPIKey -> ()

type Rep CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

type Rep CreateAPIKey = D1 (MetaData "CreateAPIKey" "Network.AWS.AppSync.CreateAPIKey" "amazonka-appsync-1.6.1-4DHxIkxAhvS86OTagCP3cH" False) (C1 (MetaCons "CreateAPIKey'" PrefixI True) (S1 (MetaSel (Just "_cakExpires") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 (MetaSel (Just "_cakDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cakApiId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateAPIKey

Defined in Network.AWS.AppSync.CreateAPIKey

type Rs CreateAPIKey = CreateAPIKeyResponse

Request Lenses

cakExpires :: Lens' CreateAPIKey (Maybe Integer)

The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

cakDescription :: Lens' CreateAPIKey (Maybe Text)

A description of the purpose of the API key.

cakApiId :: Lens' CreateAPIKey Text

The ID for your GraphQL API.

Destructuring the Response

createAPIKeyResponse

Arguments

:: Int

cakrsResponseStatus

-> CreateAPIKeyResponse

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

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

• cakrsApiKey - The API key.
• cakrsResponseStatus - -- | The response status code.

data CreateAPIKeyResponse

See: createAPIKeyResponse smart constructor.

Instances

Eq CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

(==) :: CreateAPIKeyResponse -> CreateAPIKeyResponse -> Bool

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

Data CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

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

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

toConstr :: CreateAPIKeyResponse -> Constr

dataTypeOf :: CreateAPIKeyResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

readsPrec :: Int -> ReadS CreateAPIKeyResponse

readList :: ReadS [CreateAPIKeyResponse]

readPrec :: ReadPrec CreateAPIKeyResponse

readListPrec :: ReadPrec [CreateAPIKeyResponse]

Show CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

showsPrec :: Int -> CreateAPIKeyResponse -> ShowS

show :: CreateAPIKeyResponse -> String

showList :: [CreateAPIKeyResponse] -> ShowS

Generic CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Associated Types

type Rep CreateAPIKeyResponse :: Type -> Type

Methods

from :: CreateAPIKeyResponse -> Rep CreateAPIKeyResponse x

to :: Rep CreateAPIKeyResponse x -> CreateAPIKeyResponse

NFData CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

Methods

rnf :: CreateAPIKeyResponse -> ()

type Rep CreateAPIKeyResponse

Defined in Network.AWS.AppSync.CreateAPIKey

type Rep CreateAPIKeyResponse = D1 (MetaData "CreateAPIKeyResponse" "Network.AWS.AppSync.CreateAPIKey" "amazonka-appsync-1.6.1-4DHxIkxAhvS86OTagCP3cH" False) (C1 (MetaCons "CreateAPIKeyResponse'" PrefixI True) (S1 (MetaSel (Just "_cakrsApiKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe APIKey)) :*: S1 (MetaSel (Just "_cakrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cakrsApiKey :: Lens' CreateAPIKeyResponse (Maybe APIKey)

The API key.

cakrsResponseStatus :: Lens' CreateAPIKeyResponse Int

• - | The response status code.