AWS API Changes

2026/04/23 - Managed integrations for AWS IoT Device Management - 3 updated api methods

Changes Adds "Status" field to provisioning profile operation response types, giving users visibility into the readiness of a provisioning profile to be used for device provisioning.

CreateProvisioningProfile (updated)

Link ¶
Changes (response)

{'Status': 'CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS '
           '| DELETE_FAILED'}

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

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

type ProvisioningType:

string

param ProvisioningType:

[REQUIRED]

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

type CaCertificate:

string

param CaCertificate:

The body of the PEM-encoded certificate authority (CA) certificate.

type ClaimCertificate:

string

param ClaimCertificate:

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.

type Name:

string

param Name:

The name of the provisioning profile.

type ClientToken:

string

param ClientToken:

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.

type Tags:

dict

param Tags:

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

(string) --
- (string) --

rtype:

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.

GetProvisioningProfile (updated)

Link ¶
Changes (response)

{'Status': 'CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS '
           '| DELETE_FAILED'}

Get details of a provisioning profile.

See also: AWS API Documentation

Request Syntax

client.get_provisioning_profile(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

The id of a provisioning profile.

rtype:

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',
    'Tags': {
        'string': '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 provisioning profile id.
- Status (string) --
  
  The status of a provisioning profile.
- ClaimCertificate (string) --
  
  The body of the PEM-encoded claim certificate.
- Tags (dict) --
  
  A set of key/value pairs that are used to manage the provisioning profile.
  - (string) --
    - (string) --

ListProvisioningProfiles (updated)

Link ¶
Changes (response)

{'Items': {'Status': 'CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | '
                     'DELETE_IN_PROGRESS | DELETE_FAILED'}}

List the provisioning profiles within the Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_provisioning_profiles(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

A token that can be used to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return at one time.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Name': 'string',
            'Id': 'string',
            'Arn': 'string',
            'ProvisioningType': 'FLEET_PROVISIONING'|'JITR',
            'Status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Items (list) --
  
  The list of provisioning profiles.
  - (dict) --
    
    Structure describing a provisioning profile.
    - Name (string) --
      
      The name of the provisioning profile.
    - Id (string) --
      
      The identifier of the provisioning profile.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the provisioning profile.
    - ProvisioningType (string) --
      
      The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
    - Status (string) --
      
      The status of a provisioning profile.
- NextToken (string) --
  
  A token that can be used to retrieve the next set of results.