IoTWireless / Client / get_wireless_gateway_task_definition

get_wireless_gateway_task_definition#

IoTWireless.Client.get_wireless_gateway_task_definition(**kwargs)#

Gets information about a wireless gateway task definition.

Request Syntax

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

Parameters:

Id (string) –

[REQUIRED]

The ID of the resource to get.

Return type:

dict

Returns:

Response Syntax

{
    'AutoCreateTasks': True|False,
    'Name': 'string',
    'Update': {
        'UpdateDataSource': 'string',
        'UpdateDataRole': 'string',
        'LoRaWAN': {
            'UpdateSignature': 'string',
            'SigKeyCrc': 123,
            'CurrentVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            },
            'UpdateVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            }
        }
    },
    'Arn': 'string'
}

Response Structure

(dict) –
- AutoCreateTasks (boolean) –
  
  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.
- Name (string) –
  
  The name of the resource.
- Update (dict) –
  
  Information about the gateways to update.
  - UpdateDataSource (string) –
    
    The link to the S3 bucket.
  - UpdateDataRole (string) –
    
    The IAM role used to read data from the S3 bucket.
  - LoRaWAN (dict) –
    
    The properties that relate to the LoRaWAN wireless gateway.
    - UpdateSignature (string) –
      
      The signature used to verify the update firmware.
    - SigKeyCrc (integer) –
      
      The CRC of the signature private key to check.
    - CurrentVersion (dict) –
      
      The version of the gateways that should receive the update.
      - PackageVersion (string) –
        
        The version of the wireless gateway firmware.
      - Model (string) –
        
        The model number of the wireless gateway.
      - Station (string) –
        
        The basic station version of the wireless gateway.
    - UpdateVersion (dict) –
      
      The firmware version to update the gateway to.
      - PackageVersion (string) –
        
        The version of the wireless gateway firmware.
      - Model (string) –
        
        The model number of the wireless gateway.
      - Station (string) –
        
        The basic station version of the wireless gateway.
- Arn (string) –
  
  The Amazon Resource Name of the resource.

Exceptions

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