Amazonka.APIGateway.CreateApiKey

Create an ApiKey resource.

Creating a Request

data CreateApiKey

Request to create an ApiKey resource.

See: newCreateApiKey smart constructor.

Constructors

CreateApiKey'

Fields

• customerId :: Maybe Text

  An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

• description :: Maybe Text

  The description of the ApiKey.

• enabled :: Maybe Bool

  Specifies whether the ApiKey can be used by callers.

• generateDistinctId :: Maybe Bool

  Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

• name :: Maybe Text

  The name of the ApiKey.

• stageKeys :: Maybe [StageKey]

  DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

• tags :: Maybe (HashMap Text Text)

  The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

• value :: Maybe Text

  Specifies a value of the API key.

Instances

ToJSON CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

toJSON :: CreateApiKey -> Value

toEncoding :: CreateApiKey -> Encoding

toJSONList :: [CreateApiKey] -> Value

toEncodingList :: [CreateApiKey] -> Encoding

ToHeaders CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

toHeaders :: CreateApiKey -> [Header]

ToPath CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

toPath :: CreateApiKey -> ByteString

ToQuery CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

toQuery :: CreateApiKey -> QueryString

AWSRequest CreateApiKey

Defined in Amazonka.APIGateway.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

Defined in Amazonka.APIGateway.CreateApiKey

Associated Types

type Rep CreateApiKey :: Type -> Type

Methods

from :: CreateApiKey -> Rep CreateApiKey x

to :: Rep CreateApiKey x -> CreateApiKey

Read CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

readsPrec :: Int -> ReadS CreateApiKey

readList :: ReadS [CreateApiKey]

readPrec :: ReadPrec CreateApiKey

readListPrec :: ReadPrec [CreateApiKey]

Show CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

showsPrec :: Int -> CreateApiKey -> ShowS

show :: CreateApiKey -> String

showList :: [CreateApiKey] -> ShowS

NFData CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

rnf :: CreateApiKey -> ()

Eq CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

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

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

Hashable CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

Methods

hashWithSalt :: Int -> CreateApiKey -> Int

hash :: CreateApiKey -> Int

type AWSResponse CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

type AWSResponse CreateApiKey = ApiKey

type Rep CreateApiKey

Defined in Amazonka.APIGateway.CreateApiKey

type Rep CreateApiKey = D1 ('MetaData "CreateApiKey" "Amazonka.APIGateway.CreateApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "generateDistinctId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageKey]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCreateApiKey :: 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_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

CreateApiKey, createApiKey_description - The description of the ApiKey.

CreateApiKey, createApiKey_enabled - Specifies whether the ApiKey can be used by callers.

$sel:generateDistinctId:CreateApiKey', createApiKey_generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

CreateApiKey, createApiKey_name - The name of the ApiKey.

CreateApiKey, createApiKey_stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

CreateApiKey, createApiKey_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateApiKey, createApiKey_value - Specifies a value of the API key.

Request Lenses

createApiKey_customerId :: Lens' CreateApiKey (Maybe Text)

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

createApiKey_description :: Lens' CreateApiKey (Maybe Text)

The description of the ApiKey.

createApiKey_enabled :: Lens' CreateApiKey (Maybe Bool)

Specifies whether the ApiKey can be used by callers.

createApiKey_generateDistinctId :: Lens' CreateApiKey (Maybe Bool)

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

createApiKey_name :: Lens' CreateApiKey (Maybe Text)

The name of the ApiKey.

createApiKey_stageKeys :: Lens' CreateApiKey (Maybe [StageKey])

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

createApiKey_tags :: Lens' CreateApiKey (Maybe (HashMap Text Text))

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createApiKey_value :: Lens' CreateApiKey (Maybe Text)

Specifies a value of the API key.

Destructuring the Response

data ApiKey

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey'

Fields

• createdDate :: Maybe POSIX

  The timestamp when the API Key was created.

• customerId :: Maybe Text

  An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

• description :: Maybe Text

  The description of the API Key.

• enabled :: Maybe Bool

  Specifies whether the API Key can be used by callers.

• id :: Maybe Text

  The identifier of the API Key.

• lastUpdatedDate :: Maybe POSIX

  The timestamp when the API Key was last updated.

• name :: Maybe Text

  The name of the API Key.

• stageKeys :: Maybe [Text]

  A list of Stage resources that are associated with the ApiKey resource.

• tags :: Maybe (HashMap Text Text)

  The collection of tags. Each tag element is associated with a given resource.

• value :: Maybe Text

  The value of the API Key.

Instances

FromJSON ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

parseJSON :: Value -> Parser ApiKey

parseJSONList :: Value -> Parser [ApiKey]

Generic ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Associated Types

type Rep ApiKey :: Type -> Type

Methods

from :: ApiKey -> Rep ApiKey x

to :: Rep ApiKey x -> ApiKey

Read ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

readsPrec :: Int -> ReadS ApiKey

readList :: ReadS [ApiKey]

readPrec :: ReadPrec ApiKey

readListPrec :: ReadPrec [ApiKey]

Show ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

showsPrec :: Int -> ApiKey -> ShowS

show :: ApiKey -> String

showList :: [ApiKey] -> ShowS

NFData ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

rnf :: ApiKey -> ()

Eq ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

(==) :: ApiKey -> ApiKey -> Bool

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

Hashable ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

hashWithSalt :: Int -> ApiKey -> Int

hash :: ApiKey -> Int

type Rep ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey

Create a value of ApiKey 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:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

Response Lenses

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)

The timestamp when the API Key was created.

apiKey_customerId :: Lens' ApiKey (Maybe Text)

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_description :: Lens' ApiKey (Maybe Text)

The description of the API Key.

apiKey_enabled :: Lens' ApiKey (Maybe Bool)

Specifies whether the API Key can be used by callers.

apiKey_id :: Lens' ApiKey (Maybe Text)

The identifier of the API Key.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)

The timestamp when the API Key was last updated.

apiKey_name :: Lens' ApiKey (Maybe Text)

The name of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])

A list of Stage resources that are associated with the ApiKey resource.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))

The collection of tags. Each tag element is associated with a given resource.

apiKey_value :: Lens' ApiKey (Maybe Text)

The value of the API Key.