/thing-registration-tasks/{taskId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/thing-registration-tasks/'

Response Example

200 - Example 1

{
    "taskId": "string",
    "creationDate": "string",
    "lastModifiedDate": "string",
    "templateBody": "string",
    "inputFileBucket": "string",
    "inputFileKey": "string",
    "roleArn": "string",
    "status": "InProgress",
    "message": "string",
    "successCount": 0,
    "failureCount": 0,
    "percentageProgress": 0
}

Request

Path Params

taskId

string

required

The task ID.

Responses

🟢200Success

application/json

Body

taskId

string

optional

The task ID.

<= 40 characters

creationDate

string <date-time>

optional

The task creation date.

lastModifiedDate

string <date-time>

optional

The date when the task was last modified.

templateBody

string

optional

The task's template.

inputFileBucket

string

optional

The S3 bucket that contains the input file.

>= 3 characters<= 256 characters

Match pattern:

[a-zA-Z0-9._-]+

inputFileKey

string

optional

The input file key.

>= 1 characters<= 1024 characters

Match pattern:

[a-zA-Z0-9!_.*'()-\/]+

roleArn

string

optional

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

>= 20 characters<= 2048 characters

status

enum<string>

optional

The status of the bulk thing provisioning task.

Allowed values:

InProgressCompletedFailedCancelledCancelling

message

string

optional

The message.

<= 2048 characters

successCount

integer

optional

The number of things successfully provisioned.

failureCount

integer

optional

The number of things that failed to be provisioned.

percentageProgress

integer

optional

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

>= 0<= 100

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483InternalFailureException

🟠484ResourceNotFoundException

Modified at 2022-09-10 23:12:16

/things/{thingName}/jobs/{jobId}

/rules/{ruleName}/disable