Jan 29, 2021
Documentation
Index ¶
- type AbpV1_0_x
- type AbpV1_1
- type AccessDeniedException
- type ConflictException
- type Destinations
- type DeviceProfile
- type ExpressionType
- type InternalServerException
- type LoRaWANDevice
- type LoRaWANDeviceMetadata
- type LoRaWANDeviceProfile
- type LoRaWANGateway
- type LoRaWANGatewayCurrentVersion
- type LoRaWANGatewayMetadata
- type LoRaWANGatewayVersion
- type LoRaWANGetServiceProfileInfo
- type LoRaWANListDevice
- type LoRaWANSendDataToDevice
- type LoRaWANServiceProfile
- type LoRaWANUpdateDevice
- type LoRaWANUpdateGatewayTaskCreate
- type LoRaWANUpdateGatewayTaskEntry
- type OtaaV1_0_x
- type OtaaV1_1
- type PartnerType
- type ResourceNotFoundException
- type ServiceProfile
- type SessionKeysAbpV1_0_x
- type SessionKeysAbpV1_1
- type SidewalkAccountInfo
- type SidewalkAccountInfoWithFingerprint
- type SidewalkListDevice
- type SidewalkSendDataToDevice
- type SidewalkUpdateAccount
- type Tag
- type ThrottlingException
- type TooManyTagsException
- type UpdateWirelessGatewayTaskCreate
- type UpdateWirelessGatewayTaskEntry
- type ValidationException
- type WirelessDeviceIdType
- type WirelessDeviceStatistics
- type WirelessDeviceType
- type WirelessGatewayIdType
- type WirelessGatewayServiceType
- type WirelessGatewayStatistics
- type WirelessGatewayTaskDefinitionType
- type WirelessGatewayTaskStatus
- type WirelessMetadata
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AbpV1_0_x ¶
type AbpV1_0_x struct {
// The DevAddr value.
DevAddr *string
// Session keys for ABP v1.0.x
SessionKeys *SessionKeysAbpV1_0_x
}
ABP device object for LoRaWAN specification v1.0.x
type AbpV1_1 ¶
type AbpV1_1 struct {
// The DevAddr value.
DevAddr *string
// Session keys for ABP v1.1
SessionKeys *SessionKeysAbpV1_1
}
ABP device object for LoRaWAN specification v1.1
type AccessDeniedException ¶
type AccessDeniedException struct {
Message *string
}
User does not have permission to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type ConflictException ¶
Adding, updating, or deleting the resource can cause an inconsistent state.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type Destinations ¶
type Destinations struct {
// The Amazon Resource Name of the resource.
Arn *string
// The description of the resource.
Description *string
// The rule name or topic rule to send messages to.
Expression *string
// The type of value in Expression.
ExpressionType ExpressionType
// The name of the resource.
Name *string
// The ARN of the IAM Role that authorizes the destination.
RoleArn *string
}
Describes a destination.
type DeviceProfile ¶
type DeviceProfile struct {
// The Amazon Resource Name of the resource.
Arn *string
// The ID of the device profile.
Id *string
// The name of the resource.
Name *string
}
Describes a device profile.
type ExpressionType ¶
type ExpressionType string
const (
ExpressionTypeRuleName ExpressionType = "RuleName"
)
Enum values for ExpressionType
func (ExpressionType) Values ¶
func (ExpressionType) Values() []ExpressionType
Values returns all known values for ExpressionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type InternalServerException ¶
type InternalServerException struct {
Message *string
}
An unexpected error occurred while processing a request.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type LoRaWANDevice ¶
type LoRaWANDevice struct {
// LoRaWAN object for create APIs
AbpV1_0_x *AbpV1_0_x
// ABP device object for create APIs for v1.1
AbpV1_1 *AbpV1_1
// The DevEUI value.
DevEui *string
// The ID of the device profile for the new wireless device.
DeviceProfileId *string
// OTAA device object for create APIs for v1.0.x
OtaaV1_0_x *OtaaV1_0_x
// OTAA device object for v1.1 for create APIs
OtaaV1_1 *OtaaV1_1
// The ID of the service profile.
ServiceProfileId *string
}
LoRaWAN object for create functions.
type LoRaWANDeviceMetadata ¶
type LoRaWANDeviceMetadata struct {
// The DataRate value.
DataRate *int32
// The DevEUI value.
DevEui *string
// The FPort value.
FPort *int32
// The device's channel frequency in Hz.
Frequency *int32
// Information about the gateways accessed by the device.
Gateways []LoRaWANGatewayMetadata
// The date and time of the metadata.
Timestamp *string
}
LoRaWAN device metatdata.
type LoRaWANDeviceProfile ¶
type LoRaWANDeviceProfile struct {
// The ClassBTimeout value.
ClassBTimeout *int32
// The ClassCTimeout value.
ClassCTimeout *int32
// The list of values that make up the FactoryPresetFreqs value.
FactoryPresetFreqsList []int32
// The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device
// profile.
MacVersion *string
// The MaxDutyCycle value.
MaxDutyCycle *int32
// The MaxEIRP value.
MaxEirp *int32
// The PingSlotDR value.
PingSlotDr *int32
// The PingSlotFreq value.
PingSlotFreq *int32
// The PingSlotPeriod value.
PingSlotPeriod *int32
// The version of regional parameters.
RegParamsRevision *string
// The frequency band (RFRegion) value.
RfRegion *string
// The RXDataRate2 value.
RxDataRate2 *int32
// The RXDelay1 value.
RxDelay1 *int32
// The RXDROffset1 value.
RxDrOffset1 *int32
// The RXFreq2 value.
RxFreq2 *int32
// The Supports32BitFCnt value.
Supports32BitFCnt bool
// The SupportsClassB value.
SupportsClassB bool
// The SupportsClassC value.
SupportsClassC bool
// The SupportsJoin value.
SupportsJoin *bool
}
LoRaWANDeviceProfile object.
type LoRaWANGateway ¶
type LoRaWANGateway struct {
// The gateway's EUI value.
GatewayEui *string
// The frequency band (RFRegion) value.
RfRegion *string
}
LoRaWANGateway object.
type LoRaWANGatewayCurrentVersion ¶
type LoRaWANGatewayCurrentVersion struct {
// The version of the gateways that should receive the update.
CurrentVersion *LoRaWANGatewayVersion
}
LoRaWANGatewayCurrentVersion object.
type LoRaWANGatewayMetadata ¶
type LoRaWANGatewayMetadata struct {
// The gateway's EUI value.
GatewayEui *string
// The RSSI value.
Rssi *float64
// The SNR value.
Snr *float64
}
LoRaWAN gateway metatdata.
type LoRaWANGatewayVersion ¶
type LoRaWANGatewayVersion struct {
// The model number of the wireless gateway.
Model *string
// The version of the wireless gateway firmware.
PackageVersion *string
// The basic station version of the wireless gateway.
Station *string
}
LoRaWANGatewayVersion object.
type LoRaWANGetServiceProfileInfo ¶
type LoRaWANGetServiceProfileInfo struct {
// The AddGWMetaData value.
AddGwMetadata bool
// The ChannelMask value.
ChannelMask *string
// The DevStatusReqFreq value.
DevStatusReqFreq *int32
// The DLBucketSize value.
DlBucketSize *int32
// The DLRate value.
DlRate *int32
// The DLRatePolicy value.
DlRatePolicy *string
// The DRMax value.
DrMax int32
// The DRMin value.
DrMin int32
// The HRAllowed value that describes whether handover roaming is allowed.
HrAllowed bool
// The MinGwDiversity value.
MinGwDiversity *int32
// The NwkGeoLoc value.
NwkGeoLoc bool
// The PRAllowed value that describes whether passive roaming is allowed.
PrAllowed bool
// The RAAllowed value that describes whether roaming activation is allowed.
RaAllowed bool
// The ReportDevStatusBattery value.
ReportDevStatusBattery bool
// The ReportDevStatusMargin value.
ReportDevStatusMargin bool
// The TargetPER value.
TargetPer int32
// The ULBucketSize value.
UlBucketSize *int32
// The ULRate value.
UlRate *int32
// The ULRatePolicy value.
UlRatePolicy *string
}
LoRaWANGetServiceProfileInfo object.
type LoRaWANListDevice ¶
type LoRaWANListDevice struct {
// The DevEUI value.
DevEui *string
}
LoRaWAN object for list functions.
type LoRaWANSendDataToDevice ¶
type LoRaWANSendDataToDevice struct {
// The Fport value.
FPort *int32
}
LoRaWAN router info.
type LoRaWANServiceProfile ¶
type LoRaWANServiceProfile struct {
// The AddGWMetaData value.
AddGwMetadata bool
}
LoRaWANServiceProfile object.
type LoRaWANUpdateDevice ¶
type LoRaWANUpdateDevice struct {
// The ID of the device profile for the wireless device.
DeviceProfileId *string
// The ID of the service profile.
ServiceProfileId *string
}
LoRaWAN object for update functions.
type LoRaWANUpdateGatewayTaskCreate ¶
type LoRaWANUpdateGatewayTaskCreate struct {
// The version of the gateways that should receive the update.
CurrentVersion *LoRaWANGatewayVersion
// The CRC of the signature private key to check.
SigKeyCrc *int64
// The signature used to verify the update firmware.
UpdateSignature *string
// The firmware version to update the gateway to.
UpdateVersion *LoRaWANGatewayVersion
}
LoRaWANUpdateGatewayTaskCreate object.
type LoRaWANUpdateGatewayTaskEntry ¶
type LoRaWANUpdateGatewayTaskEntry struct {
// The version of the gateways that should receive the update.
CurrentVersion *LoRaWANGatewayVersion
// The firmware version to update the gateway to.
UpdateVersion *LoRaWANGatewayVersion
}
LoRaWANUpdateGatewayTaskEntry object.
type OtaaV1_0_x ¶
OTAA device object for v1.0.x
type OtaaV1_1 ¶
type OtaaV1_1 struct {
// The AppKey value.
AppKey *string
// The JoinEUI value.
JoinEui *string
// The NwkKey value.
NwkKey *string
}
OTAA device object for v1.1
type PartnerType ¶
type PartnerType string
const (
PartnerTypeSidewalk PartnerType = "Sidewalk"
)
Enum values for PartnerType
func (PartnerType) Values ¶
func (PartnerType) Values() []PartnerType
Values returns all known values for PartnerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ResourceNotFoundException ¶
Resource does not exist.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ServiceProfile ¶
type ServiceProfile struct {
// The Amazon Resource Name of the resource.
Arn *string
// The ID of the service profile.
Id *string
// The name of the resource.
Name *string
}
Information about a service profile.
type SessionKeysAbpV1_0_x ¶
type SessionKeysAbpV1_0_x struct {
// The AppSKey value.
AppSKey *string
// The NwkSKey value.
NwkSKey *string
}
Session keys for ABP v1.1
type SessionKeysAbpV1_1 ¶
type SessionKeysAbpV1_1 struct {
// The AppSKey value.
AppSKey *string
// The FNwkSIntKey value.
FNwkSIntKey *string
// The NwkSEncKey value.
NwkSEncKey *string
// The SNwkSIntKey value.
SNwkSIntKey *string
}
Session keys for ABP v1.1
type SidewalkAccountInfo ¶
type SidewalkAccountInfo struct {
// The Sidewalk Amazon ID.
AmazonId *string
// The Sidewalk application server private key.
AppServerPrivateKey *string
}
Information about a Sidewalk account.
type SidewalkAccountInfoWithFingerprint ¶
type SidewalkAccountInfoWithFingerprint struct {
// The Sidewalk Amazon ID.
AmazonId *string
// Fingerprint for Sidewalk application server private key.
Fingerprint *string
}
Information about a Sidewalk account.
type SidewalkListDevice ¶
type SidewalkListDevice struct {
// The Sidewalk Amazon ID.
AmazonId *string
}
Sidewalk object used by list functions.
type SidewalkSendDataToDevice ¶
type SidewalkSendDataToDevice struct {
// The sequence number.
Seq *int32
}
Information about a Sidewalk router.
type SidewalkUpdateAccount ¶
type SidewalkUpdateAccount struct {
// The new Sidewalk application server private key.
AppServerPrivateKey *string
}
Sidewalk update.
type Tag ¶
type Tag struct {
// The tag's key value.
//
// This member is required.
Key *string
// The tag's value.
//
// This member is required.
Value *string
}
A simple label consisting of a customer-defined key-value pair
type ThrottlingException ¶
type ThrottlingException struct {
Message *string
}
The request was denied because it exceeded the allowed API request rate.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TooManyTagsException ¶
The request was denied because the resource can't have any more tags.
func (*TooManyTagsException) Error ¶
func (e *TooManyTagsException) Error() string
func (*TooManyTagsException) ErrorCode ¶
func (e *TooManyTagsException) ErrorCode() string
func (*TooManyTagsException) ErrorFault ¶
func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
func (*TooManyTagsException) ErrorMessage ¶
func (e *TooManyTagsException) ErrorMessage() string
type UpdateWirelessGatewayTaskCreate ¶
type UpdateWirelessGatewayTaskCreate struct {
// The properties that relate to the LoRaWAN wireless gateway.
LoRaWAN *LoRaWANUpdateGatewayTaskCreate
// The IAM role used to read data from the S3 bucket.
UpdateDataRole *string
// The link to the S3 bucket.
UpdateDataSource *string
}
UpdateWirelessGatewayTaskCreate object.
type UpdateWirelessGatewayTaskEntry ¶
type UpdateWirelessGatewayTaskEntry struct {
// The ID of the new wireless gateway task entry.
Id *string
// The properties that relate to the LoRaWAN wireless gateway.
LoRaWAN *LoRaWANUpdateGatewayTaskEntry
}
UpdateWirelessGatewayTaskEntry object.
type ValidationException ¶
type ValidationException struct {
Message *string
}
The input did not meet the specified constraints.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type WirelessDeviceIdType ¶
type WirelessDeviceIdType string
const ( WirelessDeviceIdTypeWirelessDeviceId WirelessDeviceIdType = "WirelessDeviceId" WirelessDeviceIdTypeDevEui WirelessDeviceIdType = "DevEui" WirelessDeviceIdTypeThingName WirelessDeviceIdType = "ThingName" )
Enum values for WirelessDeviceIdType
func (WirelessDeviceIdType) Values ¶
func (WirelessDeviceIdType) Values() []WirelessDeviceIdType
Values returns all known values for WirelessDeviceIdType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessDeviceStatistics ¶
type WirelessDeviceStatistics struct {
// The Amazon Resource Name of the resource.
Arn *string
// The name of the destination to which the device is assigned.
DestinationName *string
// The ID of the wireless device reporting the data.
Id *string
// The date and time when the most recent uplink was received.
LastUplinkReceivedAt *string
// LoRaWAN device info.
LoRaWAN *LoRaWANListDevice
// The name of the resource.
Name *string
// The Sidewalk account credentials.
Sidewalk *SidewalkListDevice
// The wireless device type.
Type WirelessDeviceType
}
Information about a wireless device's operation.
type WirelessDeviceType ¶
type WirelessDeviceType string
const ( WirelessDeviceTypeSidewalk WirelessDeviceType = "Sidewalk" WirelessDeviceTypeLoRaWAN WirelessDeviceType = "LoRaWAN" )
Enum values for WirelessDeviceType
func (WirelessDeviceType) Values ¶
func (WirelessDeviceType) Values() []WirelessDeviceType
Values returns all known values for WirelessDeviceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessGatewayIdType ¶
type WirelessGatewayIdType string
const ( WirelessGatewayIdTypeGatewayEui WirelessGatewayIdType = "GatewayEui" WirelessGatewayIdTypeWirelessGatewayId WirelessGatewayIdType = "WirelessGatewayId" WirelessGatewayIdTypeThingName WirelessGatewayIdType = "ThingName" )
Enum values for WirelessGatewayIdType
func (WirelessGatewayIdType) Values ¶
func (WirelessGatewayIdType) Values() []WirelessGatewayIdType
Values returns all known values for WirelessGatewayIdType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessGatewayServiceType ¶
type WirelessGatewayServiceType string
const ( WirelessGatewayServiceTypeCups WirelessGatewayServiceType = "CUPS" WirelessGatewayServiceTypeLns WirelessGatewayServiceType = "LNS" )
Enum values for WirelessGatewayServiceType
func (WirelessGatewayServiceType) Values ¶
func (WirelessGatewayServiceType) Values() []WirelessGatewayServiceType
Values returns all known values for WirelessGatewayServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessGatewayStatistics ¶
type WirelessGatewayStatistics struct {
// The Amazon Resource Name of the resource.
Arn *string
// The description of the resource.
Description *string
// The ID of the wireless gateway reporting the data.
Id *string
// The date and time when the most recent uplink was received.
LastUplinkReceivedAt *string
// LoRaWAN gateway info.
LoRaWAN *LoRaWANGateway
// The name of the resource.
Name *string
}
Information about a wireless gateway's operation.
type WirelessGatewayTaskDefinitionType ¶
type WirelessGatewayTaskDefinitionType string
const (
WirelessGatewayTaskDefinitionTypeUpdate WirelessGatewayTaskDefinitionType = "UPDATE"
)
Enum values for WirelessGatewayTaskDefinitionType
func (WirelessGatewayTaskDefinitionType) Values ¶
func (WirelessGatewayTaskDefinitionType) Values() []WirelessGatewayTaskDefinitionType
Values returns all known values for WirelessGatewayTaskDefinitionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessGatewayTaskStatus ¶
type WirelessGatewayTaskStatus string
const ( WirelessGatewayTaskStatusPending WirelessGatewayTaskStatus = "PENDING" WirelessGatewayTaskStatusInProgress WirelessGatewayTaskStatus = "IN_PROGRESS" WirelessGatewayTaskStatusFirstRetry WirelessGatewayTaskStatus = "FIRST_RETRY" WirelessGatewayTaskStatusSecondRetry WirelessGatewayTaskStatus = "SECOND_RETRY" WirelessGatewayTaskStatusCompleted WirelessGatewayTaskStatus = "COMPLETED" WirelessGatewayTaskStatusFailed WirelessGatewayTaskStatus = "FAILED" )
Enum values for WirelessGatewayTaskStatus
func (WirelessGatewayTaskStatus) Values ¶
func (WirelessGatewayTaskStatus) Values() []WirelessGatewayTaskStatus
Values returns all known values for WirelessGatewayTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type WirelessMetadata ¶
type WirelessMetadata struct {
// LoRaWAN device info.
LoRaWAN *LoRaWANSendDataToDevice
// The Sidewalk account credentials.
Sidewalk *SidewalkSendDataToDevice
}
WirelessMetadata object.
Source Files
Valid