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.IoT.CreateKeysAndCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate action.

Synopsis

Creating a Request

data CreateKeysAndCertificate Source #

The input for the CreateKeysAndCertificate operation.

Requires permission to access the CreateKeysAndCertificateRequest action.

See: newCreateKeysAndCertificate smart constructor.

Constructors

CreateKeysAndCertificate'
Fields setAsActive :: Maybe Bool Specifies whether the certificate is active.

Instances

Instances details

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

newCreateKeysAndCertificate :: CreateKeysAndCertificate Source #

Create a value of CreateKeysAndCertificate 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:setAsActive:CreateKeysAndCertificate', createKeysAndCertificate_setAsActive - Specifies whether the certificate is active.

Request Lenses

createKeysAndCertificate_setAsActive :: Lens' CreateKeysAndCertificate (Maybe Bool) Source #

Specifies whether the certificate is active.

Destructuring the Response

data CreateKeysAndCertificateResponse Source #

The output of the CreateKeysAndCertificate operation.

See: newCreateKeysAndCertificateResponse smart constructor.

Constructors

CreateKeysAndCertificateResponse'
Fields certificateArn :: Maybe Text The ARN of the certificate. certificateId :: Maybe Text The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate). certificatePem :: Maybe Text The certificate data, in PEM format. keyPair :: Maybe KeyPair The generated key pair. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateKeysAndCertificateResponse Source #
Instance details Defined in Amazonka.IoT.CreateKeysAndCertificate Associated Types type Rep CreateKeysAndCertificateResponse :: Type -> Type # Methods from :: CreateKeysAndCertificateResponse -> Rep CreateKeysAndCertificateResponse x # to :: Rep CreateKeysAndCertificateResponse x -> CreateKeysAndCertificateResponse #
Show CreateKeysAndCertificateResponse Source #
Instance details Defined in Amazonka.IoT.CreateKeysAndCertificate Methods showsPrec :: Int -> CreateKeysAndCertificateResponse -> ShowS # show :: CreateKeysAndCertificateResponse -> String # showList :: [CreateKeysAndCertificateResponse] -> ShowS #
NFData CreateKeysAndCertificateResponse Source #
Instance details Defined in Amazonka.IoT.CreateKeysAndCertificate Methods rnf :: CreateKeysAndCertificateResponse -> () #
Eq CreateKeysAndCertificateResponse Source #
Instance details Defined in Amazonka.IoT.CreateKeysAndCertificate Methods (==) :: CreateKeysAndCertificateResponse -> CreateKeysAndCertificateResponse -> Bool # (/=) :: CreateKeysAndCertificateResponse -> CreateKeysAndCertificateResponse -> Bool #
type Rep CreateKeysAndCertificateResponse Source #
Instance details Defined in Amazonka.IoT.CreateKeysAndCertificate type Rep CreateKeysAndCertificateResponse = D1 ('MetaData "CreateKeysAndCertificateResponse" "Amazonka.IoT.CreateKeysAndCertificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateKeysAndCertificateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificatePem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyPair)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateKeysAndCertificateResponse Source #

Arguments

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

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

CreateKeysAndCertificateResponse, createKeysAndCertificateResponse_certificateArn - The ARN of the certificate.

CreateKeysAndCertificateResponse, createKeysAndCertificateResponse_certificateId - The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

CreateKeysAndCertificateResponse, createKeysAndCertificateResponse_certificatePem - The certificate data, in PEM format.

$sel:keyPair:CreateKeysAndCertificateResponse', createKeysAndCertificateResponse_keyPair - The generated key pair.

$sel:httpStatus:CreateKeysAndCertificateResponse', createKeysAndCertificateResponse_httpStatus - The response's http status code.

Response Lenses

createKeysAndCertificateResponse_certificateArn :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

The ARN of the certificate.

createKeysAndCertificateResponse_certificateId :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

createKeysAndCertificateResponse_certificatePem :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

The certificate data, in PEM format.

createKeysAndCertificateResponse_keyPair :: Lens' CreateKeysAndCertificateResponse (Maybe KeyPair) Source #

The generated key pair.

createKeysAndCertificateResponse_httpStatus :: Lens' CreateKeysAndCertificateResponse Int Source #

The response's http status code.