AWS IoT Wireless

{'ExpressionType': {'MqttTopic'}}

Creates a new destination that maps a device message to an AWS IoT rule.

See also: AWS API Documentation

Request Syntax

client.create_destination(
    Name='string',
    ExpressionType='RuleName'|'MqttTopic',
    Expression='string',
    Description='string',
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name

string

param Name

[REQUIRED]

The name of the new resource.

type ExpressionType

string

param ExpressionType

[REQUIRED]

The type of value in Expression .

type Expression

string

param Expression

[REQUIRED]

The rule name or topic rule to send messages to.

type Description

string

param Description

The description of the new resource.

type RoleArn

string

param RoleArn

[REQUIRED]

The ARN of the IAM Role that authorizes the destination.

type Tags

list

param Tags

The tags to attach to the new destination. 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.

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.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

• (dict) --

  • Arn (string) --

    The Amazon Resource Name of the new resource.

  • Name (string) --

    The name of the new resource.

{'ExpressionType': {'MqttTopic'}}

Gets information about a destination.

See also: AWS API Documentation

Request Syntax

client.get_destination(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the resource to get.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Expression': 'string',
    'ExpressionType': 'RuleName'|'MqttTopic',
    'Description': 'string',
    'RoleArn': 'string'
}

Response Structure

• (dict) --

  • Arn (string) --

    The Amazon Resource Name of the resource.

  • Name (string) --

    The name of the resource.

  • Expression (string) --

    The rule name or topic rule to send messages to.

  • ExpressionType (string) --

    The type of value in Expression .

  • Description (string) --

    The description of the resource.

  • RoleArn (string) --

    The ARN of the IAM Role that authorizes the destination.

{'LoRaWANNetworkServerCertificateId': 'string'}

Gets the ID of the certificate that is currently associated with a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_certificate(
    Id='string'
)

type Id

string

param Id

[REQUIRED]

The ID of the resource to get.

rtype

dict

returns

Response Syntax

{
    'IotCertificateId': 'string',
    'LoRaWANNetworkServerCertificateId': 'string'
}

Response Structure

• (dict) --

  • IotCertificateId (string) --

    The ID of the certificate associated with the wireless gateway.

  • LoRaWANNetworkServerCertificateId (string) --

    The ID of the certificate associated with the wireless gateway and used for LoRaWANNetworkServer endpoint.

{'DestinationList': {'ExpressionType': {'MqttTopic'}}}

Lists the destinations registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_destinations(
    MaxResults=123,
    NextToken='string'
)

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.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'DestinationList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ExpressionType': 'RuleName'|'MqttTopic',
            'Expression': 'string',
            'Description': 'string',
            'RoleArn': '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.

  • DestinationList (list) --

    The list of destinations.

    • (dict) --

      Describes a destination.

      • Arn (string) --

        The Amazon Resource Name of the resource.

      • Name (string) --

        The name of the resource.

      • ExpressionType (string) --

        The type of value in Expression .

      • Expression (string) --

        The rule name or topic rule to send messages to.

      • Description (string) --

        The description of the resource.

      • RoleArn (string) --

        The ARN of the IAM Role that authorizes the destination.

{'ExpressionType': {'MqttTopic'}}

Updates properties of a destination.

See also: AWS API Documentation

Request Syntax

client.update_destination(
    Name='string',
    ExpressionType='RuleName'|'MqttTopic',
    Expression='string',
    Description='string',
    RoleArn='string'
)

type Name

string

param Name

[REQUIRED]

The new name of the resource.

type ExpressionType

string

param ExpressionType

The type of value in Expression .

type Expression

string

param Expression

The new rule name or topic rule to send messages to.

type Description

string

param Description

A new description of the resource.

type RoleArn

string

param RoleArn

The ARN of the IAM Role that authorizes the destination.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --