IoT / Client / describe_thing_registration_task



Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_registration_task(

taskId (string) –


The task ID.

Return type:



Response Syntax

    'taskId': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'templateBody': 'string',
    'inputFileBucket': 'string',
    'inputFileKey': 'string',
    'roleArn': 'string',
    'status': 'InProgress'|'Completed'|'Failed'|'Cancelled'|'Cancelling',
    'message': 'string',
    'successCount': 123,
    'failureCount': 123,
    'percentageProgress': 123

Response Structure

  • (dict) –

    • taskId (string) –

      The task ID.

    • creationDate (datetime) –

      The task creation date.

    • lastModifiedDate (datetime) –

      The date when the task was last modified.

    • templateBody (string) –

      The task’s template.

    • inputFileBucket (string) –

      The S3 bucket that contains the input file.

    • inputFileKey (string) –

      The input file key.

    • roleArn (string) –

      The role ARN that grants access to the input file bucket.

    • status (string) –

      The status of the bulk thing provisioning task.

    • message (string) –

      The message.

    • successCount (integer) –

      The number of things successfully provisioned.

    • failureCount (integer) –

      The number of things that failed to be provisioned.

    • percentageProgress (integer) –

      The progress of the bulk provisioning task expressed as a percentage.