GetFuotaTask - AWS IoT Wireless

GetFuotaTask

Gets information about a FUOTA task.

Request Syntax

GET /fuota-tasks/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of a FUOTA task.

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", "CreatedAt": number, "Description": "string", "FirmwareUpdateImage": "string", "FirmwareUpdateRole": "string", "Id": "string", "LoRaWAN": { "RfRegion": "string", "StartTime": number }, "Name": "string", "Status": "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 of a FUOTA task.

Type: String

Length Constraints: Maximum length of 128.

CreatedAt

Created at timestamp for the resource.

Type: Timestamp

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

FirmwareUpdateImage

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

FirmwareUpdateRole

The firmware update role that is to be used with a FUOTA task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Id

The ID of a FUOTA task.

Type: String

Length Constraints: Maximum length of 256.

LoRaWAN

The LoRaWAN information returned from getting a FUOTA task.

Type: LoRaWANFuotaTaskGetInfo object

Name

The name of a FUOTA task.

Type: String

Length Constraints: Maximum length of 256.

Status

The status of a FUOTA task.

Type: String

Valid Values: Pending | FuotaSession_Waiting | In_FuotaSession | FuotaDone | Delete_Waiting

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

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: