iotwireless

package module
v1.42.3 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2024 License: Apache-2.0 Imports: 43 Imported by: 6

Documentation

Overview

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

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpointsin the AWS General Reference.

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.29.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.33.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.33.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

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. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

	// The tags to attach to the specified resource. Tags are metadata that you can
	// use to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type AssociateMulticastGroupWithFuotaTaskInput added in v1.12.0 

type AssociateMulticastGroupWithFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

	// The ID of the multicast group.
	//
	// This member is required.
	MulticastGroupId *string
	// contains filtered or unexported fields
}

type AssociateMulticastGroupWithFuotaTaskOutput added in v1.12.0 

type AssociateMulticastGroupWithFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateWirelessDeviceWithFuotaTaskInput added in v1.12.0 

type AssociateWirelessDeviceWithFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

	// The ID of the wireless device.
	//
	// This member is required.
	WirelessDeviceId *string
	// contains filtered or unexported fields
}

type AssociateWirelessDeviceWithFuotaTaskOutput added in v1.12.0 

type AssociateWirelessDeviceWithFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateWirelessDeviceWithMulticastGroupInput added in v1.12.0 

type AssociateWirelessDeviceWithMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// The ID of the wireless device.
	//
	// This member is required.
	WirelessDeviceId *string
	// contains filtered or unexported fields
}

type AssociateWirelessDeviceWithMulticastGroupOutput added in v1.12.0 

type AssociateWirelessDeviceWithMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type AssociateWirelessDeviceWithThingOutput 

type AssociateWirelessDeviceWithThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type AssociateWirelessGatewayWithThingOutput 

type AssociateWirelessGatewayWithThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.33.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.33.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelMulticastGroupSessionInput added in v1.12.0 

type CancelMulticastGroupSessionInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type CancelMulticastGroupSessionOutput added in v1.12.0 

type CancelMulticastGroupSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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) AssociateMulticastGroupWithFuotaTask added in v1.12.0 

func (c *Client) AssociateMulticastGroupWithFuotaTask(ctx context.Context, params *AssociateMulticastGroupWithFuotaTaskInput, optFns ...func(*Options)) (*AssociateMulticastGroupWithFuotaTaskOutput, error)

Associate a multicast group with a FUOTA task.

func (*Client) AssociateWirelessDeviceWithFuotaTask added in v1.12.0 

func (c *Client) AssociateWirelessDeviceWithFuotaTask(ctx context.Context, params *AssociateWirelessDeviceWithFuotaTaskInput, optFns ...func(*Options)) (*AssociateWirelessDeviceWithFuotaTaskOutput, error)

Associate a wireless device with a FUOTA task.

func (*Client) AssociateWirelessDeviceWithMulticastGroup added in v1.12.0 

func (c *Client) AssociateWirelessDeviceWithMulticastGroup(ctx context.Context, params *AssociateWirelessDeviceWithMulticastGroupInput, optFns ...func(*Options)) (*AssociateWirelessDeviceWithMulticastGroupOutput, error)

Associates a wireless device with a multicast group.

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) CancelMulticastGroupSession added in v1.12.0 

func (c *Client) CancelMulticastGroupSession(ctx context.Context, params *CancelMulticastGroupSessionInput, optFns ...func(*Options)) (*CancelMulticastGroupSessionOutput, error)

Cancels an existing multicast group session.

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) CreateFuotaTask added in v1.12.0 

func (c *Client) CreateFuotaTask(ctx context.Context, params *CreateFuotaTaskInput, optFns ...func(*Options)) (*CreateFuotaTaskOutput, error)

Creates a FUOTA task.

func (*Client) CreateMulticastGroup added in v1.12.0 

func (c *Client) CreateMulticastGroup(ctx context.Context, params *CreateMulticastGroupInput, optFns ...func(*Options)) (*CreateMulticastGroupOutput, error)

Creates a multicast group.

func (*Client) CreateNetworkAnalyzerConfiguration added in v1.19.0 

func (c *Client) CreateNetworkAnalyzerConfiguration(ctx context.Context, params *CreateNetworkAnalyzerConfigurationInput, optFns ...func(*Options)) (*CreateNetworkAnalyzerConfigurationOutput, error)

Creates a new network analyzer configuration.

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.

When provisioning a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

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) DeleteFuotaTask added in v1.12.0 

func (c *Client) DeleteFuotaTask(ctx context.Context, params *DeleteFuotaTaskInput, optFns ...func(*Options)) (*DeleteFuotaTaskOutput, error)

Deletes a FUOTA task.

func (*Client) DeleteMulticastGroup added in v1.12.0 

func (c *Client) DeleteMulticastGroup(ctx context.Context, params *DeleteMulticastGroupInput, optFns ...func(*Options)) (*DeleteMulticastGroupOutput, error)

Deletes a multicast group if it is not in use by a fuota task.

func (*Client) DeleteNetworkAnalyzerConfiguration added in v1.19.0 

func (c *Client) DeleteNetworkAnalyzerConfiguration(ctx context.Context, params *DeleteNetworkAnalyzerConfigurationInput, optFns ...func(*Options)) (*DeleteNetworkAnalyzerConfigurationOutput, error)

Deletes a network analyzer configuration.

func (*Client) DeleteQueuedMessages added in v1.16.0 

func (c *Client) DeleteQueuedMessages(ctx context.Context, params *DeleteQueuedMessagesInput, optFns ...func(*Options)) (*DeleteQueuedMessagesOutput, error)

Remove queued messages from the downlink queue.

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) DeleteWirelessDeviceImportTask added in v1.26.0 

func (c *Client) DeleteWirelessDeviceImportTask(ctx context.Context, params *DeleteWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*DeleteWirelessDeviceImportTaskOutput, error)

Delete an import task.

func (*Client) DeleteWirelessGateway 

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

Deletes a wireless gateway.

When deleting a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

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) DeregisterWirelessDevice added in v1.26.0 

func (c *Client) DeregisterWirelessDevice(ctx context.Context, params *DeregisterWirelessDeviceInput, optFns ...func(*Options)) (*DeregisterWirelessDeviceOutput, error)

Deregister a wireless device from AWS IoT Wireless.

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) DisassociateMulticastGroupFromFuotaTask added in v1.12.0 

func (c *Client) DisassociateMulticastGroupFromFuotaTask(ctx context.Context, params *DisassociateMulticastGroupFromFuotaTaskInput, optFns ...func(*Options)) (*DisassociateMulticastGroupFromFuotaTaskOutput, error)

Disassociates a multicast group from a fuota task.

func (*Client) DisassociateWirelessDeviceFromFuotaTask added in v1.12.0 

func (c *Client) DisassociateWirelessDeviceFromFuotaTask(ctx context.Context, params *DisassociateWirelessDeviceFromFuotaTaskInput, optFns ...func(*Options)) (*DisassociateWirelessDeviceFromFuotaTaskOutput, error)

Disassociates a wireless device from a FUOTA task.

func (*Client) DisassociateWirelessDeviceFromMulticastGroup added in v1.12.0 

func (c *Client) DisassociateWirelessDeviceFromMulticastGroup(ctx context.Context, params *DisassociateWirelessDeviceFromMulticastGroupInput, optFns ...func(*Options)) (*DisassociateWirelessDeviceFromMulticastGroupOutput, error)

Disassociates a wireless device from a multicast group.

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) GetEventConfigurationByResourceTypes added in v1.19.0 

func (c *Client) GetEventConfigurationByResourceTypes(ctx context.Context, params *GetEventConfigurationByResourceTypesInput, optFns ...func(*Options)) (*GetEventConfigurationByResourceTypesOutput, error)

Get the event configuration based on resource types.

func (*Client) GetFuotaTask added in v1.12.0 

func (c *Client) GetFuotaTask(ctx context.Context, params *GetFuotaTaskInput, optFns ...func(*Options)) (*GetFuotaTaskOutput, error)

Gets information about a FUOTA task.

func (*Client) GetLogLevelsByResourceTypes added in v1.6.0 

func (c *Client) GetLogLevelsByResourceTypes(ctx context.Context, params *GetLogLevelsByResourceTypesInput, optFns ...func(*Options)) (*GetLogLevelsByResourceTypesOutput, error)

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.

func (*Client) GetMetricConfiguration added in v1.37.0 

func (c *Client) GetMetricConfiguration(ctx context.Context, params *GetMetricConfigurationInput, optFns ...func(*Options)) (*GetMetricConfigurationOutput, error)

Get the metric configuration status for this AWS account.

func (*Client) GetMetrics added in v1.37.0 

func (c *Client) GetMetrics(ctx context.Context, params *GetMetricsInput, optFns ...func(*Options)) (*GetMetricsOutput, error)

Get the summary metrics for this AWS account.

func (*Client) GetMulticastGroup added in v1.12.0 

func (c *Client) GetMulticastGroup(ctx context.Context, params *GetMulticastGroupInput, optFns ...func(*Options)) (*GetMulticastGroupOutput, error)

Gets information about a multicast group.

func (*Client) GetMulticastGroupSession added in v1.12.0 

func (c *Client) GetMulticastGroupSession(ctx context.Context, params *GetMulticastGroupSessionInput, optFns ...func(*Options)) (*GetMulticastGroupSessionOutput, error)

Gets information about a multicast group session.

func (*Client) GetNetworkAnalyzerConfiguration added in v1.13.0 

func (c *Client) GetNetworkAnalyzerConfiguration(ctx context.Context, params *GetNetworkAnalyzerConfigurationInput, optFns ...func(*Options)) (*GetNetworkAnalyzerConfigurationOutput, error)

Get network analyzer configuration.

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) GetPosition deprecated added in v1.20.0 

func (c *Client) GetPosition(ctx context.Context, params *GetPositionInput, optFns ...func(*Options)) (*GetPositionOutput, error)

Get the position information for a given resource.

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePositionAPI operation instead.

Deprecated: This operation is no longer supported.

func (*Client) GetPositionConfiguration deprecated added in v1.20.0 

func (c *Client) GetPositionConfiguration(ctx context.Context, params *GetPositionConfigurationInput, optFns ...func(*Options)) (*GetPositionConfigurationOutput, error)

Get position configuration for a given resource.

This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePositionAPI operation instead.

Deprecated: This operation is no longer supported.

func (*Client) GetPositionEstimate added in v1.23.0 

func (c *Client) GetPositionEstimate(ctx context.Context, params *GetPositionEstimateInput, optFns ...func(*Options)) (*GetPositionEstimateOutput, error)

Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.

func (*Client) GetResourceEventConfiguration added in v1.12.0 

func (c *Client) GetResourceEventConfiguration(ctx context.Context, params *GetResourceEventConfigurationInput, optFns ...func(*Options)) (*GetResourceEventConfigurationOutput, error)

Get the event configuration for a particular resource identifier.

func (*Client) GetResourceLogLevel added in v1.6.0 

func (c *Client) GetResourceLogLevel(ctx context.Context, params *GetResourceLogLevelInput, optFns ...func(*Options)) (*GetResourceLogLevelOutput, error)

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

func (*Client) GetResourcePosition added in v1.23.0 

func (c *Client) GetResourcePosition(ctx context.Context, params *GetResourcePositionInput, optFns ...func(*Options)) (*GetResourcePositionOutput, error)

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).

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) GetWirelessDeviceImportTask added in v1.26.0 

func (c *Client) GetWirelessDeviceImportTask(ctx context.Context, params *GetWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*GetWirelessDeviceImportTaskOutput, error)

Get information about an import task and count of device onboarding summary information for the import task.

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) ListDevicesForWirelessDeviceImportTask added in v1.26.0 

func (c *Client) ListDevicesForWirelessDeviceImportTask(ctx context.Context, params *ListDevicesForWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*ListDevicesForWirelessDeviceImportTaskOutput, error)

List the Sidewalk devices in an import task and their onboarding status.

func (*Client) ListEventConfigurations added in v1.19.0 

func (c *Client) ListEventConfigurations(ctx context.Context, params *ListEventConfigurationsInput, optFns ...func(*Options)) (*ListEventConfigurationsOutput, error)

List event configurations where at least one event topic has been enabled.

func (*Client) ListFuotaTasks added in v1.12.0 

func (c *Client) ListFuotaTasks(ctx context.Context, params *ListFuotaTasksInput, optFns ...func(*Options)) (*ListFuotaTasksOutput, error)

Lists the FUOTA tasks registered to your AWS account.

func (*Client) ListMulticastGroups added in v1.12.0 

func (c *Client) ListMulticastGroups(ctx context.Context, params *ListMulticastGroupsInput, optFns ...func(*Options)) (*ListMulticastGroupsOutput, error)

Lists the multicast groups registered to your AWS account.

func (*Client) ListMulticastGroupsByFuotaTask added in v1.12.0 

func (c *Client) ListMulticastGroupsByFuotaTask(ctx context.Context, params *ListMulticastGroupsByFuotaTaskInput, optFns ...func(*Options)) (*ListMulticastGroupsByFuotaTaskOutput, error)

List all multicast groups associated with a fuota task.

func (*Client) ListNetworkAnalyzerConfigurations added in v1.19.0 

func (c *Client) ListNetworkAnalyzerConfigurations(ctx context.Context, params *ListNetworkAnalyzerConfigurationsInput, optFns ...func(*Options)) (*ListNetworkAnalyzerConfigurationsOutput, error)

Lists the network analyzer configurations.

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) ListPositionConfigurations deprecated added in v1.20.0 

func (c *Client) ListPositionConfigurations(ctx context.Context, params *ListPositionConfigurationsInput, optFns ...func(*Options)) (*ListPositionConfigurationsOutput, error)

List position configurations for a given resource, such as positioning solvers.

This action is no longer supported. Calls to retrieve position information should use the GetResourcePositionAPI operation instead.

Deprecated: This operation is no longer supported.

func (*Client) ListQueuedMessages added in v1.16.0 

func (c *Client) ListQueuedMessages(ctx context.Context, params *ListQueuedMessagesInput, optFns ...func(*Options)) (*ListQueuedMessagesOutput, error)

List queued messages in the downlink queue.

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) ListWirelessDeviceImportTasks added in v1.26.0 

func (c *Client) ListWirelessDeviceImportTasks(ctx context.Context, params *ListWirelessDeviceImportTasksInput, optFns ...func(*Options)) (*ListWirelessDeviceImportTasksOutput, error)

List wireless devices that have been added to an import task.

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) Options added in v1.34.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutPositionConfiguration deprecated added in v1.20.0 

func (c *Client) PutPositionConfiguration(ctx context.Context, params *PutPositionConfigurationInput, optFns ...func(*Options)) (*PutPositionConfigurationOutput, error)

Put position configuration for a given resource.

This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePositionAPI operation instead.

Deprecated: This operation is no longer supported.

func (*Client) PutResourceLogLevel added in v1.6.0 

func (c *Client) PutResourceLogLevel(ctx context.Context, params *PutResourceLogLevelInput, optFns ...func(*Options)) (*PutResourceLogLevelOutput, error)

Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.

func (*Client) ResetAllResourceLogLevels added in v1.6.0 

func (c *Client) ResetAllResourceLogLevels(ctx context.Context, params *ResetAllResourceLogLevelsInput, optFns ...func(*Options)) (*ResetAllResourceLogLevelsOutput, error)

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

func (*Client) ResetResourceLogLevel added in v1.6.0 

func (c *Client) ResetResourceLogLevel(ctx context.Context, params *ResetResourceLogLevelInput, optFns ...func(*Options)) (*ResetResourceLogLevelOutput, error)

Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

func (*Client) SendDataToMulticastGroup added in v1.12.0 

func (c *Client) SendDataToMulticastGroup(ctx context.Context, params *SendDataToMulticastGroupInput, optFns ...func(*Options)) (*SendDataToMulticastGroupOutput, error)

Sends the specified data to a multicast group.

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) StartBulkAssociateWirelessDeviceWithMulticastGroup added in v1.12.0 

func (c *Client) StartBulkAssociateWirelessDeviceWithMulticastGroup(ctx context.Context, params *StartBulkAssociateWirelessDeviceWithMulticastGroupInput, optFns ...func(*Options)) (*StartBulkAssociateWirelessDeviceWithMulticastGroupOutput, error)

Starts a bulk association of all qualifying wireless devices with a multicast group.

func (*Client) StartBulkDisassociateWirelessDeviceFromMulticastGroup added in v1.12.0 

func (c *Client) StartBulkDisassociateWirelessDeviceFromMulticastGroup(ctx context.Context, params *StartBulkDisassociateWirelessDeviceFromMulticastGroupInput, optFns ...func(*Options)) (*StartBulkDisassociateWirelessDeviceFromMulticastGroupOutput, error)

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

func (*Client) StartFuotaTask added in v1.12.0 

func (c *Client) StartFuotaTask(ctx context.Context, params *StartFuotaTaskInput, optFns ...func(*Options)) (*StartFuotaTaskOutput, error)

Starts a FUOTA task.

func (*Client) StartMulticastGroupSession added in v1.12.0 

func (c *Client) StartMulticastGroupSession(ctx context.Context, params *StartMulticastGroupSessionInput, optFns ...func(*Options)) (*StartMulticastGroupSessionOutput, error)

Starts a multicast group session.

func (*Client) StartSingleWirelessDeviceImportTask added in v1.26.0 

func (c *Client) StartSingleWirelessDeviceImportTask(ctx context.Context, params *StartSingleWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*StartSingleWirelessDeviceImportTaskOutput, error)

Start import task for a single wireless device.

func (*Client) StartWirelessDeviceImportTask added in v1.26.0 

func (c *Client) StartWirelessDeviceImportTask(ctx context.Context, params *StartWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*StartWirelessDeviceImportTaskOutput, error)

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

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) UpdateEventConfigurationByResourceTypes added in v1.19.0 

func (c *Client) UpdateEventConfigurationByResourceTypes(ctx context.Context, params *UpdateEventConfigurationByResourceTypesInput, optFns ...func(*Options)) (*UpdateEventConfigurationByResourceTypesOutput, error)

Update the event configuration based on resource types.

func (*Client) UpdateFuotaTask added in v1.12.0 

func (c *Client) UpdateFuotaTask(ctx context.Context, params *UpdateFuotaTaskInput, optFns ...func(*Options)) (*UpdateFuotaTaskOutput, error)

Updates properties of a FUOTA task.

func (*Client) UpdateLogLevelsByResourceTypes added in v1.6.0 

func (c *Client) UpdateLogLevelsByResourceTypes(ctx context.Context, params *UpdateLogLevelsByResourceTypesInput, optFns ...func(*Options)) (*UpdateLogLevelsByResourceTypesOutput, error)

Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

func (*Client) UpdateMetricConfiguration added in v1.37.0 

func (c *Client) UpdateMetricConfiguration(ctx context.Context, params *UpdateMetricConfigurationInput, optFns ...func(*Options)) (*UpdateMetricConfigurationOutput, error)

Update the summary metric configuration.

func (*Client) UpdateMulticastGroup added in v1.12.0 

func (c *Client) UpdateMulticastGroup(ctx context.Context, params *UpdateMulticastGroupInput, optFns ...func(*Options)) (*UpdateMulticastGroupOutput, error)

Updates properties of a multicast group session.

func (*Client) UpdateNetworkAnalyzerConfiguration added in v1.13.0 

func (c *Client) UpdateNetworkAnalyzerConfiguration(ctx context.Context, params *UpdateNetworkAnalyzerConfigurationInput, optFns ...func(*Options)) (*UpdateNetworkAnalyzerConfigurationOutput, error)

Update network analyzer configuration.

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) UpdatePosition deprecated added in v1.20.0 

func (c *Client) UpdatePosition(ctx context.Context, params *UpdatePositionInput, optFns ...func(*Options)) (*UpdatePositionOutput, error)

Update the position information of a resource.

This action is no longer supported. Calls to update the position information should use the UpdateResourcePositionAPI operation instead.

Deprecated: This operation is no longer supported.

func (*Client) UpdateResourceEventConfiguration added in v1.12.0 

func (c *Client) UpdateResourceEventConfiguration(ctx context.Context, params *UpdateResourceEventConfigurationInput, optFns ...func(*Options)) (*UpdateResourceEventConfigurationOutput, error)

Update the event configuration for a particular resource identifier.

func (*Client) UpdateResourcePosition added in v1.23.0 

func (c *Client) UpdateResourcePosition(ctx context.Context, params *UpdateResourcePositionInput, optFns ...func(*Options)) (*UpdateResourcePositionOutput, error)

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).

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) UpdateWirelessDeviceImportTask added in v1.26.0 

func (c *Client) UpdateWirelessDeviceImportTask(ctx context.Context, params *UpdateWirelessDeviceImportTaskInput, optFns ...func(*Options)) (*UpdateWirelessDeviceImportTaskOutput, error)

Update an import task to add more devices to the task.

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. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

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

	// The tags to attach to the new destination. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateDeviceProfileInput 

type CreateDeviceProfileInput struct {

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	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 Sidewalk-related information for creating the Sidewalk device profile.
	Sidewalk *types.SidewalkCreateDeviceProfile

	// The tags to attach to the new device profile. Tags are metadata that you can
	// use to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateFuotaTaskInput added in v1.12.0 

type CreateFuotaTaskInput struct {

	// The S3 URI points to a firmware update image that is to be used with a FUOTA
	// task.
	//
	// This member is required.
	FirmwareUpdateImage *string

	// The firmware update role that is to be used with a FUOTA task.
	//
	// This member is required.
	FirmwareUpdateRole *string

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

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

	// The interval for sending fragments in milliseconds, rounded to the nearest
	// second.
	//
	// This interval only determines the timing for when the Cloud sends down the
	// fragments to yor device. There can be a delay for when your device will receive
	// these fragments. This delay depends on the device's class and the communication
	// delay with the cloud.
	FragmentIntervalMS *int32

	// The size of each fragment in bytes. This parameter is supported only for FUOTA
	// tasks with multicast groups.
	FragmentSizeBytes *int32

	// The LoRaWAN information used with a FUOTA task.
	LoRaWAN *types.LoRaWANFuotaTask

	// The name of a FUOTA task.
	Name *string

	// The percentage of the added fragments that are redundant. For example, if the
	// size of the firmware image file is 100 bytes and the fragment size is 10 bytes,
	// with RedundancyPercent set to 50(%), the final number of encoded fragments is
	// (100 / 10) + (100 / 10 * 50%) = 15.
	RedundancyPercent *int32

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFuotaTaskOutput added in v1.12.0 

type CreateFuotaTaskOutput struct {

	// The arn of a FUOTA task.
	Arn *string

	// The ID of a FUOTA task.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMulticastGroupInput added in v1.12.0 

type CreateMulticastGroupInput struct {

	// The LoRaWAN information that is to be used with the multicast group.
	//
	// This member is required.
	LoRaWAN *types.LoRaWANMulticast

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

	// The description of the multicast group.
	Description *string

	// The name of the multicast group.
	Name *string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMulticastGroupOutput added in v1.12.0 

type CreateMulticastGroupOutput struct {

	// The arn of the multicast group.
	Arn *string

	// The ID of the multicast group.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateNetworkAnalyzerConfigurationInput added in v1.19.0 

type CreateNetworkAnalyzerConfigurationInput struct {

	// Name of the network analyzer configuration.
	//
	// This member is required.
	Name *string

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

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

	// Multicast Group resources to add to the network analyzer configruation. Provide
	// the MulticastGroupId of the resource to add in the input array.
	MulticastGroups []string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag

	// Trace content for your wireless devices, gateways, and multicast groups.
	TraceContent *types.TraceContent

	// Wireless device resources to add to the network analyzer configuration. Provide
	// the WirelessDeviceId of the resource to add in the input array.
	WirelessDevices []string

	// Wireless gateway resources to add to the network analyzer configuration.
	// Provide the WirelessGatewayId of the resource to add in the input array.
	WirelessGateways []string
	// contains filtered or unexported fields
}

type CreateNetworkAnalyzerConfigurationOutput added in v1.19.0 

type CreateNetworkAnalyzerConfigurationOutput struct {

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

	// Name of the network analyzer configuration.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateServiceProfileInput 

type CreateServiceProfileInput struct {

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	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 you can
	// use to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	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

	// FPort values for the GNSS, stream, and ClockSync functions of the positioning
	// information.
	Positioning types.PositioningConfigStatus

	// The device configuration information to use to create the Sidewalk device.
	Sidewalk *types.SidewalkCreateWirelessDevice

	// The tags to attach to the new wireless device. Tags are metadata that you can
	// use to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	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 you can
	// use to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

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

	// The tags to attach to the specified resource. Tags are metadata that you can
	// use to manage a resource.
	Tags []types.Tag

	// Information about the gateways to update.
	Update *types.UpdateWirelessGatewayTaskCreate
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DeleteDestinationInput 

type DeleteDestinationInput struct {

	// The name of the resource to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteDestinationOutput 

type DeleteDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDeviceProfileInput 

type DeleteDeviceProfileInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteDeviceProfileOutput 

type DeleteDeviceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFuotaTaskInput added in v1.12.0 

type DeleteFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteFuotaTaskOutput added in v1.12.0 

type DeleteFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMulticastGroupInput added in v1.12.0 

type DeleteMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteMulticastGroupOutput added in v1.12.0 

type DeleteMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNetworkAnalyzerConfigurationInput added in v1.19.0 

type DeleteNetworkAnalyzerConfigurationInput struct {

	// Name of the network analyzer configuration.
	//
	// This member is required.
	ConfigurationName *string
	// contains filtered or unexported fields
}

type DeleteNetworkAnalyzerConfigurationOutput added in v1.19.0 

type DeleteNetworkAnalyzerConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQueuedMessagesInput added in v1.16.0 

type DeleteQueuedMessagesInput struct {

	// The ID of a given wireless device for which downlink messages will be deleted.
	//
	// This member is required.
	Id *string

	// If message ID is "*" , it cleares the entire downlink queue for a given device,
	// specified by the wireless device ID. Otherwise, the downlink message with the
	// specified message ID will be deleted.
	//
	// This member is required.
	MessageId *string

	// The wireless device type, which can be either Sidewalk or LoRaWAN.
	WirelessDeviceType types.WirelessDeviceType
	// contains filtered or unexported fields
}

type DeleteQueuedMessagesOutput added in v1.16.0 

type DeleteQueuedMessagesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteServiceProfileInput 

type DeleteServiceProfileInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteServiceProfileOutput 

type DeleteServiceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWirelessDeviceImportTaskInput added in v1.26.0 

type DeleteWirelessDeviceImportTaskInput struct {

	// The unique identifier of the import task to be deleted.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWirelessDeviceImportTaskOutput added in v1.26.0 

type DeleteWirelessDeviceImportTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWirelessDeviceInput 

type DeleteWirelessDeviceInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWirelessDeviceOutput 

type DeleteWirelessDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayInput 

type DeleteWirelessGatewayInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayOutput 

type DeleteWirelessGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayTaskDefinitionInput 

type DeleteWirelessGatewayTaskDefinitionInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayTaskDefinitionOutput 

type DeleteWirelessGatewayTaskDefinitionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayTaskInput 

type DeleteWirelessGatewayTaskInput struct {

	// The ID of the resource to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWirelessGatewayTaskOutput 

type DeleteWirelessGatewayTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterWirelessDeviceInput added in v1.26.0 

type DeregisterWirelessDeviceInput struct {

	// The identifier of the wireless device to deregister from AWS IoT Wireless.
	//
	// This member is required.
	Identifier *string

	// The type of wireless device to deregister from AWS IoT Wireless, which can be
	// LoRaWAN or Sidewalk .
	WirelessDeviceType types.WirelessDeviceType
	// contains filtered or unexported fields
}

type DeregisterWirelessDeviceOutput added in v1.26.0 

type DeregisterWirelessDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DisassociateAwsAccountFromPartnerAccountOutput 

type DisassociateAwsAccountFromPartnerAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMulticastGroupFromFuotaTaskInput added in v1.12.0 

type DisassociateMulticastGroupFromFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

	// The ID of the multicast group.
	//
	// This member is required.
	MulticastGroupId *string
	// contains filtered or unexported fields
}

type DisassociateMulticastGroupFromFuotaTaskOutput added in v1.12.0 

type DisassociateMulticastGroupFromFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromFuotaTaskInput added in v1.12.0 

type DisassociateWirelessDeviceFromFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

	// The ID of the wireless device.
	//
	// This member is required.
	WirelessDeviceId *string
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromFuotaTaskOutput added in v1.12.0 

type DisassociateWirelessDeviceFromFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromMulticastGroupInput added in v1.12.0 

type DisassociateWirelessDeviceFromMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// The ID of the wireless device.
	//
	// This member is required.
	WirelessDeviceId *string
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromMulticastGroupOutput added in v1.12.0 

type DisassociateWirelessDeviceFromMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromThingInput 

type DisassociateWirelessDeviceFromThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DisassociateWirelessDeviceFromThingOutput 

type DisassociateWirelessDeviceFromThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWirelessGatewayFromCertificateInput 

type DisassociateWirelessGatewayFromCertificateInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DisassociateWirelessGatewayFromCertificateOutput 

type DisassociateWirelessGatewayFromCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWirelessGatewayFromThingInput 

type DisassociateWirelessGatewayFromThingInput struct {

	// The ID of the resource to update.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DisassociateWirelessGatewayFromThingOutput 

type DisassociateWirelessGatewayFromThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.29.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.29.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.29.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 added in v1.29.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.29.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDestinationInput 

type GetDestinationInput struct {

	// The name of the resource to get.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetDeviceProfileInput 

type GetDeviceProfileInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

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

	// Information about the Sidewalk parameters in the device profile.
	Sidewalk *types.SidewalkGetDeviceProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEventConfigurationByResourceTypesInput added in v1.19.0 

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

type GetEventConfigurationByResourceTypesOutput added in v1.19.0 

type GetEventConfigurationByResourceTypesOutput struct {

	// Resource type event configuration for the connection status event.
	ConnectionStatus *types.ConnectionStatusResourceTypeEventConfiguration

	// Resource type event configuration for the device registration state event.
	DeviceRegistrationState *types.DeviceRegistrationStateResourceTypeEventConfiguration

	// Resource type event configuration for the join event.
	Join *types.JoinResourceTypeEventConfiguration

	// Resource type event configuration object for the message delivery status event.
	MessageDeliveryStatus *types.MessageDeliveryStatusResourceTypeEventConfiguration

	// Resource type event configuration for the proximity event.
	Proximity *types.ProximityResourceTypeEventConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFuotaTaskInput added in v1.12.0 

type GetFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetFuotaTaskOutput added in v1.12.0 

type GetFuotaTaskOutput struct {

	// The arn of a FUOTA task.
	Arn *string

	// Created at timestamp for the resource.
	CreatedAt *time.Time

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

	// The S3 URI points to a firmware update image that is to be used with a FUOTA
	// task.
	FirmwareUpdateImage *string

	// The firmware update role that is to be used with a FUOTA task.
	FirmwareUpdateRole *string

	// The interval for sending fragments in milliseconds, rounded to the nearest
	// second.
	//
	// This interval only determines the timing for when the Cloud sends down the
	// fragments to yor device. There can be a delay for when your device will receive
	// these fragments. This delay depends on the device's class and the communication
	// delay with the cloud.
	FragmentIntervalMS *int32

	// The size of each fragment in bytes. This parameter is supported only for FUOTA
	// tasks with multicast groups.
	FragmentSizeBytes *int32

	// The ID of a FUOTA task.
	Id *string

	// The LoRaWAN information returned from getting a FUOTA task.
	LoRaWAN *types.LoRaWANFuotaTaskGetInfo

	// The name of a FUOTA task.
	Name *string

	// The percentage of the added fragments that are redundant. For example, if the
	// size of the firmware image file is 100 bytes and the fragment size is 10 bytes,
	// with RedundancyPercent set to 50(%), the final number of encoded fragments is
	// (100 / 10) + (100 / 10 * 50%) = 15.
	RedundancyPercent *int32

	// The status of a FUOTA task.
	Status types.FuotaTaskStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLogLevelsByResourceTypesInput added in v1.6.0 

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

type GetLogLevelsByResourceTypesOutput added in v1.6.0 

type GetLogLevelsByResourceTypesOutput struct {

	// The log level for a log message. The log levels can be disabled, or set to ERROR
	// to display less verbose logs containing only error information, or to INFO for
	// more detailed logs.
	DefaultLogLevel types.LogLevel

	// The list of wireless device log options.
	WirelessDeviceLogOptions []types.WirelessDeviceLogOption

	// The list of wireless gateway log options.
	WirelessGatewayLogOptions []types.WirelessGatewayLogOption

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMetricConfigurationInput added in v1.37.0 

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

type GetMetricConfigurationOutput added in v1.37.0 

type GetMetricConfigurationOutput struct {

	// The configuration status of the AWS account for summary metric aggregation.
	SummaryMetric *types.SummaryMetricConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMetricsInput added in v1.37.0 

type GetMetricsInput struct {

	// The list of queries to retrieve the summary metrics.
	SummaryMetricQueries []types.SummaryMetricQuery
	// contains filtered or unexported fields
}

type GetMetricsOutput added in v1.37.0 

type GetMetricsOutput struct {

	// The list of summary metrics that were retrieved.
	SummaryMetricQueryResults []types.SummaryMetricQueryResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMulticastGroupInput added in v1.12.0 

type GetMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetMulticastGroupOutput added in v1.12.0 

type GetMulticastGroupOutput struct {

	// The arn of the multicast group.
	Arn *string

	// Created at timestamp for the resource.
	CreatedAt *time.Time

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

	// The ID of the multicast group.
	Id *string

	// The LoRaWAN information that is to be returned from getting multicast group
	// information.
	LoRaWAN *types.LoRaWANMulticastGet

	// The name of the multicast group.
	Name *string

	// The status of the multicast group.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMulticastGroupSessionInput added in v1.12.0 

type GetMulticastGroupSessionInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetMulticastGroupSessionOutput added in v1.12.0 

type GetMulticastGroupSessionOutput struct {

	// The LoRaWAN information used with the multicast session.
	LoRaWAN *types.LoRaWANMulticastSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetNetworkAnalyzerConfigurationInput added in v1.13.0 

type GetNetworkAnalyzerConfigurationInput struct {

	// Name of the network analyzer configuration.
	//
	// This member is required.
	ConfigurationName *string
	// contains filtered or unexported fields
}

type GetNetworkAnalyzerConfigurationOutput added in v1.13.0 

type GetNetworkAnalyzerConfigurationOutput struct {

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

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

	// List of multicast group resources that have been added to the network analyzer
	// configuration.
	MulticastGroups []string

	// Name of the network analyzer configuration.
	Name *string

	// Trace content for your wireless devices, gateways, and multicast groups.
	TraceContent *types.TraceContent

	// List of wireless device resources that have been added to the network analyzer
	// configuration.
	WirelessDevices []string

	// List of wireless gateway resources that have been added to the network analyzer
	// configuration.
	WirelessGateways []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetPositionConfigurationInput added in v1.20.0 

type GetPositionConfigurationInput struct {

	// Resource identifier used in a position configuration.
	//
	// This member is required.
	ResourceIdentifier *string

	// Resource type of the resource for which position configuration is retrieved.
	//
	// This member is required.
	ResourceType types.PositionResourceType
	// contains filtered or unexported fields
}

type GetPositionConfigurationOutput added in v1.20.0 

type GetPositionConfigurationOutput struct {

	// The position data destination that describes the AWS IoT rule that processes
	// the device's position data for use by AWS IoT Core for LoRaWAN.
	Destination *string

	// The wrapper for the solver configuration details object.
	Solvers *types.PositionSolverDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPositionEstimateInput added in v1.23.0 

type GetPositionEstimateInput struct {

	// Retrieves an estimated device position by resolving measurement data from
	// cellular radio towers. The position is resolved using HERE's cellular-based
	// solver.
	CellTowers *types.CellTowers

	// Retrieves an estimated device position by resolving the global navigation
	// satellite system (GNSS) scan data. The position is resolved using the GNSS
	// solver powered by LoRa Cloud.
	Gnss *types.Gnss

	// Retrieves an estimated device position by resolving the IP address information
	// from the device. The position is resolved using MaxMind's IP-based solver.
	Ip *types.Ip

	// Optional information that specifies the time when the position information will
	// be resolved. It uses the Unix timestamp format. If not specified, the time at
	// which the request was received will be used.
	Timestamp *time.Time

	// Retrieves an estimated device position by resolving WLAN measurement data. The
	// position is resolved using HERE's Wi-Fi based solver.
	WiFiAccessPoints []types.WiFiAccessPoint
	// contains filtered or unexported fields
}

type GetPositionEstimateOutput added in v1.23.0 

type GetPositionEstimateOutput struct {

	// The position information of the resource, displayed as a JSON payload. The
	// payload is of type blob and uses the [GeoJSON]format, which a format that's used to
	// encode geographic data structures. A sample payload contains the timestamp
	// information, the WGS84 coordinates of the location, and the accuracy and
	// confidence level. For more information and examples, see [Resolve device location (console)].
	//
	// [Resolve device location (console)]: https://docs.aws.amazon.com/iot/latest/developerguide/location-resolve-console.html
	// [GeoJSON]: https://geojson.org/
	GeoJsonPayload []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPositionInput added in v1.20.0 

type GetPositionInput struct {

	// Resource identifier used to retrieve the position information.
	//
	// This member is required.
	ResourceIdentifier *string

	// Resource type of the resource for which position information is retrieved.
	//
	// This member is required.
	ResourceType types.PositionResourceType
	// contains filtered or unexported fields
}

type GetPositionOutput added in v1.20.0 

type GetPositionOutput struct {

	// The accuracy of the estimated position in meters. An empty value indicates that
	// no position data is available. A value of ‘0.0’ value indicates that position
	// data is available. This data corresponds to the position information that you
	// specified instead of the position computed by solver.
	Accuracy *types.Accuracy

	// The position information of the resource.
	Position []float32

	// The vendor of the positioning solver.
	SolverProvider types.PositionSolverProvider

	// The type of solver used to identify the position of the resource.
	SolverType types.PositionSolverType

	// The version of the positioning solver.
	SolverVersion *string

	// The timestamp at which the device's position was determined.
	Timestamp *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceEventConfigurationInput added in v1.12.0 

type GetResourceEventConfigurationInput struct {

	// Resource identifier to opt in for event messaging.
	//
	// This member is required.
	Identifier *string

	// Identifier type of the particular resource identifier for event configuration.
	//
	// This member is required.
	IdentifierType types.IdentifierType

	// Partner type of the resource if the identifier type is PartnerAccountId .
	PartnerType types.EventNotificationPartnerType
	// contains filtered or unexported fields
}

type GetResourceEventConfigurationOutput added in v1.12.0 

type GetResourceEventConfigurationOutput struct {

	// Event configuration for the connection status event.
	ConnectionStatus *types.ConnectionStatusEventConfiguration

	// Event configuration for the device registration state event.
	DeviceRegistrationState *types.DeviceRegistrationStateEventConfiguration

	// Event configuration for the join event.
	Join *types.JoinEventConfiguration

	// Event configuration for the message delivery status event.
	MessageDeliveryStatus *types.MessageDeliveryStatusEventConfiguration

	// Event configuration for the proximity event.
	Proximity *types.ProximityEventConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceLogLevelInput added in v1.6.0 

type GetResourceLogLevelInput struct {

	// The identifier of the resource. For a Wireless Device, it is the wireless
	// device ID. For a wireless gateway, it is the wireless gateway ID.
	//
	// This member is required.
	ResourceIdentifier *string

	// The type of the resource, which can be WirelessDevice or WirelessGateway .
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

type GetResourceLogLevelOutput added in v1.6.0 

type GetResourceLogLevelOutput struct {

	// The log level for a log message. The log levels can be disabled, or set to ERROR
	// to display less verbose logs containing only error information, or to INFO for
	// more detailed logs.
	LogLevel types.LogLevel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourcePositionInput added in v1.23.0 

type GetResourcePositionInput struct {

	// The identifier of the resource for which position information is retrieved. It
	// can be the wireless device ID or the wireless gateway ID, depending on the
	// resource type.
	//
	// This member is required.
	ResourceIdentifier *string

	// The type of resource for which position information is retrieved, which can be
	// a wireless device or a wireless gateway.
	//
	// This member is required.
	ResourceType types.PositionResourceType
	// contains filtered or unexported fields
}

type GetResourcePositionOutput added in v1.23.0 

type GetResourcePositionOutput struct {

	// The position information of the resource, displayed as a JSON payload. The
	// payload uses the GeoJSON format, which a format that's used to encode geographic
	// data structures. For more information, see [GeoJSON].
	//
	// [GeoJSON]: https://geojson.org/
	GeoJsonPayload []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 or CLAIM for the global endpoint.
	ServiceType types.WirelessGatewayServiceType
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetServiceProfileInput 

type GetServiceProfileInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetWirelessDeviceImportTaskInput added in v1.26.0 

type GetWirelessDeviceImportTaskInput struct {

	// The identifier of the import task for which information is requested.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetWirelessDeviceImportTaskOutput added in v1.26.0 

type GetWirelessDeviceImportTaskOutput struct {

	// The ARN (Amazon Resource Name) of the import task.
	Arn *string

	// The time at which the import task was created.
	CreationTime *time.Time

	// The name of the destination that's assigned to the wireless devices in the
	// import task.
	DestinationName *string

	// The number of devices in the import task that failed to onboard to the import
	// task.
	FailedImportedDeviceCount *int64

	// The identifier of the import task for which information is retrieved.
	Id *string

	// The number of devices in the import task that are waiting for the control log
	// to start processing.
	InitializedImportedDeviceCount *int64

	// The number of devices in the import task that have been onboarded to the import
	// task.
	OnboardedImportedDeviceCount *int64

	// The number of devices in the import task that are waiting in the import task
	// queue to be onboarded.
	PendingImportedDeviceCount *int64

	// The Sidewalk-related information about an import task.
	Sidewalk *types.SidewalkGetStartImportInfo

	// The import task status.
	Status types.ImportTaskStatus

	// The reason for the provided status information, such as a validation error that
	// causes the import task to fail.
	StatusReason *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// FPort values for the GNSS, stream, and ClockSync functions of the positioning
	// information.
	Positioning types.PositioningConfigStatus

	// Sidewalk device object.
	Sidewalk *types.SidewalkDevice

	// 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
	// contains filtered or unexported fields
}

type GetWirelessDeviceStatisticsInput 

type GetWirelessDeviceStatisticsInput struct {

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

type GetWirelessDeviceStatisticsOutput 

type GetWirelessDeviceStatisticsOutput struct {

	// The date and time when the most recent uplink was received.
	//
	// This value is only valid for 3 months.
	LastUplinkReceivedAt *string

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

	// MetaData for Sidewalk device.
	Sidewalk *types.SidewalkDeviceMetadata

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWirelessGatewayCertificateInput 

type GetWirelessGatewayCertificateInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetWirelessGatewayFirmwareInformationInput 

type GetWirelessGatewayFirmwareInformationInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetWirelessGatewayStatisticsInput 

type GetWirelessGatewayStatisticsInput struct {

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

type GetWirelessGatewayStatisticsOutput 

type GetWirelessGatewayStatisticsOutput struct {

	// The connection status of the wireless gateway.
	ConnectionStatus types.ConnectionStatus

	// The date and time when the most recent uplink was received.
	//
	// This value is only valid for 3 months.
	LastUplinkReceivedAt *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWirelessGatewayTaskDefinitionInput 

type GetWirelessGatewayTaskDefinitionInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetWirelessGatewayTaskInput 

type GetWirelessGatewayTaskInput struct {

	// The ID of the resource to get.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetWirelessGatewayTaskOutput 

type GetWirelessGatewayTaskOutput struct {

	// The date and time when the most recent uplink was received.
	//
	// This value is only valid for 3 months.
	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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 {

	// A filter to list only device profiles that use this type, which can be LoRaWAN
	// or Sidewalk .
	DeviceProfileType types.DeviceProfileType

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 ListDevicesForWirelessDeviceImportTaskInput added in v1.26.0 

type ListDevicesForWirelessDeviceImportTaskInput struct {

	// The identifier of the import task for which wireless devices are listed.
	//
	// This member is required.
	Id *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

	// The status of the devices in the import task.
	Status types.OnboardStatus
	// contains filtered or unexported fields
}

type ListDevicesForWirelessDeviceImportTaskOutput added in v1.26.0 

type ListDevicesForWirelessDeviceImportTaskOutput struct {

	// The name of the Sidewalk destination that describes the IoT rule to route
	// messages received from devices in an import task that are onboarded to AWS IoT
	// Wireless.
	DestinationName *string

	// List of wireless devices in an import task and their onboarding status.
	ImportedWirelessDeviceList []types.ImportedWirelessDevice

	// 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
	// contains filtered or unexported fields
}

type ListEventConfigurationsInput added in v1.19.0 

type ListEventConfigurationsInput struct {

	// Resource type to filter event configurations.
	//
	// This member is required.
	ResourceType types.EventNotificationResourceType

	// 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
	// contains filtered or unexported fields
}

type ListEventConfigurationsOutput added in v1.19.0 

type ListEventConfigurationsOutput struct {

	// Event configurations of all events for a single resource.
	EventConfigurationsList []types.EventConfigurationItem

	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFuotaTasksAPIClient added in v1.12.0 

type ListFuotaTasksAPIClient interface {
	ListFuotaTasks(context.Context, *ListFuotaTasksInput, ...func(*Options)) (*ListFuotaTasksOutput, error)
}

ListFuotaTasksAPIClient is a client that implements the ListFuotaTasks operation.

type ListFuotaTasksInput added in v1.12.0 

type ListFuotaTasksInput 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
	// contains filtered or unexported fields
}

type ListFuotaTasksOutput added in v1.12.0 

type ListFuotaTasksOutput struct {

	// Lists the FUOTA tasks registered to your AWS account.
	FuotaTaskList []types.FuotaTask

	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFuotaTasksPaginator added in v1.12.0 

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

ListFuotaTasksPaginator is a paginator for ListFuotaTasks

func NewListFuotaTasksPaginator added in v1.12.0 

func NewListFuotaTasksPaginator(client ListFuotaTasksAPIClient, params *ListFuotaTasksInput, optFns ...func(*ListFuotaTasksPaginatorOptions)) *ListFuotaTasksPaginator

NewListFuotaTasksPaginator returns a new ListFuotaTasksPaginator

func (*ListFuotaTasksPaginator) HasMorePages added in v1.12.0 

func (p *ListFuotaTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFuotaTasksPaginator) NextPage added in v1.12.0 

func (p *ListFuotaTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFuotaTasksOutput, error)

NextPage retrieves the next ListFuotaTasks page.

type ListFuotaTasksPaginatorOptions added in v1.12.0 

type ListFuotaTasksPaginatorOptions 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
}

ListFuotaTasksPaginatorOptions is the paginator options for ListFuotaTasks

type ListMulticastGroupsAPIClient added in v1.12.0 

type ListMulticastGroupsAPIClient interface {
	ListMulticastGroups(context.Context, *ListMulticastGroupsInput, ...func(*Options)) (*ListMulticastGroupsOutput, error)
}

ListMulticastGroupsAPIClient is a client that implements the ListMulticastGroups operation.

type ListMulticastGroupsByFuotaTaskAPIClient added in v1.12.0 

type ListMulticastGroupsByFuotaTaskAPIClient interface {
	ListMulticastGroupsByFuotaTask(context.Context, *ListMulticastGroupsByFuotaTaskInput, ...func(*Options)) (*ListMulticastGroupsByFuotaTaskOutput, error)
}

ListMulticastGroupsByFuotaTaskAPIClient is a client that implements the ListMulticastGroupsByFuotaTask operation.

type ListMulticastGroupsByFuotaTaskInput added in v1.12.0 

type ListMulticastGroupsByFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *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
	// contains filtered or unexported fields
}

type ListMulticastGroupsByFuotaTaskOutput added in v1.12.0 

type ListMulticastGroupsByFuotaTaskOutput struct {

	// List of multicast groups associated with a FUOTA task.
	MulticastGroupList []types.MulticastGroupByFuotaTask

	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMulticastGroupsByFuotaTaskPaginator added in v1.12.0 

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

ListMulticastGroupsByFuotaTaskPaginator is a paginator for ListMulticastGroupsByFuotaTask

func NewListMulticastGroupsByFuotaTaskPaginator added in v1.12.0 

func NewListMulticastGroupsByFuotaTaskPaginator(client ListMulticastGroupsByFuotaTaskAPIClient, params *ListMulticastGroupsByFuotaTaskInput, optFns ...func(*ListMulticastGroupsByFuotaTaskPaginatorOptions)) *ListMulticastGroupsByFuotaTaskPaginator

NewListMulticastGroupsByFuotaTaskPaginator returns a new ListMulticastGroupsByFuotaTaskPaginator

func (*ListMulticastGroupsByFuotaTaskPaginator) HasMorePages added in v1.12.0 

func (p *ListMulticastGroupsByFuotaTaskPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMulticastGroupsByFuotaTaskPaginator) NextPage added in v1.12.0 

func (p *ListMulticastGroupsByFuotaTaskPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMulticastGroupsByFuotaTaskOutput, error)

NextPage retrieves the next ListMulticastGroupsByFuotaTask page.

type ListMulticastGroupsByFuotaTaskPaginatorOptions added in v1.12.0 

type ListMulticastGroupsByFuotaTaskPaginatorOptions 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
}

ListMulticastGroupsByFuotaTaskPaginatorOptions is the paginator options for ListMulticastGroupsByFuotaTask

type ListMulticastGroupsInput added in v1.12.0 

type ListMulticastGroupsInput 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
	// contains filtered or unexported fields
}

type ListMulticastGroupsOutput added in v1.12.0 

type ListMulticastGroupsOutput struct {

	// List of multicast groups.
	MulticastGroupList []types.MulticastGroup

	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMulticastGroupsPaginator added in v1.12.0 

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

ListMulticastGroupsPaginator is a paginator for ListMulticastGroups

func NewListMulticastGroupsPaginator added in v1.12.0 

func NewListMulticastGroupsPaginator(client ListMulticastGroupsAPIClient, params *ListMulticastGroupsInput, optFns ...func(*ListMulticastGroupsPaginatorOptions)) *ListMulticastGroupsPaginator

NewListMulticastGroupsPaginator returns a new ListMulticastGroupsPaginator

func (*ListMulticastGroupsPaginator) HasMorePages added in v1.12.0 

func (p *ListMulticastGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMulticastGroupsPaginator) NextPage added in v1.12.0 

func (p *ListMulticastGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMulticastGroupsOutput, error)

NextPage retrieves the next ListMulticastGroups page.

type ListMulticastGroupsPaginatorOptions added in v1.12.0 

type ListMulticastGroupsPaginatorOptions 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
}

ListMulticastGroupsPaginatorOptions is the paginator options for ListMulticastGroups

type ListNetworkAnalyzerConfigurationsAPIClient added in v1.19.0 

type ListNetworkAnalyzerConfigurationsAPIClient interface {
	ListNetworkAnalyzerConfigurations(context.Context, *ListNetworkAnalyzerConfigurationsInput, ...func(*Options)) (*ListNetworkAnalyzerConfigurationsOutput, error)
}

ListNetworkAnalyzerConfigurationsAPIClient is a client that implements the ListNetworkAnalyzerConfigurations operation.

type ListNetworkAnalyzerConfigurationsInput added in v1.19.0 

type ListNetworkAnalyzerConfigurationsInput 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
	// contains filtered or unexported fields
}

type ListNetworkAnalyzerConfigurationsOutput added in v1.19.0 

type ListNetworkAnalyzerConfigurationsOutput struct {

	// The list of network analyzer configurations.
	NetworkAnalyzerConfigurationList []types.NetworkAnalyzerConfigurations

	// 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
	// contains filtered or unexported fields
}

type ListNetworkAnalyzerConfigurationsPaginator added in v1.19.0 

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

ListNetworkAnalyzerConfigurationsPaginator is a paginator for ListNetworkAnalyzerConfigurations

func NewListNetworkAnalyzerConfigurationsPaginator added in v1.19.0 

func NewListNetworkAnalyzerConfigurationsPaginator(client ListNetworkAnalyzerConfigurationsAPIClient, params *ListNetworkAnalyzerConfigurationsInput, optFns ...func(*ListNetworkAnalyzerConfigurationsPaginatorOptions)) *ListNetworkAnalyzerConfigurationsPaginator

NewListNetworkAnalyzerConfigurationsPaginator returns a new ListNetworkAnalyzerConfigurationsPaginator

func (*ListNetworkAnalyzerConfigurationsPaginator) HasMorePages added in v1.19.0 

func (p *ListNetworkAnalyzerConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNetworkAnalyzerConfigurationsPaginator) NextPage added in v1.19.0 

func (p *ListNetworkAnalyzerConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNetworkAnalyzerConfigurationsOutput, error)

NextPage retrieves the next ListNetworkAnalyzerConfigurations page.

type ListNetworkAnalyzerConfigurationsPaginatorOptions added in v1.19.0 

type ListNetworkAnalyzerConfigurationsPaginatorOptions 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
}

ListNetworkAnalyzerConfigurationsPaginatorOptions is the paginator options for ListNetworkAnalyzerConfigurations

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListPositionConfigurationsAPIClient added in v1.20.0 

type ListPositionConfigurationsAPIClient interface {
	ListPositionConfigurations(context.Context, *ListPositionConfigurationsInput, ...func(*Options)) (*ListPositionConfigurationsOutput, error)
}

ListPositionConfigurationsAPIClient is a client that implements the ListPositionConfigurations operation.

type ListPositionConfigurationsInput added in v1.20.0 

type ListPositionConfigurationsInput 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

	// Resource type for which position configurations are listed.
	ResourceType types.PositionResourceType
	// contains filtered or unexported fields
}

type ListPositionConfigurationsOutput added in v1.20.0 

type ListPositionConfigurationsOutput struct {

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

	// A list of position configurations.
	PositionConfigurationList []types.PositionConfigurationItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPositionConfigurationsPaginator added in v1.20.0 

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

ListPositionConfigurationsPaginator is a paginator for ListPositionConfigurations

func NewListPositionConfigurationsPaginator added in v1.20.0 

func NewListPositionConfigurationsPaginator(client ListPositionConfigurationsAPIClient, params *ListPositionConfigurationsInput, optFns ...func(*ListPositionConfigurationsPaginatorOptions)) *ListPositionConfigurationsPaginator

NewListPositionConfigurationsPaginator returns a new ListPositionConfigurationsPaginator

func (*ListPositionConfigurationsPaginator) HasMorePages added in v1.20.0 

func (p *ListPositionConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPositionConfigurationsPaginator) NextPage added in v1.20.0 

func (p *ListPositionConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPositionConfigurationsOutput, error)

NextPage retrieves the next ListPositionConfigurations page.

type ListPositionConfigurationsPaginatorOptions added in v1.20.0 

type ListPositionConfigurationsPaginatorOptions 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
}

ListPositionConfigurationsPaginatorOptions is the paginator options for ListPositionConfigurations

type ListQueuedMessagesAPIClient added in v1.16.0 

type ListQueuedMessagesAPIClient interface {
	ListQueuedMessages(context.Context, *ListQueuedMessagesInput, ...func(*Options)) (*ListQueuedMessagesOutput, error)
}

ListQueuedMessagesAPIClient is a client that implements the ListQueuedMessages operation.

type ListQueuedMessagesInput added in v1.16.0 

type ListQueuedMessagesInput struct {

	// The ID of a given wireless device which the downlink message packets are being
	// sent.
	//
	// This member is required.
	Id *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

	// The wireless device type, whic can be either Sidewalk or LoRaWAN.
	WirelessDeviceType types.WirelessDeviceType
	// contains filtered or unexported fields
}

type ListQueuedMessagesOutput added in v1.16.0 

type ListQueuedMessagesOutput struct {

	// The messages in the downlink queue.
	DownlinkQueueMessagesList []types.DownlinkQueueMessage

	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueuedMessagesPaginator added in v1.16.0 

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

ListQueuedMessagesPaginator is a paginator for ListQueuedMessages

func NewListQueuedMessagesPaginator added in v1.16.0 

func NewListQueuedMessagesPaginator(client ListQueuedMessagesAPIClient, params *ListQueuedMessagesInput, optFns ...func(*ListQueuedMessagesPaginatorOptions)) *ListQueuedMessagesPaginator

NewListQueuedMessagesPaginator returns a new ListQueuedMessagesPaginator

func (*ListQueuedMessagesPaginator) HasMorePages added in v1.16.0 

func (p *ListQueuedMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueuedMessagesPaginator) NextPage added in v1.16.0 

func (p *ListQueuedMessagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueuedMessagesOutput, error)

NextPage retrieves the next ListQueuedMessages page.

type ListQueuedMessagesPaginatorOptions added in v1.16.0 

type ListQueuedMessagesPaginatorOptions 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
}

ListQueuedMessagesPaginatorOptions is the paginator options for ListQueuedMessages

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 you want to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags to attach to the specified resource. Tags are metadata that you can
	// use to manage a resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWirelessDeviceImportTasksInput added in v1.26.0 

type ListWirelessDeviceImportTasksInput 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
	// contains filtered or unexported fields
}

type ListWirelessDeviceImportTasksOutput added in v1.26.0 

type ListWirelessDeviceImportTasksOutput struct {

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

	// List of import tasks and summary information of onboarding status of devices in
	// each import task.
	WirelessDeviceImportTaskList []types.WirelessDeviceImportTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 ID of a FUOTA task.
	FuotaTaskId *string

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

	// The ID of the multicast group.
	MulticastGroupId *string

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.33.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutPositionConfigurationInput added in v1.20.0 

type PutPositionConfigurationInput struct {

	// Resource identifier used to update the position configuration.
	//
	// This member is required.
	ResourceIdentifier *string

	// Resource type of the resource for which you want to update the position
	// configuration.
	//
	// This member is required.
	ResourceType types.PositionResourceType

	// The position data destination that describes the AWS IoT rule that processes
	// the device's position data for use by AWS IoT Core for LoRaWAN.
	Destination *string

	// The positioning solvers used to update the position configuration of the
	// resource.
	Solvers *types.PositionSolverConfigurations
	// contains filtered or unexported fields
}

type PutPositionConfigurationOutput added in v1.20.0 

type PutPositionConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutResourceLogLevelInput added in v1.6.0 

type PutResourceLogLevelInput struct {

	// The log level for a log message. The log levels can be disabled, or set to ERROR
	// to display less verbose logs containing only error information, or to INFO for
	// more detailed logs.
	//
	// This member is required.
	LogLevel types.LogLevel

	// The identifier of the resource. For a Wireless Device, it is the wireless
	// device ID. For a wireless gateway, it is the wireless gateway ID.
	//
	// This member is required.
	ResourceIdentifier *string

	// The type of the resource, which can be WirelessDevice or WirelessGateway .
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

type PutResourceLogLevelOutput added in v1.6.0 

type PutResourceLogLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResetAllResourceLogLevelsInput added in v1.6.0 

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

type ResetAllResourceLogLevelsOutput added in v1.6.0 

type ResetAllResourceLogLevelsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResetResourceLogLevelInput added in v1.6.0 

type ResetResourceLogLevelInput struct {

	// The identifier of the resource. For a Wireless Device, it is the wireless
	// device ID. For a wireless gateway, it is the wireless gateway ID.
	//
	// This member is required.
	ResourceIdentifier *string

	// The type of the resource, which can be WirelessDevice or WirelessGateway .
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

type ResetResourceLogLevelOutput added in v1.6.0 

type ResetResourceLogLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 SendDataToMulticastGroupInput added in v1.12.0 

type SendDataToMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// The binary to be sent to the end device, encoded in base64.
	//
	// This member is required.
	PayloadData *string

	// Wireless metadata that is to be sent to multicast group.
	//
	// This member is required.
	WirelessMetadata *types.MulticastWirelessMetadata
	// contains filtered or unexported fields
}

type SendDataToMulticastGroupOutput added in v1.12.0 

type SendDataToMulticastGroupOutput struct {

	// ID of a multicast group message.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SendDataToWirelessDeviceInput 

type SendDataToWirelessDeviceInput struct {

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

	// The binary to be sent to the end device, encoded in base64.
	//
	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type StartBulkAssociateWirelessDeviceWithMulticastGroupInput added in v1.12.0 

type StartBulkAssociateWirelessDeviceWithMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// Query string used to search for wireless devices as part of the bulk associate
	// and disassociate process.
	QueryString *string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartBulkAssociateWirelessDeviceWithMulticastGroupOutput added in v1.12.0 

type StartBulkAssociateWirelessDeviceWithMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartBulkDisassociateWirelessDeviceFromMulticastGroupInput added in v1.12.0 

type StartBulkDisassociateWirelessDeviceFromMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// Query string used to search for wireless devices as part of the bulk associate
	// and disassociate process.
	QueryString *string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartBulkDisassociateWirelessDeviceFromMulticastGroupOutput added in v1.12.0 

type StartBulkDisassociateWirelessDeviceFromMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartFuotaTaskInput added in v1.12.0 

type StartFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

	// The LoRaWAN information used to start a FUOTA task.
	LoRaWAN *types.LoRaWANStartFuotaTask
	// contains filtered or unexported fields
}

type StartFuotaTaskOutput added in v1.12.0 

type StartFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartMulticastGroupSessionInput added in v1.12.0 

type StartMulticastGroupSessionInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

	// The LoRaWAN information used with the multicast session.
	//
	// This member is required.
	LoRaWAN *types.LoRaWANMulticastSession
	// contains filtered or unexported fields
}

type StartMulticastGroupSessionOutput added in v1.12.0 

type StartMulticastGroupSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSingleWirelessDeviceImportTaskInput added in v1.26.0 

type StartSingleWirelessDeviceImportTaskInput struct {

	// The name of the Sidewalk destination that describes the IoT rule to route
	// messages from the device in the import task that will be onboarded to AWS IoT
	// Wireless.
	//
	// This member is required.
	DestinationName *string

	// The Sidewalk-related parameters for importing a single wireless device.
	//
	// This member is required.
	Sidewalk *types.SidewalkSingleStartImportInfo

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

	// The name of the wireless device for which an import task is being started.
	DeviceName *string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartSingleWirelessDeviceImportTaskOutput added in v1.26.0 

type StartSingleWirelessDeviceImportTaskOutput struct {

	// The ARN (Amazon Resource Name) of the import task.
	Arn *string

	// The import task ID.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartWirelessDeviceImportTaskInput added in v1.26.0 

type StartWirelessDeviceImportTaskInput struct {

	// The name of the Sidewalk destination that describes the IoT rule to route
	// messages from the devices in the import task that are onboarded to AWS IoT
	// Wireless.
	//
	// This member is required.
	DestinationName *string

	// The Sidewalk-related parameters for importing wireless devices that need to be
	// provisioned in bulk.
	//
	// This member is required.
	Sidewalk *types.SidewalkStartImportInfo

	// Each resource must have a unique client request token. The client token is used
	// to implement idempotency. It ensures that the request completes no more than one
	// time. If you retry a request with the same token and the same parameters, the
	// request will complete successfully. However, if you try to create a new resource
	// using the same token but different parameters, an HTTP 409 conflict occurs. If
	// you omit this value, AWS SDKs will automatically generate a unique client
	// request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].
	//
	// [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
	ClientRequestToken *string

	// The tag to attach to the specified resource. Tags are metadata that you can use
	// to manage a resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartWirelessDeviceImportTaskOutput added in v1.26.0 

type StartWirelessDeviceImportTaskOutput struct {

	// The ARN (Amazon Resource Name) of the import task.
	Arn *string

	// The import task ID.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 you
	// can use to manage a resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestWirelessDeviceInput 

type TestWirelessDeviceInput struct {

	// The ID of the wireless device to test.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type TestWirelessDeviceOutput 

type TestWirelessDeviceOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateDestinationOutput 

type UpdateDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEventConfigurationByResourceTypesInput added in v1.19.0 

type UpdateEventConfigurationByResourceTypesInput struct {

	// Connection status resource type event configuration object for enabling and
	// disabling wireless gateway topic.
	ConnectionStatus *types.ConnectionStatusResourceTypeEventConfiguration

	// Device registration state resource type event configuration object for enabling
	// and disabling wireless gateway topic.
	DeviceRegistrationState *types.DeviceRegistrationStateResourceTypeEventConfiguration

	// Join resource type event configuration object for enabling and disabling
	// wireless device topic.
	Join *types.JoinResourceTypeEventConfiguration

	// Message delivery status resource type event configuration object for enabling
	// and disabling wireless device topic.
	MessageDeliveryStatus *types.MessageDeliveryStatusResourceTypeEventConfiguration

	// Proximity resource type event configuration object for enabling and disabling
	// wireless gateway topic.
	Proximity *types.ProximityResourceTypeEventConfiguration
	// contains filtered or unexported fields
}

type UpdateEventConfigurationByResourceTypesOutput added in v1.19.0 

type UpdateEventConfigurationByResourceTypesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFuotaTaskInput added in v1.12.0 

type UpdateFuotaTaskInput struct {

	// The ID of a FUOTA task.
	//
	// This member is required.
	Id *string

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

	// The S3 URI points to a firmware update image that is to be used with a FUOTA
	// task.
	FirmwareUpdateImage *string

	// The firmware update role that is to be used with a FUOTA task.
	FirmwareUpdateRole *string

	// The interval for sending fragments in milliseconds, rounded to the nearest
	// second.
	//
	// This interval only determines the timing for when the Cloud sends down the
	// fragments to yor device. There can be a delay for when your device will receive
	// these fragments. This delay depends on the device's class and the communication
	// delay with the cloud.
	FragmentIntervalMS *int32

	// The size of each fragment in bytes. This parameter is supported only for FUOTA
	// tasks with multicast groups.
	FragmentSizeBytes *int32

	// The LoRaWAN information used with a FUOTA task.
	LoRaWAN *types.LoRaWANFuotaTask

	// The name of a FUOTA task.
	Name *string

	// The percentage of the added fragments that are redundant. For example, if the
	// size of the firmware image file is 100 bytes and the fragment size is 10 bytes,
	// with RedundancyPercent set to 50(%), the final number of encoded fragments is
	// (100 / 10) + (100 / 10 * 50%) = 15.
	RedundancyPercent *int32
	// contains filtered or unexported fields
}

type UpdateFuotaTaskOutput added in v1.12.0 

type UpdateFuotaTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLogLevelsByResourceTypesInput added in v1.6.0 

type UpdateLogLevelsByResourceTypesInput struct {

	// The log level for a log message. The log levels can be disabled, or set to ERROR
	// to display less verbose logs containing only error information, or to INFO for
	// more detailed logs.
	DefaultLogLevel types.LogLevel

	// The list of wireless device log options.
	WirelessDeviceLogOptions []types.WirelessDeviceLogOption

	// The list of wireless gateway log options.
	WirelessGatewayLogOptions []types.WirelessGatewayLogOption
	// contains filtered or unexported fields
}

type UpdateLogLevelsByResourceTypesOutput added in v1.6.0 

type UpdateLogLevelsByResourceTypesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMetricConfigurationInput added in v1.37.0 

type UpdateMetricConfigurationInput struct {

	// The value to be used to set summary metric configuration.
	SummaryMetric *types.SummaryMetricConfiguration
	// contains filtered or unexported fields
}

type UpdateMetricConfigurationOutput added in v1.37.0 

type UpdateMetricConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMulticastGroupInput added in v1.12.0 

type UpdateMulticastGroupInput struct {

	// The ID of the multicast group.
	//
	// This member is required.
	Id *string

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

	// The LoRaWAN information that is to be used with the multicast group.
	LoRaWAN *types.LoRaWANMulticast

	// The name of the multicast group.
	Name *string
	// contains filtered or unexported fields
}

type UpdateMulticastGroupOutput added in v1.12.0 

type UpdateMulticastGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNetworkAnalyzerConfigurationInput added in v1.13.0 

type UpdateNetworkAnalyzerConfigurationInput struct {

	// Name of the network analyzer configuration.
	//
	// This member is required.
	ConfigurationName *string

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

	// Multicast group resources to add to the network analyzer configuration. Provide
	// the MulticastGroupId of the resource to add in the input array.
	MulticastGroupsToAdd []string

	// Multicast group resources to remove from the network analyzer configuration.
	// Provide the MulticastGroupId of the resources to remove in the input array.
	MulticastGroupsToRemove []string

	// Trace content for your wireless devices, gateways, and multicast groups.
	TraceContent *types.TraceContent

	// Wireless device resources to add to the network analyzer configuration. Provide
	// the WirelessDeviceId of the resource to add in the input array.
	WirelessDevicesToAdd []string

	// Wireless device resources to remove from the network analyzer configuration.
	// Provide the WirelessDeviceId of the resources to remove in the input array.
	WirelessDevicesToRemove []string

	// Wireless gateway resources to add to the network analyzer configuration.
	// Provide the WirelessGatewayId of the resource to add in the input array.
	WirelessGatewaysToAdd []string

	// Wireless gateway resources to remove from the network analyzer configuration.
	// Provide the WirelessGatewayId of the resources to remove in the input array.
	WirelessGatewaysToRemove []string
	// contains filtered or unexported fields
}

type UpdateNetworkAnalyzerConfigurationOutput added in v1.13.0 

type UpdateNetworkAnalyzerConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdatePartnerAccountOutput 

type UpdatePartnerAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePositionInput added in v1.20.0 

type UpdatePositionInput struct {

	// The position information of the resource.
	//
	// This member is required.
	Position []float32

	// Resource identifier of the resource for which position is updated.
	//
	// This member is required.
	ResourceIdentifier *string

	// Resource type of the resource for which position is updated.
	//
	// This member is required.
	ResourceType types.PositionResourceType
	// contains filtered or unexported fields
}

type UpdatePositionOutput added in v1.20.0 

type UpdatePositionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourceEventConfigurationInput added in v1.12.0 

type UpdateResourceEventConfigurationInput struct {

	// Resource identifier to opt in for event messaging.
	//
	// This member is required.
	Identifier *string

	// Identifier type of the particular resource identifier for event configuration.
	//
	// This member is required.
	IdentifierType types.IdentifierType

	// Event configuration for the connection status event.
	ConnectionStatus *types.ConnectionStatusEventConfiguration

	// Event configuration for the device registration state event.
	DeviceRegistrationState *types.DeviceRegistrationStateEventConfiguration

	// Event configuration for the join event.
	Join *types.JoinEventConfiguration

	// Event configuration for the message delivery status event.
	MessageDeliveryStatus *types.MessageDeliveryStatusEventConfiguration

	// Partner type of the resource if the identifier type is PartnerAccountId
	PartnerType types.EventNotificationPartnerType

	// Event configuration for the proximity event.
	Proximity *types.ProximityEventConfiguration
	// contains filtered or unexported fields
}

type UpdateResourceEventConfigurationOutput added in v1.12.0 

type UpdateResourceEventConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourcePositionInput added in v1.23.0 

type UpdateResourcePositionInput struct {

	// The identifier of the resource for which position information is updated. It
	// can be the wireless device ID or the wireless gateway ID, depending on the
	// resource type.
	//
	// This member is required.
	ResourceIdentifier *string

	// The type of resource for which position information is updated, which can be a
	// wireless device or a wireless gateway.
	//
	// This member is required.
	ResourceType types.PositionResourceType

	// The position information of the resource, displayed as a JSON payload. The
	// payload uses the GeoJSON format, which a format that's used to encode geographic
	// data structures. For more information, see [GeoJSON].
	//
	// [GeoJSON]: https://geojson.org/
	GeoJsonPayload []byte
	// contains filtered or unexported fields
}

type UpdateResourcePositionOutput added in v1.23.0 

type UpdateResourcePositionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWirelessDeviceImportTaskInput added in v1.26.0 

type UpdateWirelessDeviceImportTaskInput struct {

	// The identifier of the import task to be updated.
	//
	// This member is required.
	Id *string

	// The Sidewalk-related parameters of the import task to be updated.
	//
	// This member is required.
	Sidewalk *types.SidewalkUpdateImportInfo
	// contains filtered or unexported fields
}

type UpdateWirelessDeviceImportTaskOutput added in v1.26.0 

type UpdateWirelessDeviceImportTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// FPort values for the GNSS, stream, and ClockSync functions of the positioning
	// information.
	Positioning types.PositioningConfigStatus
	// contains filtered or unexported fields
}

type UpdateWirelessDeviceOutput 

type UpdateWirelessDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
	JoinEuiFilters [][]string

	// The MaxEIRP value.
	MaxEirp *float32

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

	// A list of NetId values that are used by LoRa gateways to filter the uplink
	// frames.
	NetIdFilters []string
	// contains filtered or unexported fields
}

type UpdateWirelessGatewayOutput 

type UpdateWirelessGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.