IoTWireless / Client / get_wireless_gateway_task

get_wireless_gateway_task#

IoTWireless.Client.get_wireless_gateway_task(**kwargs)#

Gets information about a wireless gateway task.

Request Syntax

response = client.get_wireless_gateway_task(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The ID of the resource to get.

Return type:

dict

Returns:

Response Syntax

{
    'WirelessGatewayId': 'string',
    'WirelessGatewayTaskDefinitionId': 'string',
    'LastUplinkReceivedAt': 'string',
    'TaskCreatedAt': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}

Response Structure

(dict) –
- WirelessGatewayId (string) –
  
  The ID of the wireless gateway.
- WirelessGatewayTaskDefinitionId (string) –
  
  The ID of the WirelessGatewayTask.
- LastUplinkReceivedAt (string) –
  
  The date and time when the most recent uplink was received.
  
  Note
  This value is only valid for 3 months.
- TaskCreatedAt (string) –
  
  The date and time when the task was created.
- Status (string) –
  
  The status of the request.

Exceptions

IoTWireless.Client.exceptions.ValidationException
IoTWireless.Client.exceptions.AccessDeniedException
IoTWireless.Client.exceptions.ResourceNotFoundException
IoTWireless.Client.exceptions.InternalServerException
IoTWireless.Client.exceptions.ThrottlingException