GetWirelessGatewayTask - AWS IoT Wireless

GetWirelessGatewayTask

Gets information about a wireless gateway task.

Request Syntax

GET /wireless-gateways/Id/tasks 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 256.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "LastUplinkReceivedAt": "string", "Status": "string", "TaskCreatedAt": "string", "WirelessGatewayId": "string", "WirelessGatewayTaskDefinitionId": "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.

LastUplinkReceivedAt

The date and time when the most recent uplink was received.

Type: String

Pattern: ^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$

Status

The status of the request.

Type: String

Valid Values: PENDING | IN_PROGRESS | FIRST_RETRY | SECOND_RETRY | COMPLETED | FAILED

TaskCreatedAt

The date and time when the task was created.

Type: String

Pattern: ^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$

WirelessGatewayId

The ID of the wireless gateway.

Type: String

Length Constraints: Maximum length of 256.

WirelessGatewayTaskDefinitionId

The ID of the WirelessGatewayTask.

Type: String

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}

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: