iotdataplane

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

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

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

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

type DeleteConnectionInput struct {

	// The unique identifier of the MQTT client to disconnect. The client ID can't
	// start with a dollar sign ($).
	//
	// MQTT client IDs must be URL encoded (percent-encoded) when they contain
	// characters that are not valid in HTTP requests, such as spaces, forward slashes
	// (/), and UTF-8 characters.
	//
	// This member is required.
	ClientId *string

	// Specifies whether to remove the client's persistent session state when
	// disconnecting. Set to TRUE to delete all session information, including
	// subscriptions and queued messages. Set to FALSE to preserve the session state
	// for [persistent sessions]. For clean sessions this parameter will be ignored. By default, this is
	// set to FALSE (preserves the session state).
	//
	// [persistent sessions]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt-persistent-sessions
	CleanSession bool

	// Controls if Amazon Web Services IoT Core publishes the client's Last Will and
	// Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing
	// the LWT message. Set to FALSE to ensure that LWT is published. By default, this
	// is set to FALSE (LWT message is published).
	PreventWillMessage bool
	// contains filtered or unexported fields
}

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

type DeleteThingShadowInput struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The name of the shadow.
	ShadowName *string
	// contains filtered or unexported fields
}

type DeleteThingShadowOutput struct {

	// The state information, in JSON format.
	//
	// This member is required.
	Payload []byte

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

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

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

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

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

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

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

type EndpointResolverOptions = internalendpoints.Options

type EndpointResolverV2 interface {
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

type GetConnectionInput struct {

	// The unique identifier of the MQTT client to retrieve connection information.
	// The client ID can't start with a dollar sign ($).
	//
	// MQTT client IDs must be URL encoded (percent-encoded) when they contain
	// characters that are not valid in HTTP requests, such as spaces, forward slashes
	// (/), and UTF-8 characters.
	//
	// This member is required.
	ClientId *string

	// Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp)
	// should be included in the GetConnection response. Set to TRUE to include socket
	// information. Set to FALSE to omit socket information. By default, this is set
	// to FALSE . See the [developer guide] for how to authorize this parameter.
	//
	// [developer guide]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt-client-disconnect
	IncludeSocketInformation bool
	// contains filtered or unexported fields
}

type GetConnectionOutput struct {

	// Indicates whether the client is using a clean session. Returns true for clean
	// sessions or false for persistent sessions.
	CleanSession bool

	// The unique identifier of the MQTT client. This is the same client ID that was
	// used when the client established the connection.
	ClientId *string

	// The connection state of the client. Returns true if the client is currently
	// connected, or false if the client is not connected.
	Connected bool

	// Unix timestamp (in milliseconds) indicating when the client connected. Present
	// only when connected is true.
	ConnectedSince int64

	// The reason for the last disconnection, if the client is currently disconnected.
	// See the [developer guide]for valid disconnect reasons.
	//
	// [developer guide]: https://docs.aws.amazon.com/iot/latest/developerguide/life-cycle-events.html#connect-disconnect
	DisconnectReason *string

	// Unix timestamp (in milliseconds) indicating when the client disconnected.
	// Present only when connected is false. This information is available for 30
	// minutes after the client disconnects.
	DisconnectedSince int64

	// The keep-alive interval in seconds that the client specified when establishing
	// the connection.
	KeepAliveDuration int32

	// The session expiry interval in seconds for the MQTT client connection. This is
	// configured by the user. This value indicates how long the session will remain
	// active after the client disconnects.
	SessionExpiry int64

	// The IP address of the client that initiated the connection.
	SourceIp *string

	// The client's source port.
	SourcePort int32

	// The IP address of the Amazon Web Services IoT Core endpoint that the client
	// connected to. For clients connected to VPC endpoints, this is the private IP
	// address of the network interface the client is connected to.
	TargetIp *string

	// The port number of the Amazon Web Services IoT Core endpoint that the client
	// connected to.
	TargetPort int32

	// The name of the thing associated with the principal of the MQTT client, if
	// applicable.
	ThingName *string

	// The ID of the VPC endpoint. Present for clients connected to IoT Core via a [VPC endpoint].
	//
	// [VPC endpoint]: https://docs.aws.amazon.com/iot/latest/developerguide/IoTCore-VPC.html
	VpcEndpointId *string

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

type GetRetainedMessageInput struct {

	// The topic name of the retained message to retrieve.
	//
	// This member is required.
	Topic *string
	// contains filtered or unexported fields
}

type GetRetainedMessageOutput struct {

	// The Epoch date and time, in milliseconds, when the retained message was stored
	// by IoT.
	LastModifiedTime int64

	// The Base64-encoded message payload of the retained message body.
	Payload []byte

	// The quality of service (QoS) level used to publish the retained message.
	Qos int32

	// The topic name to which the retained message was published.
	Topic *string

	// A base64-encoded JSON string that includes an array of JSON objects, or null if
	// the retained message doesn't include any user properties.
	//
	// The following example userProperties parameter is a JSON string that represents
	// two user properties. Note that it will be base64-encoded:
	//
	//     [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
	UserProperties []byte

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

type GetThingShadowInput struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The name of the shadow.
	ShadowName *string
	// contains filtered or unexported fields
}

type GetThingShadowOutput struct {

	// The state information, in JSON format.
	Payload []byte

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

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

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 ListNamedShadowsForThingInput struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The token to retrieve the next set of results.
	NextToken *string

	// The result page size.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListNamedShadowsForThingOutput struct {

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

	// The list of shadows for the specified thing.
	Results []string

	// The Epoch date and time the response was generated by IoT.
	Timestamp int64

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

type ListRetainedMessagesAPIClient interface {
	ListRetainedMessages(context.Context, *ListRetainedMessagesInput, ...func(*Options)) (*ListRetainedMessagesOutput, error)
}

type ListRetainedMessagesInput struct {

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

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

type ListRetainedMessagesOutput struct {

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

	// A summary list the account's retained messages. The information returned
	// doesn't include the message payloads of the retained messages.
	RetainedTopics []types.RetainedMessageSummary

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

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

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

type ListSubscriptionsAPIClient interface {
	ListSubscriptions(context.Context, *ListSubscriptionsInput, ...func(*Options)) (*ListSubscriptionsOutput, error)
}

type ListSubscriptionsInput struct {

	// The unique identifier of the MQTT client to list subscriptions for. The client
	// ID can't start with a dollar sign ($).
	//
	// MQTT client IDs must be URL encoded (percent-encoded) when they contain
	// characters that are not valid in HTTP requests, such as spaces, forward slashes
	// (/), and UTF-8 characters.
	//
	// This member is required.
	ClientId *string

	// The maximum number of subscriptions to return in a single request. By default,
	// this is set to 20.
	MaxResults *int32

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

type ListSubscriptionsOutput struct {

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

	// A list of topic filters and their associated Quality of Service (QoS) levels
	// that the client is subscribed to.
	Subscriptions []types.SubscriptionSummary

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

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

type ListSubscriptionsPaginatorOptions struct {
	// The maximum number of subscriptions to return in a single request. By default,
	// this is set to 20.
	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
}

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

	// Disables SDK clock skew correction. When set, the SDK will not adjust request
	// signing timestamps to compensate for clock drift between the client and the
	// service.
	DisableClockSkewCorrection bool

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	Protocol smithyhttp.ClientProtocol

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

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

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

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

type PublishInput struct {

	// The name of the MQTT topic.
	//
	// This member is required.
	Topic *string

	// A UTF-8 encoded string that describes the content of the publishing message.
	ContentType *string

	// The base64-encoded binary data used by the sender of the request message to
	// identify which request the response message is for when it's received.
	// correlationData is an HTTP header value in the API.
	CorrelationData *string

	// A user-defined integer value that represents the message expiry interval in
	// seconds. If absent, the message doesn't expire. For more information about the
	// limits of messageExpiry , see [Amazon Web Services IoT Core message broker and protocol limits and quotas] from the Amazon Web Services Reference Guide.
	//
	// [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits
	MessageExpiry int64

	// The message body. MQTT accepts text, binary, and empty (null) message payloads.
	//
	// Publishing an empty (null) payload with retain = true deletes the retained
	// message identified by topic from Amazon Web Services IoT Core.
	Payload []byte

	// An Enum string value that indicates whether the payload is formatted as UTF-8.
	// payloadFormatIndicator is an HTTP header value in the API.
	PayloadFormatIndicator types.PayloadFormatIndicator

	// The Quality of Service (QoS) level. The default QoS level is 0.
	Qos int32

	// A UTF-8 encoded string that's used as the topic name for a response message.
	// The response topic is used to describe the topic which the receiver should
	// publish to as part of the request-response flow. The topic must not contain
	// wildcard characters.
	ResponseTopic *string

	// A Boolean value that determines whether to set the RETAIN flag when the message
	// is published.
	//
	// Setting the RETAIN flag causes the message to be retained and sent to new
	// subscribers to the topic.
	//
	// Valid values: true | false
	//
	// Default value: false
	Retain bool

	// A JSON string that contains an array of JSON objects. If you don’t use Amazon
	// Web Services SDK or CLI, you must encode the JSON string to base64 format before
	// adding it to the HTTP header. userProperties is an HTTP header value in the API.
	//
	// The following example userProperties parameter is a JSON string which
	// represents two User Properties. Note that it needs to be base64-encoded:
	//
	//     [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
	//
	// This value conforms to the media type: application/json
	UserProperties *string
	// contains filtered or unexported fields
}

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

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

type SendDirectMessageInput struct {

	// The unique identifier of the MQTT client to send the message to.
	//
	// Client IDs must not exceed 128 characters and can't start with a dollar sign
	// ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain
	// characters that are not valid in HTTP requests, such as spaces, forward slashes
	// (/), and UTF-8 characters. For more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].
	//
	// [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits
	//
	// This member is required.
	ClientId *string

	// The topic of the outbound MQTT Publish message to the receiving client. For
	// more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].
	//
	// [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits
	//
	// This member is required.
	Topic *string

	// A Boolean value that specifies whether to wait for delivery confirmation from
	// the receiving client.
	//
	// When set to true , the API delivers the message at QoS 1 and waits for the
	// client to send a delivery confirmation (PUBACK) before returning a successful
	// response. If delivery confirmation is not received within the specified timeout
	// period, the API returns HTTP 504.
	//
	// When set to false , the API delivers the message at QoS 0 and returns after
	// Amazon Web Services IoT Core attempts to deliver the message.
	//
	// Valid values: true | false
	//
	// Default value: false
	Confirmation bool

	// The MQTT5 content type property forwarded to the receiving client (for example,
	// application/json ).
	ContentType *string

	// The base64-encoded binary data used by the sender of the request message to
	// identify which request the response message is for when it's received.
	// correlationData is an HTTP header value in the API.
	CorrelationData *string

	// The message body. MQTT accepts text, binary, and empty (null) message payloads.
	Payload []byte

	// An Enum string value that indicates whether the payload is formatted as UTF-8.
	// payloadFormatIndicator is an HTTP header value in the API.
	PayloadFormatIndicator types.PayloadFormatIndicator

	// A UTF-8 encoded string that's used as the topic name for a response message.
	// The response topic describes the topic which the receiver should publish to as
	// part of the request-response flow. The topic must not contain wildcard
	// characters. For more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].
	//
	// [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits
	ResponseTopic *string

	// An integer that represents the maximum time, in seconds, to wait for a delivery
	// confirmation (PUBACK) from the receiving client after the message has been
	// delivered. This parameter is only used when confirmation is set to true . If
	// confirmation is false , this parameter is ignored.
	//
	// The total API response time may be higher than this value due to internal
	// processing. Set your HTTP client timeout to a value greater than this parameter.
	//
	// Valid range: 1 to 15 seconds.
	//
	// Default value: 5 seconds.
	Timeout int32

	// A JSON string that contains an array of JSON objects. If you don't use Amazon
	// Web Services SDK or CLI, you must encode the JSON string to base64 format before
	// adding it to the HTTP header. userProperties is an HTTP header value in the API.
	//
	// For MQTT 3.1.1 clients, user properties are silently dropped.
	//
	// The following example userProperties parameter is a JSON string which
	// represents two User Properties. Note that it needs to be base64-encoded:
	//
	//     [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
	//
	// This value conforms to the media type: application/json
	UserProperties *string
	// contains filtered or unexported fields
}

type SendDirectMessageOutput struct {

	// The status message indicating the result of the operation.
	Message *string

	// A unique identifier for the request. Include this value when contacting Amazon
	// Web Services Support for troubleshooting.
	TraceId *string

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

type UpdateThingShadowInput struct {

	// The state information, in JSON format.
	//
	// This member is required.
	Payload []byte

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The name of the shadow.
	ShadowName *string
	// contains filtered or unexported fields
}

type UpdateThingShadowOutput struct {

	// The state information, in JSON format.
	Payload []byte

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