Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetWirelessGatewayTaskDefinition

Gets information about a wireless gateway task definition.

Request Syntax


GET /wireless-gateway-task-definitions/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the resource to get.

Length Constraints: Maximum length of 36.

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "AutoCreateTasks": boolean,
   "Name": "string",
   "Update": { 
      "LoRaWAN": { 
         "CurrentVersion": { 
            "Model": "string",
            "PackageVersion": "string",
            "Station": "string"
         },
         "SigKeyCrc": number,
         "UpdateSignature": "string",
         "UpdateVersion": { 
            "Model": "string",
            "PackageVersion": "string",
            "Station": "string"
         }
      },
      "UpdateDataRole": "string",
      "UpdateDataSource": "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 Amazon Resource Name of the resource.

Type: String

AutoCreateTasks

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

Type: Boolean

Name

The name of the resource.

Type: String

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

Update

Information about the gateways to update.

Type: UpdateWirelessGatewayTaskCreate object

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