libZSservicesZSamazonka-appsyncZSamazonka-appsync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppSync.CreateApiKey

Description

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

Synopsis

Creating a Request

data CreateApiKey Source #

See: newCreateApiKey smart constructor.

Constructors

CreateApiKey' 

Fields

  • expires :: 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 .

  • description :: Maybe Text

    A description of the purpose of the API key.

  • apiId :: Text

    The ID for your GraphQL API.

Instances

Instances details
Eq CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

(==) :: CreateApiKey -> CreateApiKey -> Bool #

(/=) :: CreateApiKey -> CreateApiKey -> Bool #

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 #

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 #

NFData CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

rnf :: CreateApiKey -> () #

Hashable CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

hashWithSalt :: Int -> CreateApiKey -> Int #

hash :: CreateApiKey -> Int #

ToJSON CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

toJSON :: CreateApiKey -> Value #

toEncoding :: CreateApiKey -> Encoding #

toJSONList :: [CreateApiKey] -> Value #

toEncodingList :: [CreateApiKey] -> Encoding #

AWSRequest CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Associated Types

type AWSResponse CreateApiKey #

Methods

request :: CreateApiKey -> Request CreateApiKey #

response :: MonadResource m => Logger -> Service -> Proxy CreateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApiKey))) #

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 #

type Rep CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

type Rep CreateApiKey = D1 ('MetaData "CreateApiKey" "Amazonka.AppSync.CreateApiKey" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "CreateApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateApiKey Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

type AWSResponse CreateApiKey = CreateApiKeyResponse

newCreateApiKey Source #

Arguments

:: Text

$sel:apiId: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:

$sel:expires:CreateApiKey', createApiKey_expires - 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 .

$sel:description:CreateApiKey', createApiKey_description - A description of the purpose of the API key.

$sel:apiId:CreateApiKey', createApiKey_apiId - The ID for your GraphQL API.

Request Lenses

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

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 .

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

A description of the purpose of the API key.

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

Instances

Instances details
Eq CreateApiKeyResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

(==) :: CreateApiKeyResponse -> CreateApiKeyResponse -> Bool #

(/=) :: CreateApiKeyResponse -> CreateApiKeyResponse -> Bool #

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 #

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 #

NFData CreateApiKeyResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

Methods

rnf :: CreateApiKeyResponse -> () #

type Rep CreateApiKeyResponse Source # 
Instance details

Defined in Amazonka.AppSync.CreateApiKey

type Rep CreateApiKeyResponse = D1 ('MetaData "CreateApiKeyResponse" "Amazonka.AppSync.CreateApiKey" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" '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.