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.RegisterCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

Requires permission to access the RegisterCertificate action.

Synopsis

data RegisterCertificate = RegisterCertificate' {
- caCertificatePem :: Maybe Text
- setAsActive :: Maybe Bool
- status :: Maybe CertificateStatus
- certificatePem :: Text
}
newRegisterCertificate :: Text -> RegisterCertificate
registerCertificate_caCertificatePem :: Lens' RegisterCertificate (Maybe Text)
registerCertificate_setAsActive :: Lens' RegisterCertificate (Maybe Bool)
registerCertificate_status :: Lens' RegisterCertificate (Maybe CertificateStatus)
registerCertificate_certificatePem :: Lens' RegisterCertificate Text
data RegisterCertificateResponse = RegisterCertificateResponse' {
- certificateArn :: Maybe Text
- certificateId :: Maybe Text
- httpStatus :: Int
}
newRegisterCertificateResponse :: Int -> RegisterCertificateResponse
registerCertificateResponse_certificateArn :: Lens' RegisterCertificateResponse (Maybe Text)
registerCertificateResponse_certificateId :: Lens' RegisterCertificateResponse (Maybe Text)
registerCertificateResponse_httpStatus :: Lens' RegisterCertificateResponse Int

Creating a Request

data RegisterCertificate Source #

The input to the RegisterCertificate operation.

See: newRegisterCertificate smart constructor.

Constructors

RegisterCertificate'

Fields

caCertificatePem :: Maybe Text
The CA certificate used to sign the device certificate being registered.
setAsActive :: Maybe Bool
A boolean value that specifies if the certificate is set to active.
Valid values: ACTIVE | INACTIVE
status :: Maybe CertificateStatus
The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.
certificatePem :: Text
The certificate data, in PEM format.

Instances

Instances details

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

newRegisterCertificate Source #

Arguments

:: Text	`RegisterCertificate`
-> RegisterCertificate

Create a value of RegisterCertificate 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:caCertificatePem:RegisterCertificate', registerCertificate_caCertificatePem - The CA certificate used to sign the device certificate being registered.

$sel:setAsActive:RegisterCertificate', registerCertificate_setAsActive - A boolean value that specifies if the certificate is set to active.

Valid values: ACTIVE | INACTIVE

RegisterCertificate, registerCertificate_status - The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.

RegisterCertificate, registerCertificate_certificatePem - The certificate data, in PEM format.

Request Lenses

registerCertificate_caCertificatePem :: Lens' RegisterCertificate (Maybe Text) Source #

The CA certificate used to sign the device certificate being registered.

registerCertificate_setAsActive :: Lens' RegisterCertificate (Maybe Bool) Source #

A boolean value that specifies if the certificate is set to active.

Valid values: ACTIVE | INACTIVE

registerCertificate_status :: Lens' RegisterCertificate (Maybe CertificateStatus) Source #

The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.

registerCertificate_certificatePem :: Lens' RegisterCertificate Text Source #

The certificate data, in PEM format.

Destructuring the Response

data RegisterCertificateResponse Source #

The output from the RegisterCertificate operation.

See: newRegisterCertificateResponse smart constructor.

Constructors

RegisterCertificateResponse'
Fields certificateArn :: Maybe Text The certificate ARN. certificateId :: Maybe Text The certificate identifier. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate Associated Types type Rep RegisterCertificateResponse :: Type -> Type # Methods from :: RegisterCertificateResponse -> Rep RegisterCertificateResponse x # to :: Rep RegisterCertificateResponse x -> RegisterCertificateResponse #
Read RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate Methods readsPrec :: Int -> ReadS RegisterCertificateResponse # readList :: ReadS [RegisterCertificateResponse] # readPrec :: ReadPrec RegisterCertificateResponse # readListPrec :: ReadPrec [RegisterCertificateResponse] #
Show RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate Methods showsPrec :: Int -> RegisterCertificateResponse -> ShowS # show :: RegisterCertificateResponse -> String # showList :: [RegisterCertificateResponse] -> ShowS #
NFData RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate Methods rnf :: RegisterCertificateResponse -> () #
Eq RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate Methods (==) :: RegisterCertificateResponse -> RegisterCertificateResponse -> Bool # (/=) :: RegisterCertificateResponse -> RegisterCertificateResponse -> Bool #
type Rep RegisterCertificateResponse Source #
Instance details Defined in Amazonka.IoT.RegisterCertificate type Rep RegisterCertificateResponse = D1 ('MetaData "RegisterCertificateResponse" "Amazonka.IoT.RegisterCertificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "RegisterCertificateResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterCertificateResponse Source #

Arguments

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

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

RegisterCertificateResponse, registerCertificateResponse_certificateArn - The certificate ARN.

RegisterCertificateResponse, registerCertificateResponse_certificateId - The certificate identifier.

$sel:httpStatus:RegisterCertificateResponse', registerCertificateResponse_httpStatus - The response's http status code.

Response Lenses

registerCertificateResponse_certificateArn :: Lens' RegisterCertificateResponse (Maybe Text) Source #

The certificate ARN.

registerCertificateResponse_certificateId :: Lens' RegisterCertificateResponse (Maybe Text) Source #

The certificate identifier.

registerCertificateResponse_httpStatus :: Lens' RegisterCertificateResponse Int Source #

The response's http status code.