Skip to content

DescribeThingRegistrationTaskResponse

Source code in docs_src/capo_iot/types/describe_thing_registration_task_response.py
class DescribeThingRegistrationTaskResponse(TypedDict, closed=True):
    task_id: NotRequired["capo_iot.types.task_id.TaskId"]
    """<p>The task ID.</p>"""
    creation_date: NotRequired["capo_iot.types.creation_date.CreationDate"]
    """<p>The task creation date.</p>"""
    last_modified_date: NotRequired[
        "capo_iot.types.last_modified_date.LastModifiedDate"
    ]
    """<p>The date when the task was last modified.</p>"""
    template_body: NotRequired["capo_iot.types.template_body.TemplateBody"]
    """<p>The task's template.</p>"""
    input_file_bucket: NotRequired[
        "capo_iot.types.registry_s3_bucket_name.RegistryS3BucketName"
    ]
    """<p>The S3 bucket that contains the input file.</p>"""
    input_file_key: NotRequired["capo_iot.types.registry_s3_key_name.RegistryS3KeyName"]
    """<p>The input file key.</p>"""
    role_arn: NotRequired["capo_iot.types.role_arn.RoleArn"]
    """<p>The role ARN that grants access to the input file bucket.</p>"""
    status: NotRequired["capo_iot.types.status.Status"]
    """<p>The status of the bulk thing provisioning task.</p>"""
    message: NotRequired["capo_iot.types.error_message.ErrorMessage"]
    """<p>The message.</p>"""
    success_count: "capo_iot.types.count.Count"
    """<p>The number of things successfully provisioned.</p>"""
    failure_count: "capo_iot.types.count.Count"
    """<p>The number of things that failed to be provisioned.</p>"""
    percentage_progress: "capo_iot.types.percentage.Percentage"
    """<p>The progress of the bulk provisioning task expressed as a percentage.</p>"""

creation_date instance-attribute

creation_date: NotRequired[CreationDate]

The task creation date.

failure_count instance-attribute

failure_count: Count

The number of things that failed to be provisioned.

input_file_bucket instance-attribute

input_file_bucket: NotRequired[RegistryS3BucketName]

The S3 bucket that contains the input file.

input_file_key instance-attribute

input_file_key: NotRequired[RegistryS3KeyName]

The input file key.

last_modified_date instance-attribute

last_modified_date: NotRequired[LastModifiedDate]

The date when the task was last modified.

message instance-attribute

message: NotRequired[ErrorMessage]

The message.

percentage_progress instance-attribute

percentage_progress: Percentage

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

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

status instance-attribute

status: NotRequired[Status]

The status of the bulk thing provisioning task.

success_count instance-attribute

success_count: Count

The number of things successfully provisioned.

task_id instance-attribute

task_id: NotRequired[TaskId]

The task ID.

template_body instance-attribute

template_body: NotRequired[TemplateBody]

The task's template.