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.AppSync.CreateApiKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data CreateApiKey Source #

See: newCreateApiKey smart constructor.

Constructors

CreateApiKey'
Fields description :: Maybe Text A description of the purpose of the API key. expires :: Maybe Integer From the creation time, the 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 . apiId :: Text The ID for your GraphQL API.

Instances

Instances details

ToJSON CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods toJSON :: CreateApiKey -> Value # toEncoding :: CreateApiKey -> Encoding # toJSONList :: [CreateApiKey] -> Value # toEncodingList :: [CreateApiKey] -> Encoding #
ToHeaders CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods toHeaders :: CreateApiKey -> [Header] #
ToPath CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods toPath :: CreateApiKey -> ByteString #
ToQuery CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods toQuery :: CreateApiKey -> QueryString #
AWSRequest CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Associated Types type AWSResponse CreateApiKey # Methods request :: (Service -> Service) -> CreateApiKey -> Request CreateApiKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApiKey))) #
Generic CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Associated Types type Rep CreateApiKey :: Type -> Type # Methods from :: CreateApiKey -> Rep CreateApiKey x # to :: Rep CreateApiKey x -> CreateApiKey #
Read CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods readsPrec :: Int -> ReadS CreateApiKey # readList :: ReadS [CreateApiKey] # readPrec :: ReadPrec CreateApiKey # readListPrec :: ReadPrec [CreateApiKey] #
Show CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods showsPrec :: Int -> CreateApiKey -> ShowS # show :: CreateApiKey -> String # showList :: [CreateApiKey] -> ShowS #
NFData CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods rnf :: CreateApiKey -> () #
Eq CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods (==) :: CreateApiKey -> CreateApiKey -> Bool # (/=) :: CreateApiKey -> CreateApiKey -> Bool #
Hashable CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey Methods hashWithSalt :: Int -> CreateApiKey -> Int # hash :: CreateApiKey -> Int #
type AWSResponse CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey type AWSResponse CreateApiKey = CreateApiKeyResponse
type Rep CreateApiKey Source #
Instance details Defined in Amazonka.AppSync.CreateApiKey type Rep CreateApiKey = D1 ('MetaData "CreateApiKey" "Amazonka.AppSync.CreateApiKey" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateApiKey Source #

Arguments

:: Text	`CreateApiKey`
-> CreateApiKey

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

CreateApiKey, createApiKey_description - A description of the purpose of the API key.

CreateApiKey, createApiKey_expires - From the creation time, the 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 .

CreateApiKey, createApiKey_apiId - The ID for your GraphQL API.

Request Lenses

createApiKey_description :: Lens' CreateApiKey (Maybe Text) Source #

A description of the purpose of the API key.

createApiKey_expires :: Lens' CreateApiKey (Maybe Integer) Source #

From the creation time, the 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 .

createApiKey_apiId :: Lens' CreateApiKey Text Source #

The ID for your GraphQL API.

Destructuring the Response

data CreateApiKeyResponse Source #

See: newCreateApiKeyResponse smart constructor.

Constructors

CreateApiKeyResponse'
Fields apiKey :: Maybe ApiKey The API key. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateApiKeyResponse Source #

Arguments

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

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

$sel:apiKey:CreateApiKeyResponse', createApiKeyResponse_apiKey - The API key.

$sel:httpStatus:CreateApiKeyResponse', createApiKeyResponse_httpStatus - The response's http status code.

Response Lenses

createApiKeyResponse_apiKey :: Lens' CreateApiKeyResponse (Maybe ApiKey) Source #

The API key.

createApiKeyResponse_httpStatus :: Lens' CreateApiKeyResponse Int Source #

The response's http status code.