iotwireless

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2021 License: Apache-2.0 Imports: 28 Imported by: 6

Documentation

Overview

Package iotwireless provides the API client, operations, and parameter types for AWS IoT Wireless.

AWS IoT Wireless API documentation

Index

Constants

View Source 
const ServiceAPIVersion = "2020-11-22"
View Source 
const ServiceID = "IoT Wireless"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateAwsAccountWithPartnerAccountInput 

type AssociateAwsAccountWithPartnerAccountInput struct {

	// The Sidewalk account credentials.
	//
	// This member is required.
	Sidewalk *types.SidewalkAccountInfo

	// 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.
	ClientRequestToken *string

	// The tags attached to the specified resource. Tags are metadata that can be used
	// to manage a resource
	Tags []types.Tag
}

type AssociateAwsAccountWithPartnerAccountOutput 

type AssociateAwsAccountWithPartnerAccountOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The Sidewalk account credentials.
	Sidewalk *types.SidewalkAccountInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateWirelessDeviceWithThingInput 

type AssociateWirelessDeviceWithThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// The ARN of the thing to associate with the wireless device.
	//
	// This member is required.
	ThingArn *string
}

type AssociateWirelessDeviceWithThingOutput 

type AssociateWirelessDeviceWithThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateWirelessGatewayWithCertificateInput 

type AssociateWirelessGatewayWithCertificateInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// The ID of the certificate to associate with the wireless gateway.
	//
	// This member is required.
	IotCertificateId *string
}

type AssociateWirelessGatewayWithCertificateOutput 

type AssociateWirelessGatewayWithCertificateOutput struct {

	// The ID of the certificate associated with the wireless gateway.
	IotCertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateWirelessGatewayWithThingInput 

type AssociateWirelessGatewayWithThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// The ARN of the thing to associate with the wireless gateway.
	//
	// This member is required.
	ThingArn *string
}

type AssociateWirelessGatewayWithThingOutput 

type AssociateWirelessGatewayWithThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS IoT Wireless.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateAwsAccountWithPartnerAccount 

func (c *Client) AssociateAwsAccountWithPartnerAccount(ctx context.Context, params *AssociateAwsAccountWithPartnerAccountInput, optFns ...func(*Options)) (*AssociateAwsAccountWithPartnerAccountOutput, error)

Associates a partner account with your AWS account.

func (*Client) AssociateWirelessDeviceWithThing 

func (c *Client) AssociateWirelessDeviceWithThing(ctx context.Context, params *AssociateWirelessDeviceWithThingInput, optFns ...func(*Options)) (*AssociateWirelessDeviceWithThingOutput, error)

Associates a wireless device with a thing.

func (*Client) AssociateWirelessGatewayWithCertificate 

func (c *Client) AssociateWirelessGatewayWithCertificate(ctx context.Context, params *AssociateWirelessGatewayWithCertificateInput, optFns ...func(*Options)) (*AssociateWirelessGatewayWithCertificateOutput, error)

Associates a wireless gateway with a certificate.

func (*Client) AssociateWirelessGatewayWithThing 

func (c *Client) AssociateWirelessGatewayWithThing(ctx context.Context, params *AssociateWirelessGatewayWithThingInput, optFns ...func(*Options)) (*AssociateWirelessGatewayWithThingOutput, error)

Associates a wireless gateway with a thing.

func (*Client) CreateDestination 

func (c *Client) CreateDestination(ctx context.Context, params *CreateDestinationInput, optFns ...func(*Options)) (*CreateDestinationOutput, error)

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

func (*Client) CreateDeviceProfile 

func (c *Client) CreateDeviceProfile(ctx context.Context, params *CreateDeviceProfileInput, optFns ...func(*Options)) (*CreateDeviceProfileOutput, error)

Creates a new device profile.

func (*Client) CreateServiceProfile 

func (c *Client) CreateServiceProfile(ctx context.Context, params *CreateServiceProfileInput, optFns ...func(*Options)) (*CreateServiceProfileOutput, error)

Creates a new service profile.

func (*Client) CreateWirelessDevice 

func (c *Client) CreateWirelessDevice(ctx context.Context, params *CreateWirelessDeviceInput, optFns ...func(*Options)) (*CreateWirelessDeviceOutput, error)

Provisions a wireless device.

func (*Client) CreateWirelessGateway 

func (c *Client) CreateWirelessGateway(ctx context.Context, params *CreateWirelessGatewayInput, optFns ...func(*Options)) (*CreateWirelessGatewayOutput, error)

Provisions a wireless gateway.

func (*Client) CreateWirelessGatewayTask 

func (c *Client) CreateWirelessGatewayTask(ctx context.Context, params *CreateWirelessGatewayTaskInput, optFns ...func(*Options)) (*CreateWirelessGatewayTaskOutput, error)

Creates a task for a wireless gateway.

func (*Client) CreateWirelessGatewayTaskDefinition 

func (c *Client) CreateWirelessGatewayTaskDefinition(ctx context.Context, params *CreateWirelessGatewayTaskDefinitionInput, optFns ...func(*Options)) (*CreateWirelessGatewayTaskDefinitionOutput, error)

Creates a gateway task definition.

func (*Client) DeleteDestination 

func (c *Client) DeleteDestination(ctx context.Context, params *DeleteDestinationInput, optFns ...func(*Options)) (*DeleteDestinationOutput, error)

Deletes a destination.

func (*Client) DeleteDeviceProfile 

func (c *Client) DeleteDeviceProfile(ctx context.Context, params *DeleteDeviceProfileInput, optFns ...func(*Options)) (*DeleteDeviceProfileOutput, error)

Deletes a device profile.

func (*Client) DeleteServiceProfile 

func (c *Client) DeleteServiceProfile(ctx context.Context, params *DeleteServiceProfileInput, optFns ...func(*Options)) (*DeleteServiceProfileOutput, error)

Deletes a service profile.

func (*Client) DeleteWirelessDevice 

func (c *Client) DeleteWirelessDevice(ctx context.Context, params *DeleteWirelessDeviceInput, optFns ...func(*Options)) (*DeleteWirelessDeviceOutput, error)

Deletes a wireless device.

func (*Client) DeleteWirelessGateway 

func (c *Client) DeleteWirelessGateway(ctx context.Context, params *DeleteWirelessGatewayInput, optFns ...func(*Options)) (*DeleteWirelessGatewayOutput, error)

Deletes a wireless gateway.

func (*Client) DeleteWirelessGatewayTask 

func (c *Client) DeleteWirelessGatewayTask(ctx context.Context, params *DeleteWirelessGatewayTaskInput, optFns ...func(*Options)) (*DeleteWirelessGatewayTaskOutput, error)

Deletes a wireless gateway task.

func (*Client) DeleteWirelessGatewayTaskDefinition 

func (c *Client) DeleteWirelessGatewayTaskDefinition(ctx context.Context, params *DeleteWirelessGatewayTaskDefinitionInput, optFns ...func(*Options)) (*DeleteWirelessGatewayTaskDefinitionOutput, error)

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

func (*Client) DisassociateAwsAccountFromPartnerAccount 

func (c *Client) DisassociateAwsAccountFromPartnerAccount(ctx context.Context, params *DisassociateAwsAccountFromPartnerAccountInput, optFns ...func(*Options)) (*DisassociateAwsAccountFromPartnerAccountOutput, error)

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

func (*Client) DisassociateWirelessDeviceFromThing 

func (c *Client) DisassociateWirelessDeviceFromThing(ctx context.Context, params *DisassociateWirelessDeviceFromThingInput, optFns ...func(*Options)) (*DisassociateWirelessDeviceFromThingOutput, error)

Disassociates a wireless device from its currently associated thing.

func (*Client) DisassociateWirelessGatewayFromCertificate 

func (c *Client) DisassociateWirelessGatewayFromCertificate(ctx context.Context, params *DisassociateWirelessGatewayFromCertificateInput, optFns ...func(*Options)) (*DisassociateWirelessGatewayFromCertificateOutput, error)

Disassociates a wireless gateway from its currently associated certificate.

func (*Client) DisassociateWirelessGatewayFromThing 

func (c *Client) DisassociateWirelessGatewayFromThing(ctx context.Context, params *DisassociateWirelessGatewayFromThingInput, optFns ...func(*Options)) (*DisassociateWirelessGatewayFromThingOutput, error)

Disassociates a wireless gateway from its currently associated thing.

func (*Client) GetDestination 

func (c *Client) GetDestination(ctx context.Context, params *GetDestinationInput, optFns ...func(*Options)) (*GetDestinationOutput, error)

Gets information about a destination.

func (*Client) GetDeviceProfile 

func (c *Client) GetDeviceProfile(ctx context.Context, params *GetDeviceProfileInput, optFns ...func(*Options)) (*GetDeviceProfileOutput, error)

Gets information about a device profile.

func (*Client) GetPartnerAccount 

func (c *Client) GetPartnerAccount(ctx context.Context, params *GetPartnerAccountInput, optFns ...func(*Options)) (*GetPartnerAccountOutput, error)

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

func (*Client) GetServiceEndpoint 

func (c *Client) GetServiceEndpoint(ctx context.Context, params *GetServiceEndpointInput, optFns ...func(*Options)) (*GetServiceEndpointOutput, error)

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

func (*Client) GetServiceProfile 

func (c *Client) GetServiceProfile(ctx context.Context, params *GetServiceProfileInput, optFns ...func(*Options)) (*GetServiceProfileOutput, error)

Gets information about a service profile.

func (*Client) GetWirelessDevice 

func (c *Client) GetWirelessDevice(ctx context.Context, params *GetWirelessDeviceInput, optFns ...func(*Options)) (*GetWirelessDeviceOutput, error)

Gets information about a wireless device.

func (*Client) GetWirelessDeviceStatistics 

func (c *Client) GetWirelessDeviceStatistics(ctx context.Context, params *GetWirelessDeviceStatisticsInput, optFns ...func(*Options)) (*GetWirelessDeviceStatisticsOutput, error)

Gets operating information about a wireless device.

func (*Client) GetWirelessGateway 

func (c *Client) GetWirelessGateway(ctx context.Context, params *GetWirelessGatewayInput, optFns ...func(*Options)) (*GetWirelessGatewayOutput, error)

Gets information about a wireless gateway.

func (*Client) GetWirelessGatewayCertificate 

func (c *Client) GetWirelessGatewayCertificate(ctx context.Context, params *GetWirelessGatewayCertificateInput, optFns ...func(*Options)) (*GetWirelessGatewayCertificateOutput, error)

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

func (*Client) GetWirelessGatewayFirmwareInformation 

func (c *Client) GetWirelessGatewayFirmwareInformation(ctx context.Context, params *GetWirelessGatewayFirmwareInformationInput, optFns ...func(*Options)) (*GetWirelessGatewayFirmwareInformationOutput, error)

Gets the firmware version and other information about a wireless gateway.

func (*Client) GetWirelessGatewayStatistics 

func (c *Client) GetWirelessGatewayStatistics(ctx context.Context, params *GetWirelessGatewayStatisticsInput, optFns ...func(*Options)) (*GetWirelessGatewayStatisticsOutput, error)

Gets operating information about a wireless gateway.

func (*Client) GetWirelessGatewayTask 

func (c *Client) GetWirelessGatewayTask(ctx context.Context, params *GetWirelessGatewayTaskInput, optFns ...func(*Options)) (*GetWirelessGatewayTaskOutput, error)

Gets information about a wireless gateway task.

func (*Client) GetWirelessGatewayTaskDefinition 

func (c *Client) GetWirelessGatewayTaskDefinition(ctx context.Context, params *GetWirelessGatewayTaskDefinitionInput, optFns ...func(*Options)) (*GetWirelessGatewayTaskDefinitionOutput, error)

Gets information about a wireless gateway task definition.

func (*Client) ListDestinations 

func (c *Client) ListDestinations(ctx context.Context, params *ListDestinationsInput, optFns ...func(*Options)) (*ListDestinationsOutput, error)

Lists the destinations registered to your AWS account.

func (*Client) ListDeviceProfiles 

func (c *Client) ListDeviceProfiles(ctx context.Context, params *ListDeviceProfilesInput, optFns ...func(*Options)) (*ListDeviceProfilesOutput, error)

Lists the device profiles registered to your AWS account.

func (*Client) ListPartnerAccounts 

func (c *Client) ListPartnerAccounts(ctx context.Context, params *ListPartnerAccountsInput, optFns ...func(*Options)) (*ListPartnerAccountsOutput, error)

Lists the partner accounts associated with your AWS account.

func (*Client) ListServiceProfiles 

func (c *Client) ListServiceProfiles(ctx context.Context, params *ListServiceProfilesInput, optFns ...func(*Options)) (*ListServiceProfilesOutput, error)

Lists the service profiles registered to your AWS account.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags (metadata) you have assigned to the resource.

func (*Client) ListWirelessDevices 

func (c *Client) ListWirelessDevices(ctx context.Context, params *ListWirelessDevicesInput, optFns ...func(*Options)) (*ListWirelessDevicesOutput, error)

Lists the wireless devices registered to your AWS account.

func (*Client) ListWirelessGatewayTaskDefinitions 

func (c *Client) ListWirelessGatewayTaskDefinitions(ctx context.Context, params *ListWirelessGatewayTaskDefinitionsInput, optFns ...func(*Options)) (*ListWirelessGatewayTaskDefinitionsOutput, error)

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

func (*Client) ListWirelessGateways 

func (c *Client) ListWirelessGateways(ctx context.Context, params *ListWirelessGatewaysInput, optFns ...func(*Options)) (*ListWirelessGatewaysOutput, error)

Lists the wireless gateways registered to your AWS account.

func (*Client) SendDataToWirelessDevice 

func (c *Client) SendDataToWirelessDevice(ctx context.Context, params *SendDataToWirelessDeviceInput, optFns ...func(*Options)) (*SendDataToWirelessDeviceOutput, error)

Sends a decrypted application data frame to a device.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds a tag to a resource.

func (*Client) TestWirelessDevice 

func (c *Client) TestWirelessDevice(ctx context.Context, params *TestWirelessDeviceInput, optFns ...func(*Options)) (*TestWirelessDeviceOutput, error)

Simulates a provisioned device by sending an uplink data payload of Hello.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from a resource.

func (*Client) UpdateDestination 

func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinationInput, optFns ...func(*Options)) (*UpdateDestinationOutput, error)

Updates properties of a destination.

func (*Client) UpdatePartnerAccount 

func (c *Client) UpdatePartnerAccount(ctx context.Context, params *UpdatePartnerAccountInput, optFns ...func(*Options)) (*UpdatePartnerAccountOutput, error)

Updates properties of a partner account.

func (*Client) UpdateWirelessDevice 

func (c *Client) UpdateWirelessDevice(ctx context.Context, params *UpdateWirelessDeviceInput, optFns ...func(*Options)) (*UpdateWirelessDeviceOutput, error)

Updates properties of a wireless device.

func (*Client) UpdateWirelessGateway 

func (c *Client) UpdateWirelessGateway(ctx context.Context, params *UpdateWirelessGatewayInput, optFns ...func(*Options)) (*UpdateWirelessGatewayOutput, error)

Updates properties of a wireless gateway.

type CreateDestinationInput 

type CreateDestinationInput struct {

	// The rule name or topic rule to send messages to.
	//
	// This member is required.
	Expression *string

	// The type of value in Expression.
	//
	// This member is required.
	ExpressionType types.ExpressionType

	// The name of the new resource.
	//
	// This member is required.
	Name *string

	// The ARN of the IAM Role that authorizes the destination.
	//
	// This member is required.
	RoleArn *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.
	ClientRequestToken *string

	// The description of the new resource.
	Description *string

	// The tags to attach to the new destination. Tags are metadata that can be used to
	// manage a resource.
	Tags []types.Tag
}

type CreateDestinationOutput 

type CreateDestinationOutput struct {

	// The Amazon Resource Name of the new resource.
	Arn *string

	// The name of the new resource.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDeviceProfileInput 

type CreateDeviceProfileInput struct {

	// 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.
	ClientRequestToken *string

	// The device profile information to use to create the device profile.
	LoRaWAN *types.LoRaWANDeviceProfile

	// The name of the new resource.
	Name *string

	// The tags to attach to the new device profile Tags are metadata that can be used
	// to manage a resource.
	Tags []types.Tag
}

type CreateDeviceProfileOutput 

type CreateDeviceProfileOutput struct {

	// The Amazon Resource Name of the new resource.
	Arn *string

	// The ID of the new device profile.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateServiceProfileInput 

type CreateServiceProfileInput struct {

	// 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.
	ClientRequestToken *string

	// The service profile information to use to create the service profile.
	LoRaWAN *types.LoRaWANServiceProfile

	// The name of the new resource.
	Name *string

	// The tags to attach to the new service profile. Tags are metadata that can be
	// used to manage a resource.
	Tags []types.Tag
}

type CreateServiceProfileOutput 

type CreateServiceProfileOutput struct {

	// The Amazon Resource Name of the new resource.
	Arn *string

	// The ID of the new service profile.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWirelessDeviceInput 

type CreateWirelessDeviceInput struct {

	// The name of the destination to assign to the new wireless device.
	//
	// This member is required.
	DestinationName *string

	// The wireless device type.
	//
	// This member is required.
	Type types.WirelessDeviceType

	// 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.
	ClientRequestToken *string

	// The description of the new resource.
	Description *string

	// The device configuration information to use to create the wireless device.
	LoRaWAN *types.LoRaWANDevice

	// The name of the new resource.
	Name *string
}

type CreateWirelessDeviceOutput 

type CreateWirelessDeviceOutput struct {

	// The Amazon Resource Name of the new resource.
	Arn *string

	// The ID of the new wireless device.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWirelessGatewayInput 

type CreateWirelessGatewayInput struct {

	// The gateway configuration information to use to create the wireless gateway.
	//
	// This member is required.
	LoRaWAN *types.LoRaWANGateway

	// 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.
	ClientRequestToken *string

	// The description of the new resource.
	Description *string

	// The name of the new resource.
	Name *string

	// The tags to attach to the new wireless gateway. Tags are metadata that can be
	// used to manage a resource.
	Tags []types.Tag
}

type CreateWirelessGatewayOutput 

type CreateWirelessGatewayOutput struct {

	// The Amazon Resource Name of the new resource.
	Arn *string

	// The ID of the new wireless gateway.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWirelessGatewayTaskDefinitionInput 

type CreateWirelessGatewayTaskDefinitionInput struct {

	// 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.
	//
	// This member is required.
	AutoCreateTasks bool

	// 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.
	ClientRequestToken *string

	// The name of the new resource.
	Name *string

	// The tags attached to the specified resource. Tags are metadata that can be used
	// to manage a resource
	Tags []types.Tag

	// Information about the gateways to update.
	Update *types.UpdateWirelessGatewayTaskCreate
}

type CreateWirelessGatewayTaskDefinitionOutput 

type CreateWirelessGatewayTaskDefinitionOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The ID of the new wireless gateway task definition.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWirelessGatewayTaskInput 

type CreateWirelessGatewayTaskInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// The ID of the WirelessGatewayTaskDefinition.
	//
	// This member is required.
	WirelessGatewayTaskDefinitionId *string
}

type CreateWirelessGatewayTaskOutput 

type CreateWirelessGatewayTaskOutput struct {

	// The status of the request.
	Status types.WirelessGatewayTaskStatus

	// The ID of the WirelessGatewayTaskDefinition.
	WirelessGatewayTaskDefinitionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDestinationInput 

type DeleteDestinationInput struct {

	// The name of the resource to delete.
	//
	// This member is required.
	Name *string
}

type DeleteDestinationOutput 

type DeleteDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDeviceProfileInput 

type DeleteDeviceProfileInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteDeviceProfileOutput 

type DeleteDeviceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteServiceProfileInput 

type DeleteServiceProfileInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteServiceProfileOutput 

type DeleteServiceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWirelessDeviceInput 

type DeleteWirelessDeviceInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteWirelessDeviceOutput 

type DeleteWirelessDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWirelessGatewayInput 

type DeleteWirelessGatewayInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteWirelessGatewayOutput 

type DeleteWirelessGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWirelessGatewayTaskDefinitionInput 

type DeleteWirelessGatewayTaskDefinitionInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteWirelessGatewayTaskDefinitionOutput 

type DeleteWirelessGatewayTaskDefinitionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWirelessGatewayTaskInput 

type DeleteWirelessGatewayTaskInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
}

type DeleteWirelessGatewayTaskOutput 

type DeleteWirelessGatewayTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateAwsAccountFromPartnerAccountInput 

type DisassociateAwsAccountFromPartnerAccountInput struct {

	// The partner account ID to disassociate from the AWS account.
	//
	// This member is required.
	PartnerAccountId *string

	// The partner type.
	//
	// This member is required.
	PartnerType types.PartnerType
}

type DisassociateAwsAccountFromPartnerAccountOutput 

type DisassociateAwsAccountFromPartnerAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateWirelessDeviceFromThingInput 

type DisassociateWirelessDeviceFromThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
}

type DisassociateWirelessDeviceFromThingOutput 

type DisassociateWirelessDeviceFromThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateWirelessGatewayFromCertificateInput 

type DisassociateWirelessGatewayFromCertificateInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
}

type DisassociateWirelessGatewayFromCertificateOutput 

type DisassociateWirelessGatewayFromCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateWirelessGatewayFromThingInput 

type DisassociateWirelessGatewayFromThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
}

type DisassociateWirelessGatewayFromThingOutput 

type DisassociateWirelessGatewayFromThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetDestinationInput 

type GetDestinationInput struct {

	// The name of the resource to get.
	//
	// This member is required.
	Name *string
}

type GetDestinationOutput 

type GetDestinationOutput 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 types.ExpressionType

	// The name of the resource.
	Name *string

	// The ARN of the IAM Role that authorizes the destination.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDeviceProfileInput 

type GetDeviceProfileInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetDeviceProfileOutput 

type GetDeviceProfileOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The ID of the device profile.
	Id *string

	// Information about the device profile.
	LoRaWAN *types.LoRaWANDeviceProfile

	// The name of the resource.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPartnerAccountInput 

type GetPartnerAccountInput struct {

	// The partner account ID to disassociate from the AWS account.
	//
	// This member is required.
	PartnerAccountId *string

	// The partner type.
	//
	// This member is required.
	PartnerType types.PartnerType
}

type GetPartnerAccountOutput 

type GetPartnerAccountOutput struct {

	// Whether the partner account is linked to the AWS account.
	AccountLinked bool

	// The Sidewalk account credentials.
	Sidewalk *types.SidewalkAccountInfoWithFingerprint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetServiceEndpointInput 

type GetServiceEndpointInput struct {

	// The service type for which to get endpoint information about. Can be CUPS for
	// the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network
	// Server endpoint.
	ServiceType types.WirelessGatewayServiceType
}

type GetServiceEndpointOutput 

type GetServiceEndpointOutput struct {

	// The Root CA of the server trust certificate.
	ServerTrust *string

	// The service endpoint value.
	ServiceEndpoint *string

	// The endpoint's service type.
	ServiceType types.WirelessGatewayServiceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetServiceProfileInput 

type GetServiceProfileInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetServiceProfileOutput 

type GetServiceProfileOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The ID of the service profile.
	Id *string

	// Information about the service profile.
	LoRaWAN *types.LoRaWANGetServiceProfileInfo

	// The name of the resource.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessDeviceInput 

type GetWirelessDeviceInput struct {

	// The identifier of the wireless device to get.
	//
	// This member is required.
	Identifier *string

	// The type of identifier used in identifier.
	//
	// This member is required.
	IdentifierType types.WirelessDeviceIdType
}

type GetWirelessDeviceOutput 

type GetWirelessDeviceOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The description of the resource.
	Description *string

	// The name of the destination to which the device is assigned.
	DestinationName *string

	// The ID of the wireless device.
	Id *string

	// Information about the wireless device.
	LoRaWAN *types.LoRaWANDevice

	// The name of the resource.
	Name *string

	// The ARN of the thing associated with the wireless device.
	ThingArn *string

	// The name of the thing associated with the wireless device. The value is empty if
	// a thing isn't associated with the device.
	ThingName *string

	// The wireless device type.
	Type types.WirelessDeviceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessDeviceStatisticsInput 

type GetWirelessDeviceStatisticsInput struct {

	// The ID of the wireless device for which to get the data.
	//
	// This member is required.
	WirelessDeviceId *string
}

type GetWirelessDeviceStatisticsOutput 

type GetWirelessDeviceStatisticsOutput struct {

	// The date and time when the most recent uplink was received.
	LastUplinkReceivedAt *string

	// Information about the wireless device's operations.
	LoRaWAN *types.LoRaWANDeviceMetadata

	// The ID of the wireless device.
	WirelessDeviceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayCertificateInput 

type GetWirelessGatewayCertificateInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetWirelessGatewayCertificateOutput 

type GetWirelessGatewayCertificateOutput struct {

	// The ID of the certificate associated with the wireless gateway.
	IotCertificateId *string

	// The ID of the certificate that is associated with the wireless gateway and used
	// for the LoRaWANNetworkServer endpoint.
	LoRaWANNetworkServerCertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayFirmwareInformationInput 

type GetWirelessGatewayFirmwareInformationInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetWirelessGatewayFirmwareInformationOutput 

type GetWirelessGatewayFirmwareInformationOutput struct {

	// Information about the wireless gateway's firmware.
	LoRaWAN *types.LoRaWANGatewayCurrentVersion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayInput 

type GetWirelessGatewayInput struct {

	// The identifier of the wireless gateway to get.
	//
	// This member is required.
	Identifier *string

	// The type of identifier used in identifier.
	//
	// This member is required.
	IdentifierType types.WirelessGatewayIdType
}

type GetWirelessGatewayOutput 

type GetWirelessGatewayOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// The description of the resource.
	Description *string

	// The ID of the wireless gateway.
	Id *string

	// Information about the wireless gateway.
	LoRaWAN *types.LoRaWANGateway

	// The name of the resource.
	Name *string

	// The ARN of the thing associated with the wireless gateway.
	ThingArn *string

	// The name of the thing associated with the wireless gateway. The value is empty
	// if a thing isn't associated with the gateway.
	ThingName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayStatisticsInput 

type GetWirelessGatewayStatisticsInput struct {

	// The ID of the wireless gateway for which to get the data.
	//
	// This member is required.
	WirelessGatewayId *string
}

type GetWirelessGatewayStatisticsOutput 

type GetWirelessGatewayStatisticsOutput struct {

	// The date and time when the most recent uplink was received.
	LastUplinkReceivedAt *string

	// The ID of the wireless gateway.
	WirelessGatewayId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayTaskDefinitionInput 

type GetWirelessGatewayTaskDefinitionInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetWirelessGatewayTaskDefinitionOutput 

type GetWirelessGatewayTaskDefinitionOutput struct {

	// The Amazon Resource Name of the resource.
	Arn *string

	// 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.
	AutoCreateTasks bool

	// The name of the resource.
	Name *string

	// Information about the gateways to update.
	Update *types.UpdateWirelessGatewayTaskCreate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWirelessGatewayTaskInput 

type GetWirelessGatewayTaskInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
}

type GetWirelessGatewayTaskOutput 

type GetWirelessGatewayTaskOutput struct {

	// The date and time when the most recent uplink was received.
	LastUplinkReceivedAt *string

	// The status of the request.
	Status types.WirelessGatewayTaskStatus

	// The date and time when the task was created.
	TaskCreatedAt *string

	// The ID of the wireless gateway.
	WirelessGatewayId *string

	// The ID of the WirelessGatewayTask.
	WirelessGatewayTaskDefinitionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListDestinationsAPIClient 

type ListDestinationsAPIClient interface {
	ListDestinations(context.Context, *ListDestinationsInput, ...func(*Options)) (*ListDestinationsOutput, error)
}

ListDestinationsAPIClient is a client that implements the ListDestinations operation.

type ListDestinationsInput 

type ListDestinationsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

type ListDestinationsOutput 

type ListDestinationsOutput struct {

	// The list of destinations.
	DestinationList []types.Destinations

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDestinationsPaginator 

type ListDestinationsPaginator struct {
	// contains filtered or unexported fields
}

ListDestinationsPaginator is a paginator for ListDestinations

func NewListDestinationsPaginator 

func NewListDestinationsPaginator(client ListDestinationsAPIClient, params *ListDestinationsInput, optFns ...func(*ListDestinationsPaginatorOptions)) *ListDestinationsPaginator

NewListDestinationsPaginator returns a new ListDestinationsPaginator

func (*ListDestinationsPaginator) HasMorePages 

func (p *ListDestinationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDestinationsPaginator) NextPage 

func (p *ListDestinationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDestinationsOutput, error)

NextPage retrieves the next ListDestinations page.

type ListDestinationsPaginatorOptions 

type ListDestinationsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDestinationsPaginatorOptions is the paginator options for ListDestinations

type ListDeviceProfilesAPIClient 

type ListDeviceProfilesAPIClient interface {
	ListDeviceProfiles(context.Context, *ListDeviceProfilesInput, ...func(*Options)) (*ListDeviceProfilesOutput, error)
}

ListDeviceProfilesAPIClient is a client that implements the ListDeviceProfiles operation.

type ListDeviceProfilesInput 

type ListDeviceProfilesInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

type ListDeviceProfilesOutput 

type ListDeviceProfilesOutput struct {

	// The list of device profiles.
	DeviceProfileList []types.DeviceProfile

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDeviceProfilesPaginator 

type ListDeviceProfilesPaginator struct {
	// contains filtered or unexported fields
}

ListDeviceProfilesPaginator is a paginator for ListDeviceProfiles

func NewListDeviceProfilesPaginator 

func NewListDeviceProfilesPaginator(client ListDeviceProfilesAPIClient, params *ListDeviceProfilesInput, optFns ...func(*ListDeviceProfilesPaginatorOptions)) *ListDeviceProfilesPaginator

NewListDeviceProfilesPaginator returns a new ListDeviceProfilesPaginator

func (*ListDeviceProfilesPaginator) HasMorePages 

func (p *ListDeviceProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeviceProfilesPaginator) NextPage 

func (p *ListDeviceProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeviceProfilesOutput, error)

NextPage retrieves the next ListDeviceProfiles page.

type ListDeviceProfilesPaginatorOptions 

type ListDeviceProfilesPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDeviceProfilesPaginatorOptions is the paginator options for ListDeviceProfiles

type ListPartnerAccountsInput 

type ListPartnerAccountsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

type ListPartnerAccountsOutput 

type ListPartnerAccountsOutput struct {

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

	// The Sidewalk account credentials.
	Sidewalk []types.SidewalkAccountInfoWithFingerprint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListServiceProfilesAPIClient 

type ListServiceProfilesAPIClient interface {
	ListServiceProfiles(context.Context, *ListServiceProfilesInput, ...func(*Options)) (*ListServiceProfilesOutput, error)
}

ListServiceProfilesAPIClient is a client that implements the ListServiceProfiles operation.

type ListServiceProfilesInput 

type ListServiceProfilesInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

type ListServiceProfilesOutput 

type ListServiceProfilesOutput struct {

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

	// The list of service profiles.
	ServiceProfileList []types.ServiceProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListServiceProfilesPaginator 

type ListServiceProfilesPaginator struct {
	// contains filtered or unexported fields
}

ListServiceProfilesPaginator is a paginator for ListServiceProfiles

func NewListServiceProfilesPaginator 

func NewListServiceProfilesPaginator(client ListServiceProfilesAPIClient, params *ListServiceProfilesInput, optFns ...func(*ListServiceProfilesPaginatorOptions)) *ListServiceProfilesPaginator

NewListServiceProfilesPaginator returns a new ListServiceProfilesPaginator

func (*ListServiceProfilesPaginator) HasMorePages 

func (p *ListServiceProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListServiceProfilesPaginator) NextPage 

func (p *ListServiceProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServiceProfilesOutput, error)

NextPage retrieves the next ListServiceProfiles page.

type ListServiceProfilesPaginatorOptions 

type ListServiceProfilesPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListServiceProfilesPaginatorOptions is the paginator options for ListServiceProfiles

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource for which to list tags.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags attached to the specified resource. Tags are metadata that can be used
	// to manage a resource
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWirelessDevicesAPIClient 

type ListWirelessDevicesAPIClient interface {
	ListWirelessDevices(context.Context, *ListWirelessDevicesInput, ...func(*Options)) (*ListWirelessDevicesOutput, error)
}

ListWirelessDevicesAPIClient is a client that implements the ListWirelessDevices operation.

type ListWirelessDevicesInput 

type ListWirelessDevicesInput struct {

	// A filter to list only the wireless devices that use this destination.
	DestinationName *string

	// A filter to list only the wireless devices that use this device profile.
	DeviceProfileId *string

	// The maximum number of results to return in this operation.
	MaxResults int32

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

	// A filter to list only the wireless devices that use this service profile.
	ServiceProfileId *string

	// A filter to list only the wireless devices that use this wireless device type.
	WirelessDeviceType types.WirelessDeviceType
}

type ListWirelessDevicesOutput 

type ListWirelessDevicesOutput struct {

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

	// The ID of the wireless device.
	WirelessDeviceList []types.WirelessDeviceStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWirelessDevicesPaginator 

type ListWirelessDevicesPaginator struct {
	// contains filtered or unexported fields
}

ListWirelessDevicesPaginator is a paginator for ListWirelessDevices

func NewListWirelessDevicesPaginator 

func NewListWirelessDevicesPaginator(client ListWirelessDevicesAPIClient, params *ListWirelessDevicesInput, optFns ...func(*ListWirelessDevicesPaginatorOptions)) *ListWirelessDevicesPaginator

NewListWirelessDevicesPaginator returns a new ListWirelessDevicesPaginator

func (*ListWirelessDevicesPaginator) HasMorePages 

func (p *ListWirelessDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWirelessDevicesPaginator) NextPage 

func (p *ListWirelessDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWirelessDevicesOutput, error)

NextPage retrieves the next ListWirelessDevices page.

type ListWirelessDevicesPaginatorOptions 

type ListWirelessDevicesPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWirelessDevicesPaginatorOptions is the paginator options for ListWirelessDevices

type ListWirelessGatewayTaskDefinitionsInput 

type ListWirelessGatewayTaskDefinitionsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

	// A filter to list only the wireless gateway task definitions that use this task
	// definition type.
	TaskDefinitionType types.WirelessGatewayTaskDefinitionType
}

type ListWirelessGatewayTaskDefinitionsOutput 

type ListWirelessGatewayTaskDefinitionsOutput struct {

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

	// The list of task definitions.
	TaskDefinitions []types.UpdateWirelessGatewayTaskEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWirelessGatewaysAPIClient 

type ListWirelessGatewaysAPIClient interface {
	ListWirelessGateways(context.Context, *ListWirelessGatewaysInput, ...func(*Options)) (*ListWirelessGatewaysOutput, error)
}

ListWirelessGatewaysAPIClient is a client that implements the ListWirelessGateways operation.

type ListWirelessGatewaysInput 

type ListWirelessGatewaysInput struct {

	// The maximum number of results to return in this operation.
	MaxResults int32

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

type ListWirelessGatewaysOutput 

type ListWirelessGatewaysOutput struct {

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

	// The ID of the wireless gateway.
	WirelessGatewayList []types.WirelessGatewayStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWirelessGatewaysPaginator 

type ListWirelessGatewaysPaginator struct {
	// contains filtered or unexported fields
}

ListWirelessGatewaysPaginator is a paginator for ListWirelessGateways

func NewListWirelessGatewaysPaginator 

func NewListWirelessGatewaysPaginator(client ListWirelessGatewaysAPIClient, params *ListWirelessGatewaysInput, optFns ...func(*ListWirelessGatewaysPaginatorOptions)) *ListWirelessGatewaysPaginator

NewListWirelessGatewaysPaginator returns a new ListWirelessGatewaysPaginator

func (*ListWirelessGatewaysPaginator) HasMorePages 

func (p *ListWirelessGatewaysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWirelessGatewaysPaginator) NextPage 

func (p *ListWirelessGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWirelessGatewaysOutput, error)

NextPage retrieves the next ListWirelessGateways page.

type ListWirelessGatewaysPaginatorOptions 

type ListWirelessGatewaysPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWirelessGatewaysPaginatorOptions is the paginator options for ListWirelessGateways

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendDataToWirelessDeviceInput 

type SendDataToWirelessDeviceInput struct {

	// The ID of the wireless device to receive the data.
	//
	// This member is required.
	Id *string

	// The message payload to send.
	//
	// This member is required.
	PayloadData *string

	// The transmit mode to use to send data to the wireless device. Can be: 0 for UM
	// (unacknowledge mode) or 1 for AM (acknowledge mode).
	//
	// This member is required.
	TransmitMode *int32

	// Metadata about the message request.
	WirelessMetadata *types.WirelessMetadata
}

type SendDataToWirelessDeviceOutput 

type SendDataToWirelessDeviceOutput struct {

	// The ID of the message sent to the wireless device.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to add tags to.
	//
	// This member is required.
	ResourceArn *string

	// Adds to or modifies the tags of the given resource. Tags are metadata that can
	// be used to manage a resource.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TestWirelessDeviceInput 

type TestWirelessDeviceInput struct {

	// The ID of the wireless device to test.
	//
	// This member is required.
	Id *string
}

type TestWirelessDeviceOutput 

type TestWirelessDeviceOutput struct {

	// The result returned by the test.
	Result *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource to remove tags from.
	//
	// This member is required.
	ResourceArn *string

	// A list of the keys of the tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDestinationInput 

type UpdateDestinationInput struct {

	// The new name of the resource.
	//
	// This member is required.
	Name *string

	// A new description of the resource.
	Description *string

	// The new rule name or topic rule to send messages to.
	Expression *string

	// The type of value in Expression.
	ExpressionType types.ExpressionType

	// The ARN of the IAM Role that authorizes the destination.
	RoleArn *string
}

type UpdateDestinationOutput 

type UpdateDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdatePartnerAccountInput 

type UpdatePartnerAccountInput struct {

	// The ID of the partner account to update.
	//
	// This member is required.
	PartnerAccountId *string

	// The partner type.
	//
	// This member is required.
	PartnerType types.PartnerType

	// The Sidewalk account credentials.
	//
	// This member is required.
	Sidewalk *types.SidewalkUpdateAccount
}

type UpdatePartnerAccountOutput 

type UpdatePartnerAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWirelessDeviceInput 

type UpdateWirelessDeviceInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// A new description of the resource.
	Description *string

	// The name of the new destination for the device.
	DestinationName *string

	// The updated wireless device's configuration.
	LoRaWAN *types.LoRaWANUpdateDevice

	// The new name of the resource.
	Name *string
}

type UpdateWirelessDeviceOutput 

type UpdateWirelessDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWirelessGatewayInput 

type UpdateWirelessGatewayInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string

	// A new description of the resource.
	Description *string

	// The new name of the resource.
	Name *string
}

type UpdateWirelessGatewayOutput 

type UpdateWirelessGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.