iotmanagedintegrations

package module
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Apr 3, 2025 License: Apache-2.0 Imports: 48 Imported by: 2

Documentation

Overview

Package iotmanagedintegrations provides the API client, operations, and parameter types for Managed integrations for AWS IoT Device Management.

Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions. Customers can use managed integrations to automate device setup workflows and support interoperability across many devices, regardless of device vendor or connectivity protocol. This allows developers to use a single user-interface to control, manage, and operate a range of devices.

Index

Constants

View Source
const ServiceAPIVersion = "2025-03-03"
View Source
const ServiceID = "IoT Managed Integrations"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName

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

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 AuthResolverParameters

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

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

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

type Client

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

Client provides the API client to make operations call for Managed integrations for AWS IoT Device Management.

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) CreateCredentialLocker

func (c *Client) CreateCredentialLocker(ctx context.Context, params *CreateCredentialLockerInput, optFns ...func(*Options)) (*CreateCredentialLockerOutput, error)

Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.

func (*Client) CreateDestination

func (c *Client) CreateDestination(ctx context.Context, params *CreateDestinationInput, optFns ...func(*Options)) (*CreateDestinationOutput, error)
Create a destination. IoT managed integrations uses the destination to

determine where to deliver notifications for a device.

func (*Client) CreateEventLogConfiguration

func (c *Client) CreateEventLogConfiguration(ctx context.Context, params *CreateEventLogConfigurationInput, optFns ...func(*Options)) (*CreateEventLogConfigurationOutput, error)

Set the event log configuration for the account, resource type, or specific resource.

func (*Client) CreateManagedThing

func (c *Client) CreateManagedThing(ctx context.Context, params *CreateManagedThingInput, optFns ...func(*Options)) (*CreateManagedThingOutput, error)

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.

func (*Client) CreateNotificationConfiguration

func (c *Client) CreateNotificationConfiguration(ctx context.Context, params *CreateNotificationConfigurationInput, optFns ...func(*Options)) (*CreateNotificationConfigurationOutput, error)

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

func (*Client) CreateOtaTask

func (c *Client) CreateOtaTask(ctx context.Context, params *CreateOtaTaskInput, optFns ...func(*Options)) (*CreateOtaTaskOutput, error)

Create an over-the-air (OTA) task to update a device.

func (*Client) CreateOtaTaskConfiguration

func (c *Client) CreateOtaTaskConfiguration(ctx context.Context, params *CreateOtaTaskConfigurationInput, optFns ...func(*Options)) (*CreateOtaTaskConfigurationOutput, error)

Create a configuraiton for the over-the-air (OTA) task.

func (*Client) CreateProvisioningProfile

func (c *Client) CreateProvisioningProfile(ctx context.Context, params *CreateProvisioningProfileInput, optFns ...func(*Options)) (*CreateProvisioningProfileOutput, error)

Create a provisioning profile for a device to execute the provisioning flows using a provisioning template. The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.

func (*Client) DeleteCredentialLocker

func (c *Client) DeleteCredentialLocker(ctx context.Context, params *DeleteCredentialLockerInput, optFns ...func(*Options)) (*DeleteCredentialLockerOutput, error)

Delete a credential locker.

This operation can't be undone and any existing device won't be able to use IoT managed integrations.

func (*Client) DeleteDestination

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

Deletes a customer-managed destination specified by id.

func (*Client) DeleteEventLogConfiguration

func (c *Client) DeleteEventLogConfiguration(ctx context.Context, params *DeleteEventLogConfigurationInput, optFns ...func(*Options)) (*DeleteEventLogConfigurationOutput, error)

Delete an event log configuration.

func (*Client) DeleteManagedThing

func (c *Client) DeleteManagedThing(ctx context.Context, params *DeleteManagedThingInput, optFns ...func(*Options)) (*DeleteManagedThingOutput, error)

Delete a managed thing. If a controller is deleted, all of the devices connected to it will have their status changed to PENDING . It is not possible to remove a cloud device.

func (*Client) DeleteNotificationConfiguration

func (c *Client) DeleteNotificationConfiguration(ctx context.Context, params *DeleteNotificationConfigurationInput, optFns ...func(*Options)) (*DeleteNotificationConfigurationOutput, error)

Deletes a notification configuration.

func (*Client) DeleteOtaTask

func (c *Client) DeleteOtaTask(ctx context.Context, params *DeleteOtaTaskInput, optFns ...func(*Options)) (*DeleteOtaTaskOutput, error)

Delete the over-the-air (OTA) task.

func (*Client) DeleteOtaTaskConfiguration

func (c *Client) DeleteOtaTaskConfiguration(ctx context.Context, params *DeleteOtaTaskConfigurationInput, optFns ...func(*Options)) (*DeleteOtaTaskConfigurationOutput, error)

Delete the over-the-air (OTA) task configuration.

func (*Client) DeleteProvisioningProfile

func (c *Client) DeleteProvisioningProfile(ctx context.Context, params *DeleteProvisioningProfileInput, optFns ...func(*Options)) (*DeleteProvisioningProfileOutput, error)

Delete a provisioning profile.

func (*Client) GetCredentialLocker

func (c *Client) GetCredentialLocker(ctx context.Context, params *GetCredentialLockerInput, optFns ...func(*Options)) (*GetCredentialLockerOutput, error)

Get information on an existing credential locker

func (*Client) GetCustomEndpoint

func (c *Client) GetCustomEndpoint(ctx context.Context, params *GetCustomEndpointInput, optFns ...func(*Options)) (*GetCustomEndpointOutput, error)

Returns the IoT managed integrations custom endpoint.

func (*Client) GetDefaultEncryptionConfiguration

func (c *Client) GetDefaultEncryptionConfiguration(ctx context.Context, params *GetDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*GetDefaultEncryptionConfigurationOutput, error)
Retrieves information about the default encryption configuration for the

Amazon Web Services account in the default or specified region. For more information, see Key managementin the AWS IoT SiteWise User Guide.

func (*Client) GetDestination

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

Gets a destination by ID.

func (*Client) GetDeviceDiscovery

func (c *Client) GetDeviceDiscovery(ctx context.Context, params *GetDeviceDiscoveryInput, optFns ...func(*Options)) (*GetDeviceDiscoveryOutput, error)

Get the current state of a device discovery.

func (*Client) GetEventLogConfiguration

func (c *Client) GetEventLogConfiguration(ctx context.Context, params *GetEventLogConfigurationInput, optFns ...func(*Options)) (*GetEventLogConfigurationOutput, error)

Get an event log configuration.

func (*Client) GetHubConfiguration

func (c *Client) GetHubConfiguration(ctx context.Context, params *GetHubConfigurationInput, optFns ...func(*Options)) (*GetHubConfigurationOutput, error)

Get a hub configuration.

func (*Client) GetManagedThing

func (c *Client) GetManagedThing(ctx context.Context, params *GetManagedThingInput, optFns ...func(*Options)) (*GetManagedThingOutput, error)

Get the attributes and capabilities associated with a managed thing.

func (*Client) GetManagedThingCapabilities

func (c *Client) GetManagedThingCapabilities(ctx context.Context, params *GetManagedThingCapabilitiesInput, optFns ...func(*Options)) (*GetManagedThingCapabilitiesOutput, error)

Get the capabilities for a managed thing using the device ID.

func (*Client) GetManagedThingConnectivityData

func (c *Client) GetManagedThingConnectivityData(ctx context.Context, params *GetManagedThingConnectivityDataInput, optFns ...func(*Options)) (*GetManagedThingConnectivityDataOutput, error)

Get the connectivity status of a managed thing.

func (*Client) GetManagedThingMetaData

func (c *Client) GetManagedThingMetaData(ctx context.Context, params *GetManagedThingMetaDataInput, optFns ...func(*Options)) (*GetManagedThingMetaDataOutput, error)

Get the metadata information for a managed thing.

func (*Client) GetManagedThingState

func (c *Client) GetManagedThingState(ctx context.Context, params *GetManagedThingStateInput, optFns ...func(*Options)) (*GetManagedThingStateOutput, error)

Returns the managed thing state for the given device Id.

func (*Client) GetNotificationConfiguration

func (c *Client) GetNotificationConfiguration(ctx context.Context, params *GetNotificationConfigurationInput, optFns ...func(*Options)) (*GetNotificationConfigurationOutput, error)

Get a notification configuration.

func (*Client) GetOtaTask

func (c *Client) GetOtaTask(ctx context.Context, params *GetOtaTaskInput, optFns ...func(*Options)) (*GetOtaTaskOutput, error)

Get the over-the-air (OTA) task.

func (*Client) GetOtaTaskConfiguration

func (c *Client) GetOtaTaskConfiguration(ctx context.Context, params *GetOtaTaskConfigurationInput, optFns ...func(*Options)) (*GetOtaTaskConfigurationOutput, error)

Get a configuraiton for the over-the-air (OTA) task.

func (*Client) GetProvisioningProfile

func (c *Client) GetProvisioningProfile(ctx context.Context, params *GetProvisioningProfileInput, optFns ...func(*Options)) (*GetProvisioningProfileOutput, error)

Get a provisioning profile by template name.

func (*Client) GetRuntimeLogConfiguration

func (c *Client) GetRuntimeLogConfiguration(ctx context.Context, params *GetRuntimeLogConfigurationInput, optFns ...func(*Options)) (*GetRuntimeLogConfigurationOutput, error)

Get the runtime log configuration for a specific managed thing or for all managed things as a group.

func (*Client) GetSchemaVersion

func (c *Client) GetSchemaVersion(ctx context.Context, params *GetSchemaVersionInput, optFns ...func(*Options)) (*GetSchemaVersionOutput, error)

Gets a schema version with the provided information.

func (*Client) ListCredentialLockers

func (c *Client) ListCredentialLockers(ctx context.Context, params *ListCredentialLockersInput, optFns ...func(*Options)) (*ListCredentialLockersOutput, error)

List information on an existing credential locker.

func (*Client) ListDestinations

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

List all destination names under one Amazon Web Services account.

func (*Client) ListEventLogConfigurations

func (c *Client) ListEventLogConfigurations(ctx context.Context, params *ListEventLogConfigurationsInput, optFns ...func(*Options)) (*ListEventLogConfigurationsOutput, error)

List all event log configurations for an account.

func (*Client) ListManagedThingSchemas

func (c *Client) ListManagedThingSchemas(ctx context.Context, params *ListManagedThingSchemasInput, optFns ...func(*Options)) (*ListManagedThingSchemasOutput, error)

List schemas associated with a managed thing.

func (*Client) ListManagedThings

func (c *Client) ListManagedThings(ctx context.Context, params *ListManagedThingsInput, optFns ...func(*Options)) (*ListManagedThingsOutput, error)

List all of the associations and statuses for a managed thing by its owner.

func (*Client) ListNotificationConfigurations

func (c *Client) ListNotificationConfigurations(ctx context.Context, params *ListNotificationConfigurationsInput, optFns ...func(*Options)) (*ListNotificationConfigurationsOutput, error)

List all notification configurations.

func (*Client) ListOtaTaskConfigurations

func (c *Client) ListOtaTaskConfigurations(ctx context.Context, params *ListOtaTaskConfigurationsInput, optFns ...func(*Options)) (*ListOtaTaskConfigurationsOutput, error)

List all of the over-the-air (OTA) task configurations.

func (*Client) ListOtaTaskExecutions

func (c *Client) ListOtaTaskExecutions(ctx context.Context, params *ListOtaTaskExecutionsInput, optFns ...func(*Options)) (*ListOtaTaskExecutionsOutput, error)

List all of the over-the-air (OTA) task executions.

func (*Client) ListOtaTasks

func (c *Client) ListOtaTasks(ctx context.Context, params *ListOtaTasksInput, optFns ...func(*Options)) (*ListOtaTasksOutput, error)

List all of the over-the-air (OTA) tasks.

func (*Client) ListProvisioningProfiles

func (c *Client) ListProvisioningProfiles(ctx context.Context, params *ListProvisioningProfilesInput, optFns ...func(*Options)) (*ListProvisioningProfilesOutput, error)

List the provisioning profiles within the Amazon Web Services account.

func (*Client) ListSchemaVersions

func (c *Client) ListSchemaVersions(ctx context.Context, params *ListSchemaVersionsInput, optFns ...func(*Options)) (*ListSchemaVersionsOutput, error)

Lists schema versions with the provided information.

func (*Client) Options

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) PutDefaultEncryptionConfiguration

func (c *Client) PutDefaultEncryptionConfiguration(ctx context.Context, params *PutDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*PutDefaultEncryptionConfigurationOutput, error)

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key managementin the AWS IoT SiteWise User Guide.

func (*Client) PutHubConfiguration

func (c *Client) PutHubConfiguration(ctx context.Context, params *PutHubConfigurationInput, optFns ...func(*Options)) (*PutHubConfigurationOutput, error)

Update a hub configuration.

func (*Client) PutRuntimeLogConfiguration

func (c *Client) PutRuntimeLogConfiguration(ctx context.Context, params *PutRuntimeLogConfigurationInput, optFns ...func(*Options)) (*PutRuntimeLogConfigurationOutput, error)

Set the runtime log configuration for a specific managed thing or for all managed things as a group.

func (*Client) RegisterCustomEndpoint

func (c *Client) RegisterCustomEndpoint(ctx context.Context, params *RegisterCustomEndpointInput, optFns ...func(*Options)) (*RegisterCustomEndpointOutput, error)

Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

func (*Client) ResetRuntimeLogConfiguration

func (c *Client) ResetRuntimeLogConfiguration(ctx context.Context, params *ResetRuntimeLogConfigurationInput, optFns ...func(*Options)) (*ResetRuntimeLogConfigurationOutput, error)

Reset a runtime log configuration for a specific managed thing or for all managed things as a group.

func (*Client) SendManagedThingCommand

func (c *Client) SendManagedThingCommand(ctx context.Context, params *SendManagedThingCommandInput, optFns ...func(*Options)) (*SendManagedThingCommandOutput, error)

Send the command to the device represented by the managed thing.

func (*Client) StartDeviceDiscovery

func (c *Client) StartDeviceDiscovery(ctx context.Context, params *StartDeviceDiscoveryInput, optFns ...func(*Options)) (*StartDeviceDiscoveryOutput, error)
During user-guided setup, this is used to start device discovery. The

authentication material (install code) is passed as a message to the controller telling it to start the discovery.

func (*Client) UpdateDestination

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

Update a destination specified by id.

func (*Client) UpdateEventLogConfiguration

func (c *Client) UpdateEventLogConfiguration(ctx context.Context, params *UpdateEventLogConfigurationInput, optFns ...func(*Options)) (*UpdateEventLogConfigurationOutput, error)

Update an event log configuration by log configuration ID.

func (*Client) UpdateManagedThing

func (c *Client) UpdateManagedThing(ctx context.Context, params *UpdateManagedThingInput, optFns ...func(*Options)) (*UpdateManagedThingOutput, error)

Update the attributes and capabilities associated with a managed thing.

func (*Client) UpdateNotificationConfiguration

func (c *Client) UpdateNotificationConfiguration(ctx context.Context, params *UpdateNotificationConfigurationInput, optFns ...func(*Options)) (*UpdateNotificationConfigurationOutput, error)

Update a notification configuration.

func (*Client) UpdateOtaTask

func (c *Client) UpdateOtaTask(ctx context.Context, params *UpdateOtaTaskInput, optFns ...func(*Options)) (*UpdateOtaTaskOutput, error)

Update an over-the-air (OTA) task.

type CreateCredentialLockerInput

type CreateCredentialLockerInput struct {

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The name of the credential locker.
	Name *string

	// A set of key/value pairs that are used to manage the credential locker.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCredentialLockerOutput

type CreateCredentialLockerOutput struct {

	// The Amazon Resource Name (ARN) of the credential locker.
	Arn *string

	// The timestamp value of when the credential locker request occurred.
	CreatedAt *time.Time

	// The identifier of the credential locker creation request.
	Id *string

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

type CreateDestinationInput

type CreateDestinationInput struct {

	// The Amazon Resource Name (ARN) of the customer-managed destination.
	//
	// This member is required.
	DeliveryDestinationArn *string

	// The destination type for the customer-managed destination.
	//
	// This member is required.
	DeliveryDestinationType types.DeliveryDestinationType

	// The name of the customer-managed destination.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the delivery destination role.
	//
	// This member is required.
	RoleArn *string

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The description of the customer-managed destination.
	Description *string

	// A set of key/value pairs that are used to manage the destination.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDestinationOutput

type CreateDestinationOutput struct {

	// The name of the customer-managed destination.
	Name *string

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

type CreateEventLogConfigurationInput

type CreateEventLogConfigurationInput struct {

	// The logging level for the event log configuration.
	//
	// This member is required.
	EventLogLevel types.LogLevel

	// The type of resource for the event log configuration.
	//
	// This member is required.
	ResourceType *string

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The identifier of the resource for the event log configuration.
	ResourceId *string
	// contains filtered or unexported fields
}

type CreateEventLogConfigurationOutput

type CreateEventLogConfigurationOutput struct {

	// The identifier of the event log configuration request.
	Id *string

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

type CreateManagedThingInput

type CreateManagedThingInput struct {

	// The authentication material defining the device connectivity setup requests.
	// The authentication materials used are the device bar code.
	//
	// This member is required.
	AuthenticationMaterial *string

	// The type of authentication material used for device connectivity setup requests.
	//
	// This member is required.
	AuthenticationMaterialType types.AuthMaterialType

	// The type of device used. This will be the hub controller, cloud device, or AWS
	// IoT device.
	//
	// This member is required.
	Role types.Role

	// The brand of the device.
	Brand *string

	// The capabilities of the device such as light bulb.
	Capabilities *string

	// A report of the capabilities for the managed thing.
	CapabilityReport *types.CapabilityReport

	// The classification of the managed thing such as light bulb or thermostat.
	Classification *string

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The identifier of the credential for the managed thing.
	CredentialLockerId *string

	// The metadata for the managed thing.
	MetaData map[string]string

	// The model of the device.
	Model *string

	// The name of the managed thing representing the physical device.
	Name *string

	// Owner of the device, usually an indication of whom the device belongs to. This
	// value should not contain personal identifiable information.
	Owner *string

	// The serial number of the device.
	SerialNumber *string

	// A set of key/value pairs that are used to manage the managed thing.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateManagedThingOutput

type CreateManagedThingOutput struct {

	// The Amazon Resource Name (ARN) of the managed thing.
	Arn *string

	// The timestamp value of when the device creation request occurred.
	CreatedAt *time.Time

	// The id of the managed thing.
	Id *string

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

type CreateNotificationConfigurationInput

type CreateNotificationConfigurationInput struct {

	// The name of the destination for the notification configuration.
	//
	// This member is required.
	DestinationName *string

	// The type of event triggering a device notification to the customer-managed
	// destination.
	//
	// This member is required.
	EventType types.EventType

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// A set of key/value pairs that are used to manage the notification configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateNotificationConfigurationOutput

type CreateNotificationConfigurationOutput struct {

	// The type of event triggering a device notification to the customer-managed
	// destination.
	EventType types.EventType

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

type CreateOtaTaskConfigurationInput

type CreateOtaTaskConfigurationInput struct {

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// A description of the over-the-air (OTA) task configuration.
	Description *string

	// The name of the over-the-air (OTA) task.
	Name *string

	// Describes the type of configuration used for the over-the-air (OTA) task.
	PushConfig *types.PushConfig
	// contains filtered or unexported fields
}

type CreateOtaTaskConfigurationOutput

type CreateOtaTaskConfigurationOutput struct {

	// The identifier of the over-the-air (OTA) task configuration.
	TaskConfigurationId *string

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

type CreateOtaTaskInput

type CreateOtaTaskInput struct {

	// The frequency type for the over-the-air (OTA) task.
	//
	// This member is required.
	OtaType types.OtaType

	// The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
	//
	// This member is required.
	S3Url *string

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The description of the over-the-air (OTA) task.
	Description *string

	// The deployment mechanism for the over-the-air (OTA) task.
	OtaMechanism types.OtaMechanism

	// Over-the-air (OTA) task scheduling config.
	OtaSchedulingConfig *types.OtaTaskSchedulingConfig

	// The query string to add things to the thing group.
	OtaTargetQueryString *string

	// Over-the-air (OTA) task retry config.
	OtaTaskExecutionRetryConfig *types.OtaTaskExecutionRetryConfig

	// The connection protocol the over-the-air (OTA) task uses to update the device.
	Protocol types.OtaProtocol

	// A set of key/value pairs that are used to manage the over-the-air (OTA) task.
	Tags map[string]string

	// The device targeted for the over-the-air (OTA) task.
	Target []string

	// The identifier for the over-the-air (OTA) task configuration.
	TaskConfigurationId *string
	// contains filtered or unexported fields
}

type CreateOtaTaskOutput

type CreateOtaTaskOutput struct {

	// A description of the over-the-air (OTA) task.
	Description *string

	// The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
	TaskArn *string

	// The identifier of the over-the-air (OTA) task.
	TaskId *string

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

type CreateProvisioningProfileInput

type CreateProvisioningProfileInput struct {

	// The type of provisioning workflow the device uses for onboarding to IoT managed
	// integrations.
	//
	// This member is required.
	ProvisioningType types.ProvisioningType

	// The id of the certificate authority (CA) certificate.
	CaCertificate *string

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The name of the provisioning template.
	Name *string

	// A set of key/value pairs that are used to manage the provisioning profile.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateProvisioningProfileOutput

type CreateProvisioningProfileOutput struct {

	// The Amazon Resource Name (ARN) of the provisioning template used in the
	// provisioning profile.
	Arn *string

	// The id of the claim certificate.
	ClaimCertificate *string

	// The private key of the claim certificate. This is stored securely on the device
	// for validating the connection endpoint with IoT managed integrations using the
	// public key.
	ClaimCertificatePrivateKey *string

	// The identifier of the provisioning profile.
	Id *string

	// The name of the provisioning template.
	Name *string

	// The type of provisioning workflow the device uses for onboarding to IoT managed
	// integrations.
	ProvisioningType types.ProvisioningType

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

type DeleteCredentialLockerInput

type DeleteCredentialLockerInput struct {

	// The identifier of the credential locker.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteCredentialLockerOutput

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

type DeleteDestinationInput

type DeleteDestinationInput struct {

	// The id of the customer-managed destination.
	//
	// 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 DeleteEventLogConfigurationInput

type DeleteEventLogConfigurationInput struct {

	// The identifier of the event log configuration.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteEventLogConfigurationOutput

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

type DeleteManagedThingInput

type DeleteManagedThingInput struct {

	// The id of the managed thing.
	//
	// This member is required.
	Identifier *string

	// When set to TRUE , a forceful deteletion of the managed thing will occur. When
	// set to FALSE , a non-forceful deletion of the managed thing will occur.
	Force *bool
	// contains filtered or unexported fields
}

type DeleteManagedThingOutput

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

type DeleteNotificationConfigurationInput

type DeleteNotificationConfigurationInput struct {

	// The type of event triggering a device notification to the customer-managed
	// destination.
	//
	// This member is required.
	EventType types.EventType
	// contains filtered or unexported fields
}

type DeleteNotificationConfigurationOutput

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

type DeleteOtaTaskConfigurationInput

type DeleteOtaTaskConfigurationInput struct {

	// The identifier of the over-the-air (OTA) task configuration.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteOtaTaskConfigurationOutput

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

type DeleteOtaTaskInput

type DeleteOtaTaskInput struct {

	// The identifier of the over-the-air (OTA) task.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteOtaTaskOutput

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

type DeleteProvisioningProfileInput

type DeleteProvisioningProfileInput struct {

	// The name of the provisioning template.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteProvisioningProfileOutput

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

type EndpointParameters

type EndpointParameters struct {
	// 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

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

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

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

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

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCredentialLockerInput

type GetCredentialLockerInput struct {

	// The identifier of the credential locker.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetCredentialLockerOutput

type GetCredentialLockerOutput struct {

	// The Amazon Resource Name (ARN) of the credential locker.
	Arn *string

	// The timestamp value of when the credential locker requset occurred.
	CreatedAt *time.Time

	// The identifier of the credential locker.
	Id *string

	// The name of the credential locker.
	Name *string

	// A set of key/value pairs that are used to manage the credential locker.
	Tags map[string]string

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

type GetCustomEndpointInput

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

type GetCustomEndpointOutput

type GetCustomEndpointOutput struct {

	// The IoT managed integrations dedicated, custom endpoint for the device to route
	// traffic through.
	//
	// This member is required.
	EndpointAddress *string

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

type GetDefaultEncryptionConfigurationInput

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

type GetDefaultEncryptionConfigurationOutput

type GetDefaultEncryptionConfigurationOutput struct {

	// Provides the status of the default encryption configuration for an Amazon Web
	// Services account.
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption
	// if you use KMS_BASED_ENCRYPTION .
	KmsKeyArn *string

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

type GetDestinationInput

type GetDestinationInput struct {

	// The name of the customer-managed destination.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetDestinationOutput

type GetDestinationOutput struct {

	// The timestamp value of when the destination creation requset occurred.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the customer-managed destination.
	DeliveryDestinationArn *string

	// The destination type for the customer-managed destination.
	DeliveryDestinationType types.DeliveryDestinationType

	// The description of the customer-managed destination.
	Description *string

	// The name of the customer-managed destination.
	Name *string

	// The Amazon Resource Name (ARN) of the delivery destination role.
	RoleArn *string

	// A set of key/value pairs that are used to manage the customer-managed
	// destination.
	Tags map[string]string

	// The timestamp value of when the destination update requset occurred.
	UpdatedAt *time.Time

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

type GetDeviceDiscoveryInput

type GetDeviceDiscoveryInput struct {

	// The id of the device discovery job request.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetDeviceDiscoveryOutput

type GetDeviceDiscoveryOutput struct {

	// The Amazon Resource Name (ARN) of the device discovery job request.
	//
	// This member is required.
	Arn *string

	// The discovery type supporting the type of device to be discovered in the device
	// discovery job request.
	//
	// This member is required.
	DiscoveryType types.DiscoveryType

	// The id of the device discovery job request.
	//
	// This member is required.
	Id *string

	// The timestamp value for the start time of the device discovery.
	//
	// This member is required.
	StartedAt *time.Time

	// The status of the device discovery job request.
	//
	// This member is required.
	Status types.DeviceDiscoveryStatus

	// The ID tracking the current discovery process for one connector association.
	ConnectorAssociationId *string

	// The id of the end-user's IoT hub.
	ControllerId *string

	// The timestamp value for the completion time of the device discovery.
	FinishedAt *time.Time

	// A set of key/value pairs that are used to manage the device discovery request.
	Tags map[string]string

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

type GetEventLogConfigurationInput

type GetEventLogConfigurationInput struct {

	// The identifier of the event log configuration.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetEventLogConfigurationOutput

type GetEventLogConfigurationOutput struct {

	// The logging level for the event log configuration.
	EventLogLevel types.LogLevel

	// The identifier of the event log configuration.
	Id *string

	// The identifier of the resource for the event log configuration.
	ResourceId *string

	// The type of resource for the event log configuration.
	ResourceType *string

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

type GetHubConfigurationInput

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

type GetHubConfigurationOutput

type GetHubConfigurationOutput struct {

	// A user-defined integer value that represents the hub token timer expiry setting
	// in seconds.
	HubTokenTimerExpirySettingInSeconds *int64

	// The timestamp value of when the hub configuration was updated.
	UpdatedAt *time.Time

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

type GetManagedThingCapabilitiesInput

type GetManagedThingCapabilitiesInput struct {

	// The id of the device.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetManagedThingCapabilitiesOutput

type GetManagedThingCapabilitiesOutput struct {

	// The capabilities of the device such as light bulb.
	Capabilities *string

	// A report of the capabilities for the managed thing.
	CapabilityReport *types.CapabilityReport

	// The id of the device.
	ManagedThingId *string

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

type GetManagedThingConnectivityDataInput

type GetManagedThingConnectivityDataInput struct {

	// The identifier of a managed thing.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetManagedThingConnectivityDataOutput

type GetManagedThingConnectivityDataOutput struct {

	// The connectivity status for a managed thing.
	Connected *bool

	// The reason for the connectivity disconnect with the managed thing.
	DisconnectReason types.DisconnectReasonValue

	// The id of a managed thing.
	ManagedThingId *string

	// The timestamp value of when the connectivity status for a managed thing was
	// last taken.
	Timestamp *time.Time

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

type GetManagedThingInput

type GetManagedThingInput struct {

	// The id of the managed thing.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetManagedThingMetaDataInput

type GetManagedThingMetaDataInput struct {

	// The managed thing id.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetManagedThingMetaDataOutput

type GetManagedThingMetaDataOutput struct {

	// The managed thing id.
	ManagedThingId *string

	// The metadata for the managed thing.
	MetaData map[string]string

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

type GetManagedThingOutput

type GetManagedThingOutput struct {

	// The timestampe value of when the device was activated.
	ActivatedAt *time.Time

	// The id of the advertised product.
	AdvertisedProductId *string

	// The Amazon Resource Name (ARN) of the managed thing.
	Arn *string

	// The brand of the device.
	Brand *string

	// The classification of the managed thing such as light bulb or thermostat.
	Classification *string

	// The third-party device id as defined by the connector. This device id must not
	// contain personal identifiable information (PII).
	//
	// This parameter is used for cloud-to-cloud devices only.
	ConnectorDeviceId *string

	// The id of the connector policy.
	//
	// This parameter is used for cloud-to-cloud devices only.
	ConnectorPolicyId *string

	// The timestamp value of when the device creation request occurred.
	CreatedAt *time.Time

	// The identifier of the credential locker for the managed thing.
	CredentialLockerId *string

	// A Zwave device-specific key used during device activation.
	//
	// This parameter is used for Zwave devices only.
	DeviceSpecificKey *string

	// The network mode for the hub-connected device.
	HubNetworkMode types.HubNetworkMode

	// The id of the managed thing.
	Id *string

	// The unique 13 digit number that identifies the managed thing.
	InternationalArticleNumber *string

	// The media access control (MAC) address for the device represented by the
	// managed thing.
	//
	// This parameter is used for Zigbee devices only.
	MacAddress *string

	// The metadata for the managed thing.
	MetaData map[string]string

	// The model of the device.
	Model *string

	// The name of the managed thing representing the physical device.
	Name *string

	// Owner of the device, usually an indication of whom the device belongs to. This
	// value should not contain personal identifiable information.
	Owner *string

	// Id of the controller device used for the discovery job.
	ParentControllerId *string

	// The provisioning status of the device in the provisioning workflow for
	// onboarding to IoT managed integrations.
	ProvisioningStatus types.ProvisioningStatus

	// The type of device used. This will be the Amazon Web Services hub controller,
	// cloud device, or IoT device.
	Role types.Role

	// The serial number of the device.
	SerialNumber *string

	// A set of key/value pairs that are used to manage the managed thing.
	Tags map[string]string

	// The universal product code (UPC) of the device model. The UPC is typically used
	// in the United States of America and Canada.
	UniversalProductCode *string

	// The timestamp value of when the managed thing was last updated at.
	UpdatedAt *time.Time

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

type GetManagedThingStateInput

type GetManagedThingStateInput struct {

	// The id of the device.
	//
	// This member is required.
	ManagedThingId *string
	// contains filtered or unexported fields
}

type GetManagedThingStateOutput

type GetManagedThingStateOutput struct {

	// The device endpoint.
	//
	// This member is required.
	Endpoints []types.StateEndpoint

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

type GetNotificationConfigurationInput

type GetNotificationConfigurationInput struct {

	// The type of event triggering a device notification to the customer-managed
	// destination.
	//
	// This member is required.
	EventType types.EventType
	// contains filtered or unexported fields
}

type GetNotificationConfigurationOutput

type GetNotificationConfigurationOutput struct {

	// The timestamp value of when the notification configuration was created.
	CreatedAt *time.Time

	// The name of the destination for the notification configuration.
	DestinationName *string

	// The type of event triggering a device notification to the customer-managed
	// destination.
	EventType types.EventType

	// A set of key/value pairs that are used to manage the notification configuration.
	Tags map[string]string

	// The timestamp value of when the notification configuration was last updated.
	UpdatedAt *time.Time

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

type GetOtaTaskConfigurationInput

type GetOtaTaskConfigurationInput struct {

	// The over-the-air (OTA) task configuration id.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetOtaTaskConfigurationOutput

type GetOtaTaskConfigurationOutput struct {

	// The timestamp value of when the over-the-air (OTA) task configuration was
	// created at.
	CreatedAt *time.Time

	// A description of the over-the-air (OTA) task configuration.
	Description *string

	// The name of the over-the-air (OTA) task configuration.
	Name *string

	// Describes the type of configuration used for the over-the-air (OTA) task.
	PushConfig *types.PushConfig

	// The over-the-air (OTA) task configuration id.
	TaskConfigurationId *string

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

type GetOtaTaskInput

type GetOtaTaskInput struct {

	// The over-the-air (OTA) task id.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetOtaTaskOutput

type GetOtaTaskOutput struct {

	// The timestamp value of when the over-the-air (OTA) task was created.
	CreatedAt *time.Time

	// The description of the over-the-air (OTA) task.
	Description *string

	// The timestamp value of when the over-the-air (OTA) task was last updated at.
	LastUpdatedAt *time.Time

	// The deployment mechanism for the over-the-air (OTA) task.
	OtaMechanism types.OtaMechanism

	// Over-the-air (OTA) task scheduling config.
	OtaSchedulingConfig *types.OtaTaskSchedulingConfig

	// The query string to add things to the thing group.
	OtaTargetQueryString *string

	// Over-the-air (OTA) task retry config.
	OtaTaskExecutionRetryConfig *types.OtaTaskExecutionRetryConfig

	// The frequency type for the over-the-air (OTA) task.
	OtaType types.OtaType

	// The connection protocol the over-the-air (OTA) task uses to update the device.
	Protocol types.OtaProtocol

	// The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
	S3Url *string

	// The status of the over-the-air (OTA) task.
	Status types.OtaStatus

	// The device targeted for the over-the-air (OTA) task.
	Target []string

	// The Amazon Resource Name (ARN) of the over-the-air (OTA) task
	TaskArn *string

	// The identifier for the over-the-air (OTA) task configuration.
	TaskConfigurationId *string

	// The id of the over-the-air (OTA) task.
	TaskId *string

	// The processing details of all over-the-air (OTA) tasks.
	TaskProcessingDetails *types.TaskProcessingDetails

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

type GetProvisioningProfileInput

type GetProvisioningProfileInput struct {

	// The provisioning template the device uses for the provisioning process.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetProvisioningProfileOutput

type GetProvisioningProfileOutput struct {

	// The Amazon Resource Name (ARN) of the provisioning template used in the
	// provisioning profile.
	Arn *string

	// The id of the claim certificate.
	ClaimCertificate *string

	// The provisioning profile id..
	Id *string

	// The name of the provisioning template.
	Name *string

	// The type of provisioning workflow the device uses for onboarding to IoT managed
	// integrations.
	ProvisioningType types.ProvisioningType

	// A set of key/value pairs that are used to manage the provisioning profile.
	Tags map[string]string

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

type GetRuntimeLogConfigurationInput

type GetRuntimeLogConfigurationInput struct {

	// The id for a managed thing.
	//
	// This member is required.
	ManagedThingId *string
	// contains filtered or unexported fields
}

type GetRuntimeLogConfigurationOutput

type GetRuntimeLogConfigurationOutput struct {

	// The id for a managed thing.
	ManagedThingId *string

	// The runtime log configuration for a managed thing.
	RuntimeLogConfigurations *types.RuntimeLogConfigurations

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

type GetSchemaVersionInput

type GetSchemaVersionInput struct {

	// Schema id with a version specified. If the version is missing, it defaults to
	// latest version.
	//
	// This member is required.
	SchemaVersionedId *string

	// The type of schema version.
	//
	// This member is required.
	Type types.SchemaVersionType

	// The format of the schema version.
	Format types.SchemaVersionFormat
	// contains filtered or unexported fields
}

type GetSchemaVersionOutput

type GetSchemaVersionOutput struct {

	// The description of the schema version.
	Description *string

	// The name of the schema version.
	Namespace *string

	// The schema of the schema version.
	Schema document.Interface

	// The id of the schema version.
	SchemaId *string

	// The schema version. If this is left blank, it defaults to the latest version.
	SemanticVersion *string

	// The type of schema version.
	Type types.SchemaVersionType

	// The visibility of the schema version.
	Visibility types.SchemaVersionVisibility

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

type ListCredentialLockersAPIClient interface {
	ListCredentialLockers(context.Context, *ListCredentialLockersInput, ...func(*Options)) (*ListCredentialLockersOutput, error)
}

ListCredentialLockersAPIClient is a client that implements the ListCredentialLockers operation.

type ListCredentialLockersInput

type ListCredentialLockersInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCredentialLockersOutput

type ListCredentialLockersOutput struct {

	// The list of credential lockers.
	Items []types.CredentialLockerSummary

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListCredentialLockersPaginator

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

ListCredentialLockersPaginator is a paginator for ListCredentialLockers

func NewListCredentialLockersPaginator

NewListCredentialLockersPaginator returns a new ListCredentialLockersPaginator

func (*ListCredentialLockersPaginator) HasMorePages

func (p *ListCredentialLockersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCredentialLockersPaginator) NextPage

NextPage retrieves the next ListCredentialLockers page.

type ListCredentialLockersPaginatorOptions

type ListCredentialLockersPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListCredentialLockersPaginatorOptions is the paginator options for ListCredentialLockers

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 at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDestinationsOutput

type ListDestinationsOutput struct {

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

	// A token that can be used to retrieve the next set of 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 at one time.
	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 ListEventLogConfigurationsAPIClient

type ListEventLogConfigurationsAPIClient interface {
	ListEventLogConfigurations(context.Context, *ListEventLogConfigurationsInput, ...func(*Options)) (*ListEventLogConfigurationsOutput, error)
}

ListEventLogConfigurationsAPIClient is a client that implements the ListEventLogConfigurations operation.

type ListEventLogConfigurationsInput

type ListEventLogConfigurationsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEventLogConfigurationsOutput

type ListEventLogConfigurationsOutput struct {

	// A list of each event log configuration and pertinent information.
	EventLogConfigurationList []types.EventLogConfigurationSummary

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListEventLogConfigurationsPaginator

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

ListEventLogConfigurationsPaginator is a paginator for ListEventLogConfigurations

func NewListEventLogConfigurationsPaginator

NewListEventLogConfigurationsPaginator returns a new ListEventLogConfigurationsPaginator

func (*ListEventLogConfigurationsPaginator) HasMorePages

func (p *ListEventLogConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventLogConfigurationsPaginator) NextPage

NextPage retrieves the next ListEventLogConfigurations page.

type ListEventLogConfigurationsPaginatorOptions

type ListEventLogConfigurationsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListEventLogConfigurationsPaginatorOptions is the paginator options for ListEventLogConfigurations

type ListManagedThingSchemasAPIClient

type ListManagedThingSchemasAPIClient interface {
	ListManagedThingSchemas(context.Context, *ListManagedThingSchemasInput, ...func(*Options)) (*ListManagedThingSchemasOutput, error)
}

ListManagedThingSchemasAPIClient is a client that implements the ListManagedThingSchemas operation.

type ListManagedThingSchemasInput

type ListManagedThingSchemasInput struct {

	// The managed thing id.
	//
	// This member is required.
	Identifier *string

	// Filter on a capability id.
	CapabilityIdFilter *string

	// Filter on an endpoint id.
	EndpointIdFilter *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListManagedThingSchemasOutput

type ListManagedThingSchemasOutput struct {

	// The list of managed thing schemas.
	Items []types.ManagedThingSchemaListItem

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListManagedThingSchemasPaginator

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

ListManagedThingSchemasPaginator is a paginator for ListManagedThingSchemas

func NewListManagedThingSchemasPaginator

NewListManagedThingSchemasPaginator returns a new ListManagedThingSchemasPaginator

func (*ListManagedThingSchemasPaginator) HasMorePages

func (p *ListManagedThingSchemasPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedThingSchemasPaginator) NextPage

NextPage retrieves the next ListManagedThingSchemas page.

type ListManagedThingSchemasPaginatorOptions

type ListManagedThingSchemasPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListManagedThingSchemasPaginatorOptions is the paginator options for ListManagedThingSchemas

type ListManagedThingsAPIClient

type ListManagedThingsAPIClient interface {
	ListManagedThings(context.Context, *ListManagedThingsInput, ...func(*Options)) (*ListManagedThingsOutput, error)
}

ListManagedThingsAPIClient is a client that implements the ListManagedThings operation.

type ListManagedThingsInput

type ListManagedThingsInput struct {

	// Filter on a connector policy id for a managed thing.
	ConnectorPolicyIdFilter *string

	// Filter on a credential locker for a managed thing.
	CredentialLockerFilter *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string

	// Filter on device owners when listing managed things.
	OwnerFilter *string

	// Filter on a parent controller id for a managed thing.
	ParentControllerIdentifierFilter *string

	// Filter on the status of the device.
	ProvisioningStatusFilter types.ProvisioningStatus

	// Filter on the type of device used. This will be the Amazon Web Services hub
	// controller, cloud device, or IoT device.
	RoleFilter types.Role

	// Filter on the serial number of the device.
	SerialNumberFilter *string
	// contains filtered or unexported fields
}

type ListManagedThingsOutput

type ListManagedThingsOutput struct {

	// The list of managed things.
	Items []types.ManagedThingSummary

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListManagedThingsPaginator

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

ListManagedThingsPaginator is a paginator for ListManagedThings

func NewListManagedThingsPaginator

func NewListManagedThingsPaginator(client ListManagedThingsAPIClient, params *ListManagedThingsInput, optFns ...func(*ListManagedThingsPaginatorOptions)) *ListManagedThingsPaginator

NewListManagedThingsPaginator returns a new ListManagedThingsPaginator

func (*ListManagedThingsPaginator) HasMorePages

func (p *ListManagedThingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedThingsPaginator) NextPage

func (p *ListManagedThingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListManagedThingsOutput, error)

NextPage retrieves the next ListManagedThings page.

type ListManagedThingsPaginatorOptions

type ListManagedThingsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListManagedThingsPaginatorOptions is the paginator options for ListManagedThings

type ListNotificationConfigurationsAPIClient

type ListNotificationConfigurationsAPIClient interface {
	ListNotificationConfigurations(context.Context, *ListNotificationConfigurationsInput, ...func(*Options)) (*ListNotificationConfigurationsOutput, error)
}

ListNotificationConfigurationsAPIClient is a client that implements the ListNotificationConfigurations operation.

type ListNotificationConfigurationsInput

type ListNotificationConfigurationsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNotificationConfigurationsOutput

type ListNotificationConfigurationsOutput struct {

	// A token that can be used to retrieve the next set of results.
	NextToken *string

	// The list of notification configurations.
	NotificationConfigurationList []types.NotificationConfigurationSummary

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

type ListNotificationConfigurationsPaginator

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

ListNotificationConfigurationsPaginator is a paginator for ListNotificationConfigurations

func NewListNotificationConfigurationsPaginator

NewListNotificationConfigurationsPaginator returns a new ListNotificationConfigurationsPaginator

func (*ListNotificationConfigurationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationConfigurationsPaginator) NextPage

NextPage retrieves the next ListNotificationConfigurations page.

type ListNotificationConfigurationsPaginatorOptions

type ListNotificationConfigurationsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListNotificationConfigurationsPaginatorOptions is the paginator options for ListNotificationConfigurations

type ListOtaTaskConfigurationsAPIClient

type ListOtaTaskConfigurationsAPIClient interface {
	ListOtaTaskConfigurations(context.Context, *ListOtaTaskConfigurationsInput, ...func(*Options)) (*ListOtaTaskConfigurationsOutput, error)
}

ListOtaTaskConfigurationsAPIClient is a client that implements the ListOtaTaskConfigurations operation.

type ListOtaTaskConfigurationsInput

type ListOtaTaskConfigurationsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOtaTaskConfigurationsOutput

type ListOtaTaskConfigurationsOutput struct {

	// The list of the over-the-air (OTA) task configurations.
	Items []types.OtaTaskConfigurationSummary

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListOtaTaskConfigurationsPaginator

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

ListOtaTaskConfigurationsPaginator is a paginator for ListOtaTaskConfigurations

func NewListOtaTaskConfigurationsPaginator

NewListOtaTaskConfigurationsPaginator returns a new ListOtaTaskConfigurationsPaginator

func (*ListOtaTaskConfigurationsPaginator) HasMorePages

func (p *ListOtaTaskConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOtaTaskConfigurationsPaginator) NextPage

NextPage retrieves the next ListOtaTaskConfigurations page.

type ListOtaTaskConfigurationsPaginatorOptions

type ListOtaTaskConfigurationsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListOtaTaskConfigurationsPaginatorOptions is the paginator options for ListOtaTaskConfigurations

type ListOtaTaskExecutionsAPIClient

type ListOtaTaskExecutionsAPIClient interface {
	ListOtaTaskExecutions(context.Context, *ListOtaTaskExecutionsInput, ...func(*Options)) (*ListOtaTaskExecutionsOutput, error)
}

ListOtaTaskExecutionsAPIClient is a client that implements the ListOtaTaskExecutions operation.

type ListOtaTaskExecutionsInput

type ListOtaTaskExecutionsInput struct {

	// The over-the-air (OTA) task id.
	//
	// This member is required.
	Identifier *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOtaTaskExecutionsOutput

type ListOtaTaskExecutionsOutput struct {

	// A list of all of the over-the-air (OTA) task executions.
	ExecutionSummaries []types.OtaTaskExecutionSummaries

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListOtaTaskExecutionsPaginator

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

ListOtaTaskExecutionsPaginator is a paginator for ListOtaTaskExecutions

func NewListOtaTaskExecutionsPaginator

NewListOtaTaskExecutionsPaginator returns a new ListOtaTaskExecutionsPaginator

func (*ListOtaTaskExecutionsPaginator) HasMorePages

func (p *ListOtaTaskExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOtaTaskExecutionsPaginator) NextPage

NextPage retrieves the next ListOtaTaskExecutions page.

type ListOtaTaskExecutionsPaginatorOptions

type ListOtaTaskExecutionsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListOtaTaskExecutionsPaginatorOptions is the paginator options for ListOtaTaskExecutions

type ListOtaTasksAPIClient

type ListOtaTasksAPIClient interface {
	ListOtaTasks(context.Context, *ListOtaTasksInput, ...func(*Options)) (*ListOtaTasksOutput, error)
}

ListOtaTasksAPIClient is a client that implements the ListOtaTasks operation.

type ListOtaTasksInput

type ListOtaTasksInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOtaTasksOutput

type ListOtaTasksOutput struct {

	// A token that can be used to retrieve the next set of results.
	NextToken *string

	// A list of all of the over-the-air (OTA) tasks.
	Tasks []types.OtaTaskSummary

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

type ListOtaTasksPaginator

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

ListOtaTasksPaginator is a paginator for ListOtaTasks

func NewListOtaTasksPaginator

func NewListOtaTasksPaginator(client ListOtaTasksAPIClient, params *ListOtaTasksInput, optFns ...func(*ListOtaTasksPaginatorOptions)) *ListOtaTasksPaginator

NewListOtaTasksPaginator returns a new ListOtaTasksPaginator

func (*ListOtaTasksPaginator) HasMorePages

func (p *ListOtaTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOtaTasksPaginator) NextPage

func (p *ListOtaTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOtaTasksOutput, error)

NextPage retrieves the next ListOtaTasks page.

type ListOtaTasksPaginatorOptions

type ListOtaTasksPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListOtaTasksPaginatorOptions is the paginator options for ListOtaTasks

type ListProvisioningProfilesAPIClient

type ListProvisioningProfilesAPIClient interface {
	ListProvisioningProfiles(context.Context, *ListProvisioningProfilesInput, ...func(*Options)) (*ListProvisioningProfilesOutput, error)
}

ListProvisioningProfilesAPIClient is a client that implements the ListProvisioningProfiles operation.

type ListProvisioningProfilesInput

type ListProvisioningProfilesInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProvisioningProfilesOutput

type ListProvisioningProfilesOutput struct {

	// The list of provisioning profiles.
	Items []types.ProvisioningProfileSummary

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListProvisioningProfilesPaginator

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

ListProvisioningProfilesPaginator is a paginator for ListProvisioningProfiles

func NewListProvisioningProfilesPaginator

NewListProvisioningProfilesPaginator returns a new ListProvisioningProfilesPaginator

func (*ListProvisioningProfilesPaginator) HasMorePages

func (p *ListProvisioningProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProvisioningProfilesPaginator) NextPage

NextPage retrieves the next ListProvisioningProfiles page.

type ListProvisioningProfilesPaginatorOptions

type ListProvisioningProfilesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListProvisioningProfilesPaginatorOptions is the paginator options for ListProvisioningProfiles

type ListSchemaVersionsAPIClient

type ListSchemaVersionsAPIClient interface {
	ListSchemaVersions(context.Context, *ListSchemaVersionsInput, ...func(*Options)) (*ListSchemaVersionsOutput, error)
}

ListSchemaVersionsAPIClient is a client that implements the ListSchemaVersions operation.

type ListSchemaVersionsInput

type ListSchemaVersionsInput struct {

	// Filter on the type of schema version.
	//
	// This member is required.
	Type types.SchemaVersionType

	// The maximum number of results to return at one time.
	MaxResults *int32

	// Filter on the name of the schema version.
	Namespace *string

	// A token that can be used to retrieve the next set of results.
	NextToken *string

	// Filter on the id of the schema version.
	SchemaId *string

	// The schema version. If this is left blank, it defaults to the latest version.
	SemanticVersion *string

	// The visibility of the schema version.
	Visibility types.SchemaVersionVisibility
	// contains filtered or unexported fields
}

type ListSchemaVersionsOutput

type ListSchemaVersionsOutput struct {

	// The list of schema versions.
	Items []types.SchemaVersionListItem

	// A token that can be used to retrieve the next set of results.
	NextToken *string

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

type ListSchemaVersionsPaginator

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

ListSchemaVersionsPaginator is a paginator for ListSchemaVersions

func NewListSchemaVersionsPaginator

func NewListSchemaVersionsPaginator(client ListSchemaVersionsAPIClient, params *ListSchemaVersionsInput, optFns ...func(*ListSchemaVersionsPaginatorOptions)) *ListSchemaVersionsPaginator

NewListSchemaVersionsPaginator returns a new ListSchemaVersionsPaginator

func (*ListSchemaVersionsPaginator) HasMorePages

func (p *ListSchemaVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSchemaVersionsPaginator) NextPage

func (p *ListSchemaVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchemaVersionsOutput, error)

NextPage retrieves the next ListSchemaVersions page.

type ListSchemaVersionsPaginatorOptions

type ListSchemaVersionsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	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
}

ListSchemaVersionsPaginatorOptions is the paginator options for ListSchemaVersions

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

	// 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 client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

type PutDefaultEncryptionConfigurationInput

type PutDefaultEncryptionConfigurationInput struct {

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption
	// if you use KMS_BASED_ENCRYPTION .
	KmsKeyArn *string
	// contains filtered or unexported fields
}

type PutDefaultEncryptionConfigurationOutput

type PutDefaultEncryptionConfigurationOutput struct {

	// Provides the status of the default encryption configuration for an Amazon Web
	// Services account.
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption
	// if you use KMS_BASED_ENCRYPTION .
	KmsKeyArn *string

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

type PutHubConfigurationInput

type PutHubConfigurationInput struct {

	// A user-defined integer value that represents the hub token timer expiry setting
	// in seconds.
	//
	// This member is required.
	HubTokenTimerExpirySettingInSeconds *int64
	// contains filtered or unexported fields
}

type PutHubConfigurationOutput

type PutHubConfigurationOutput struct {

	// A user-defined integer value that represents the hub token timer expiry setting
	// in seconds.
	HubTokenTimerExpirySettingInSeconds *int64

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

type PutRuntimeLogConfigurationInput

type PutRuntimeLogConfigurationInput struct {

	// The id for a managed thing.
	//
	// This member is required.
	ManagedThingId *string

	// The runtime log configuration for a managed thing.
	//
	// This member is required.
	RuntimeLogConfigurations *types.RuntimeLogConfigurations
	// contains filtered or unexported fields
}

type PutRuntimeLogConfigurationOutput

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

type RegisterCustomEndpointInput

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

type RegisterCustomEndpointOutput

type RegisterCustomEndpointOutput struct {

	// The IoT managed integrations dedicated, custom endpoint for the device to route
	// traffic through.
	//
	// This member is required.
	EndpointAddress *string

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

type ResetRuntimeLogConfigurationInput

type ResetRuntimeLogConfigurationInput struct {

	// The id of a managed thing.
	//
	// This member is required.
	ManagedThingId *string
	// contains filtered or unexported fields
}

type ResetRuntimeLogConfigurationOutput

type ResetRuntimeLogConfigurationOutput 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 (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SendManagedThingCommandInput

type SendManagedThingCommandInput struct {

	// The device endpoint.
	//
	// This member is required.
	Endpoints []types.CommandEndpoint

	// The id of the device.
	//
	// This member is required.
	ManagedThingId *string

	// The ID tracking the current discovery process for one connector association.
	ConnectorAssociationId *string
	// contains filtered or unexported fields
}

type SendManagedThingCommandOutput

type SendManagedThingCommandOutput struct {

	// The trace request identifier. This is specified by the device owner, but will
	// be generated by IoT managed integrations if not provided by the device owner.
	TraceId *string

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

type StartDeviceDiscoveryInput

type StartDeviceDiscoveryInput struct {

	// The discovery type supporting the type of device to be discovered in the device
	// discovery job request.
	//
	// This member is required.
	DiscoveryType types.DiscoveryType

	// The authentication material required to start the local device discovery job
	// request.
	AuthenticationMaterial *string

	// The type of authentication material used for device discovery jobs.
	AuthenticationMaterialType types.DiscoveryAuthMaterialType

	// An idempotency token. If you retry a request that completed successfully
	// initially using the same client token and parameters, then the retry attempt
	// will succeed without performing any further actions.
	ClientToken *string

	// The id of the connector association.
	ConnectorAssociationIdentifier *string

	// The id of the end-user's IoT hub.
	ControllerIdentifier *string

	// A set of key/value pairs that are used to manage the device discovery request.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartDeviceDiscoveryOutput

type StartDeviceDiscoveryOutput struct {

	// The id of the device discovery job request.
	Id *string

	// The timestamp value for the start time of the device discovery.
	StartedAt *time.Time

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

type UpdateDestinationInput

type UpdateDestinationInput struct {

	// The name of the customer-managed destination.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the customer-managed destination.
	DeliveryDestinationArn *string

	// The destination type for the customer-managed destination.
	DeliveryDestinationType types.DeliveryDestinationType

	// The description of the customer-managed destination.
	Description *string

	// The Amazon Resource Name (ARN) of the delivery destination role.
	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 UpdateEventLogConfigurationInput

type UpdateEventLogConfigurationInput struct {

	// The log level for the event in terms of severity.
	//
	// This member is required.
	EventLogLevel types.LogLevel

	// The log configuration id.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type UpdateEventLogConfigurationOutput

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

type UpdateManagedThingInput

type UpdateManagedThingInput struct {

	// The id of the managed thing.
	//
	// This member is required.
	Identifier *string

	// The brand of the device.
	Brand *string

	// The capabilities of the device such as light bulb.
	Capabilities *string

	// A report of the capabilities for the managed thing.
	CapabilityReport *types.CapabilityReport

	// The classification of the managed thing such as light bulb or thermostat.
	Classification *string

	// The identifier of the credential for the managed thing.
	CredentialLockerId *string

	// The network mode for the hub-connected device.
	HubNetworkMode types.HubNetworkMode

	// The metadata for the managed thing.
	MetaData map[string]string

	// The model of the device.
	Model *string

	// The name of the managed thing representing the physical device.
	Name *string

	// Owner of the device, usually an indication of whom the device belongs to. This
	// value should not contain personal identifiable information.
	Owner *string

	// The serial number of the device.
	SerialNumber *string
	// contains filtered or unexported fields
}

type UpdateManagedThingOutput

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

type UpdateNotificationConfigurationInput

type UpdateNotificationConfigurationInput struct {

	// The name of the destination for the notification configuration.
	//
	// This member is required.
	DestinationName *string

	// The type of event triggering a device notification to the customer-managed
	// destination.
	//
	// This member is required.
	EventType types.EventType
	// contains filtered or unexported fields
}

type UpdateNotificationConfigurationOutput

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

type UpdateOtaTaskInput

type UpdateOtaTaskInput struct {

	// The over-the-air (OTA) task id.
	//
	// This member is required.
	Identifier *string

	// The description of the over-the-air (OTA) task.
	Description *string

	// The identifier for the over-the-air (OTA) task configuration.
	TaskConfigurationId *string
	// contains filtered or unexported fields
}

type UpdateOtaTaskOutput

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

Source Files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL