ManagedintegrationsforIoTDeviceManagement / Client / create_provisioning_profile

create_provisioning_profile

ManagedintegrationsforIoTDeviceManagement.Client.create_provisioning_profile(**kwargs)

Create a provisioning profile for executing device provisioning flows. The provisioning profile is a document that defines the set of resources and policies applied to a device during the provisioning process.

See also: AWS API Documentation

Request Syntax

response = client.create_provisioning_profile(
    ProvisioningType='FLEET_PROVISIONING'|'JITR',
    CaCertificate='string',
    ClaimCertificate='string',
    Name='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ProvisioningType (string) –

    [REQUIRED]

    The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

  • CaCertificate (string) – The body of the PEM-encoded certificate authority (CA) certificate.

  • ClaimCertificate (string) – The body of the PEM-encoded claim certificate. If a claim certificate is provided, it will be used for the provisioning profile. Otherwise, a claim certificate will be generated.

  • Name (string) – The name of the provisioning profile.

  • ClientToken (string) –

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    This field is autopopulated if not provided.

  • Tags (dict) –

    A set of key/value pairs that are used to manage the provisioning profile.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'ProvisioningType': 'FLEET_PROVISIONING'|'JITR',
    'Id': 'string',
    'Status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    'ClaimCertificate': 'string',
    'ClaimCertificatePrivateKey': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the provisioning profile.

    • Name (string) –

      The name of the provisioning profile.

    • ProvisioningType (string) –

      The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

    • Id (string) –

      The identifier of the provisioning profile.

    • Status (string) –

      The status of a provisioning profile.

    • ClaimCertificate (string) –

      The body of the PEM-encoded claim certificate.

    • ClaimCertificatePrivateKey (string) –

      The private key of the claim certificate. This may be stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key.

Exceptions

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.ValidationException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.AccessDeniedException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.InternalServerException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.UnauthorizedException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.ConflictException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.ServiceUnavailableException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.ThrottlingException

  • ManagedintegrationsforIoTDeviceManagement.Client.exceptions.ResourceNotFoundException