IoT / Client / transfer_certificate

transfer_certificate#

IoT.Client.transfer_certificate(**kwargs)#

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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 action to deactivate it.

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

See also: AWS API Documentation

Request Syntax

response = client.transfer_certificate(
    certificateId='string',
    targetAwsAccount='string',
    transferMessage='string'
)
Parameters:

  • certificateId (string) –

    [REQUIRED]

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

  • targetAwsAccount (string) –

    [REQUIRED]

    The Amazon Web Services account.

  • transferMessage (string) – The transfer message.

Return type:

dict

Returns:

Response Syntax

{
    'transferredCertificateArn': 'string'
}

Response Structure

  • (dict) –

    The output from the TransferCertificate operation.

    • transferredCertificateArn (string) –

      The ARN of the certificate.

Exceptions