IoT / Client / create_provisioning_claim

create_provisioning_claim#

IoT.Client.create_provisioning_claim(**kwargs)#

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

Request Syntax

response = client.create_provisioning_claim(
    templateName='string'
)

Parameters:

templateName (string) –

[REQUIRED]

The name of the provisioning template to use.

Return type:

dict

Returns:

Response Syntax

{
    'certificateId': 'string',
    'certificatePem': 'string',
    'keyPair': {
        'PublicKey': 'string',
        'PrivateKey': 'string'
    },
    'expiration': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- certificateId (string) –
  
  The ID of the certificate.
- certificatePem (string) –
  
  The provisioning claim certificate.
- keyPair (dict) –
  
  The provisioning claim key pair.
  - PublicKey (string) –
    
    The public key.
  - PrivateKey (string) –
    
    The private key.
- expiration (datetime) –
  
  The provisioning claim expiration time.

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ResourceNotFoundException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.UnauthorizedException
IoT.Client.exceptions.ServiceUnavailableException
IoT.Client.exceptions.InternalFailureException