Network.AWS.IoT.TransferCertificate

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

Creating a Request

transferCertificate

Arguments

:: Text

tcCertificateId

-> Text

tcTargetAWSAccount

-> TransferCertificate

Creates a value of TransferCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tcTransferMessage - The transfer message.
• tcCertificateId - The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
• tcTargetAWSAccount - The AWS account.

data TransferCertificate

The input for the TransferCertificate operation.

See: transferCertificate smart constructor.

Instances

Eq TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

(==) :: TransferCertificate -> TransferCertificate -> Bool

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

Data TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TransferCertificate -> c TransferCertificate

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TransferCertificate

toConstr :: TransferCertificate -> Constr

dataTypeOf :: TransferCertificate -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TransferCertificate)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TransferCertificate)

gmapT :: (forall b. Data b => b -> b) -> TransferCertificate -> TransferCertificate

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TransferCertificate -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TransferCertificate -> r

gmapQ :: (forall d. Data d => d -> u) -> TransferCertificate -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TransferCertificate -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TransferCertificate -> m TransferCertificate

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferCertificate -> m TransferCertificate

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferCertificate -> m TransferCertificate

Read TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

readsPrec :: Int -> ReadS TransferCertificate

readList :: ReadS [TransferCertificate]

readPrec :: ReadPrec TransferCertificate

readListPrec :: ReadPrec [TransferCertificate]

Show TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

showsPrec :: Int -> TransferCertificate -> ShowS

show :: TransferCertificate -> String

showList :: [TransferCertificate] -> ShowS

Generic TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Associated Types

type Rep TransferCertificate :: Type -> Type

Methods

from :: TransferCertificate -> Rep TransferCertificate x

to :: Rep TransferCertificate x -> TransferCertificate

Hashable TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

hashWithSalt :: Int -> TransferCertificate -> Int

hash :: TransferCertificate -> Int

ToJSON TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

toJSON :: TransferCertificate -> Value

toEncoding :: TransferCertificate -> Encoding

toJSONList :: [TransferCertificate] -> Value

toEncodingList :: [TransferCertificate] -> Encoding

AWSRequest TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Associated Types

type Rs TransferCertificate :: Type

Methods

request :: TransferCertificate -> Request TransferCertificate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy TransferCertificate -> ClientResponse -> m (Response TransferCertificate)

ToHeaders TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

toHeaders :: TransferCertificate -> [Header]

ToPath TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

toPath :: TransferCertificate -> ByteString

ToQuery TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

toQuery :: TransferCertificate -> QueryString

NFData TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

Methods

rnf :: TransferCertificate -> ()

type Rep TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

type Rep TransferCertificate = D1 (MetaData "TransferCertificate" "Network.AWS.IoT.TransferCertificate" "amazonka-iot-1.6.1-1U0NSVSRVsCEeZIE9W0TkV" False) (C1 (MetaCons "TransferCertificate'" PrefixI True) (S1 (MetaSel (Just "_tcTransferMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_tcCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tcTargetAWSAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs TransferCertificate

Defined in Network.AWS.IoT.TransferCertificate

type Rs TransferCertificate = TransferCertificateResponse

Request Lenses

tcTransferMessage :: Lens' TransferCertificate (Maybe Text)

The transfer message.

tcCertificateId :: Lens' TransferCertificate Text

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

tcTargetAWSAccount :: Lens' TransferCertificate Text

The AWS account.

Destructuring the Response

transferCertificateResponse

Arguments

:: Int

tcrsResponseStatus

-> TransferCertificateResponse

Creates a value of TransferCertificateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tcrsTransferredCertificateARN - The ARN of the certificate.
• tcrsResponseStatus - -- | The response status code.

data TransferCertificateResponse

The output from the TransferCertificate operation.

See: transferCertificateResponse smart constructor.

Instances

Eq TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Methods

(==) :: TransferCertificateResponse -> TransferCertificateResponse -> Bool

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

Data TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TransferCertificateResponse -> c TransferCertificateResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TransferCertificateResponse

toConstr :: TransferCertificateResponse -> Constr

dataTypeOf :: TransferCertificateResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TransferCertificateResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TransferCertificateResponse)

gmapT :: (forall b. Data b => b -> b) -> TransferCertificateResponse -> TransferCertificateResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TransferCertificateResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TransferCertificateResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> TransferCertificateResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TransferCertificateResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TransferCertificateResponse -> m TransferCertificateResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferCertificateResponse -> m TransferCertificateResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferCertificateResponse -> m TransferCertificateResponse

Read TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Methods

readsPrec :: Int -> ReadS TransferCertificateResponse

readList :: ReadS [TransferCertificateResponse]

readPrec :: ReadPrec TransferCertificateResponse

readListPrec :: ReadPrec [TransferCertificateResponse]

Show TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Methods

showsPrec :: Int -> TransferCertificateResponse -> ShowS

show :: TransferCertificateResponse -> String

showList :: [TransferCertificateResponse] -> ShowS

Generic TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Associated Types

type Rep TransferCertificateResponse :: Type -> Type

Methods

from :: TransferCertificateResponse -> Rep TransferCertificateResponse x

to :: Rep TransferCertificateResponse x -> TransferCertificateResponse

NFData TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

Methods

rnf :: TransferCertificateResponse -> ()

type Rep TransferCertificateResponse

Defined in Network.AWS.IoT.TransferCertificate

type Rep TransferCertificateResponse = D1 (MetaData "TransferCertificateResponse" "Network.AWS.IoT.TransferCertificate" "amazonka-iot-1.6.1-1U0NSVSRVsCEeZIE9W0TkV" False) (C1 (MetaCons "TransferCertificateResponse'" PrefixI True) (S1 (MetaSel (Just "_tcrsTransferredCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

tcrsTransferredCertificateARN :: Lens' TransferCertificateResponse (Maybe Text)

The ARN of the certificate.

tcrsResponseStatus :: Lens' TransferCertificateResponse Int

• - | The response status code.