AWS IoT Wireless

2021/03/02 - AWS IoT Wireless - 6 updated api methods

Changes  Add ARN & Tags for PartnerAccount related APIs and WirelessGatewayTaskDefinition related APIs

AssociateAwsAccountWithPartnerAccount (updated) Link ¶
Changes (request, response)
Request 
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Response 
{'Arn': 'string'}

Associates a partner account with your AWS account.

See also: AWS API Documentation

Request Syntax

client.associate_aws_account_with_partner_account(
    Sidewalk={
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Sidewalk

dict

param Sidewalk

[REQUIRED]

The Sidewalk account credentials.

  • AmazonId (string) --

    The Sidewalk Amazon ID.

  • AppServerPrivateKey (string) --

    The Sidewalk application server private key.

type ClientRequestToken

string

param ClientRequestToken

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.

type Tags

list

param Tags

The tags attached to the specified resource. Tags are metadata that can be used 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.

rtype

dict

returns

Response Syntax

{
    'Sidewalk': {
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Sidewalk (dict) --

      The Sidewalk account credentials.

      • AmazonId (string) --

        The Sidewalk Amazon ID.

      • AppServerPrivateKey (string) --

        The Sidewalk application server private key.

    • Arn (string) --

      The Amazon Resource Name of the resource.

CreateWirelessGatewayTaskDefinition (updated) Link ¶
Changes (request, response)
Request 
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Response 
{'Arn': 'string'}

Creates a gateway task definition.

See also: AWS API Documentation

Request Syntax

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'
        },
    ]
)
type AutoCreateTasks

boolean

param AutoCreateTasks

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

type Name

string

param Name

The name of the new resource.

type Update

dict

param Update

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.

type ClientRequestToken

string

param ClientRequestToken

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.

type Tags

list

param Tags

The tags attached to the specified resource. Tags are metadata that can be used 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.

rtype

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.

GetPartnerAccount (updated) Link ¶
Changes (response) 
{'Sidewalk': {'Arn': 'string'}}

Gets information about a partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.

See also: AWS API Documentation

Request Syntax

client.get_partner_account(
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)
type PartnerAccountId

string

param PartnerAccountId

[REQUIRED]

The partner account ID to disassociate from the AWS account.

type PartnerType

string

param PartnerType

[REQUIRED]

The partner type.

rtype

dict

returns

Response Syntax

{
    'Sidewalk': {
        'AmazonId': 'string',
        'Fingerprint': 'string',
        'Arn': 'string'
    },
    'AccountLinked': True|False
}

Response Structure

  • (dict) --

    • Sidewalk (dict) --

      The Sidewalk account credentials.

      • AmazonId (string) --

        The Sidewalk Amazon ID.

      • Fingerprint (string) --

        The fingerprint of the Sidewalk application server private key.

      • Arn (string) --

        The Amazon Resource Name of the resource.

    • AccountLinked (boolean) --

      Whether the partner account is linked to the AWS account.

GetWirelessGatewayTaskDefinition (updated) Link ¶
Changes (response) 
{'Arn': 'string'}

Gets information about a wireless gateway task definition.

See also: AWS API Documentation

Request Syntax

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

string

param Id

[REQUIRED]

The ID of the resource to get.

rtype

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.

ListPartnerAccounts (updated) Link ¶
Changes (response) 
{'Sidewalk': {'Arn': 'string'}}

Lists the partner accounts associated with your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_partner_accounts(
    NextToken='string',
    MaxResults=123
)
type NextToken

string

param NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in this operation.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Sidewalk': [
        {
            'AmazonId': 'string',
            'Fingerprint': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • Sidewalk (list) --

      The Sidewalk account credentials.

      • (dict) --

        Information about a Sidewalk account.

        • AmazonId (string) --

          The Sidewalk Amazon ID.

        • Fingerprint (string) --

          The fingerprint of the Sidewalk application server private key.

        • Arn (string) --

          The Amazon Resource Name of the resource.

ListWirelessGatewayTaskDefinitions (updated) Link ¶
Changes (response) 
{'TaskDefinitions': {'Arn': 'string'}}

List the wireless gateway tasks definitions registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_wireless_gateway_task_definitions(
    MaxResults=123,
    NextToken='string',
    TaskDefinitionType='UPDATE'
)
type MaxResults

integer

param MaxResults

The maximum number of results to return in this operation.

type NextToken

string

param NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

type TaskDefinitionType

string

param TaskDefinitionType

A filter to list only the wireless gateway task definitions that use this task definition type.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'TaskDefinitions': [
        {
            'Id': 'string',
            'LoRaWAN': {
                'CurrentVersion': {
                    'PackageVersion': 'string',
                    'Model': 'string',
                    'Station': 'string'
                },
                'UpdateVersion': {
                    'PackageVersion': 'string',
                    'Model': 'string',
                    'Station': 'string'
                }
            },
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • TaskDefinitions (list) --

      The list of task definitions.

      • (dict) --

        UpdateWirelessGatewayTaskEntry object.

        • Id (string) --

          The ID of the new wireless gateway task entry.

        • LoRaWAN (dict) --

          The properties that relate to the LoRaWAN wireless gateway.

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