GetWirelessDeviceImportTask
Get information about an import task and count of device onboarding summary information for the import task.
Request Syntax
GET /wireless_device_import_task/Id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Id
-
The identifier of the import task for which information is requested.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationTime": "string",
"DestinationName": "string",
"FailedImportedDeviceCount": number,
"Id": "string",
"InitializedImportedDeviceCount": number,
"OnboardedImportedDeviceCount": number,
"PendingImportedDeviceCount": number,
"Sidewalk": {
"DeviceCreationFileList": [ "string" ],
"Role": "string"
},
"Status": "string",
"StatusReason": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The ARN (Amazon Resource Name) of the import task.
Type: String
Length Constraints: Maximum length of 128.
- CreationTime
-
The time at which the import task was created.
Type: Timestamp
- DestinationName
-
The name of the destination that's assigned to the wireless devices in the import task.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]+ - FailedImportedDeviceCount
-
The number of devices in the import task that failed to onboard to the import task.
Type: Long
- Id
-
The identifier of the import task for which information is retrieved.
Type: String
Length Constraints: Maximum length of 256.
- InitializedImportedDeviceCount
-
The number of devices in the import task that are waiting for the control log to start processing.
Type: Long
- OnboardedImportedDeviceCount
-
The number of devices in the import task that have been onboarded to the import task.
Type: Long
- PendingImportedDeviceCount
-
The number of devices in the import task that are waiting in the import task queue to be onboarded.
Type: Long
- Sidewalk
-
The Sidewalk-related information about an import task.
Type: SidewalkGetStartImportInfo object
- Status
-
The import task status.
Type: String
Valid Values:
INITIALIZING | INITIALIZED | PENDING | COMPLETE | FAILED | DELETING - StatusReason
-
The reason for the provided status information, such as a validation error that causes the import task to fail.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have permission to perform this action.
HTTP Status Code: 403
- ConflictException
-
Adding, updating, or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429
- ValidationException
-
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
