Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_wireless_gateway_task_definition

create_wireless_gateway_task_definition(**kwargs)

Creates a gateway task definition.

See also: AWS API Documentation

Request Syntax

response = client.create_wireless_gateway_task_definition(
    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'
            }
        }
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • AutoCreateTasks (boolean) --

    [REQUIRED]

    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 new 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.

  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    • (dict) --

      A simple label consisting of a customer-defined key-value pair

      • Key (string) -- [REQUIRED]

        The tag's key value.

      • Value (string) -- [REQUIRED]

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The ID of the new wireless gateway task definition.

    • 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.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException