iotanalytics – github.com/aws/aws-sdk-go-v2/service/iotanalytics Index | Files | Directories

package iotanalytics

import "github.com/aws/aws-sdk-go-v2/service/iotanalytics"

Index

Constants

const ServiceAPIVersion = "2017-11-27"
const ServiceID = "IoTAnalytics"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type BatchPutMessageInput

type BatchPutMessageInput struct {

	// The list of messages to be sent. Each message has format: '{ "messageId":
	// "string", "payload": "string"}'. Note that the field names of message payloads
	// (data) that you send to AWS IoT Analytics:
	//
	//     * Must contain only alphanumeric
	// characters and undescores (_); no other special characters are allowed.
	//
	//     *
	// Must begin with an alphabetic character or single underscore (_).
	//
	//     * Cannot
	// contain hyphens (-).
	//
	//     * In regular expression terms:
	// "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
	//
	//     * Cannot be greater
	// than 255 characters.
	//
	//     * Are case-insensitive. (Fields named "foo" and "FOO"
	// in the same payload are considered duplicates.)
	//
	// For example, {"temp_01": 29} or
	// {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
	// {"__temp_01": 29} are invalid in message payloads.
	//
	// This member is required.
	Messages []*types.Message

	// The name of the channel where the messages are sent.
	//
	// This member is required.
	ChannelName *string
}

type BatchPutMessageOutput

type BatchPutMessageOutput struct {

	// A list of any errors encountered when sending the messages to the channel.
	BatchPutMessageErrorEntries []*types.BatchPutMessageErrorEntry

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

type CancelPipelineReprocessingInput

type CancelPipelineReprocessingInput struct {

	// The name of pipeline for which data reprocessing is canceled.
	//
	// This member is required.
	PipelineName *string

	// The ID of the reprocessing task (returned by "StartPipelineReprocessing").
	//
	// This member is required.
	ReprocessingId *string
}

type CancelPipelineReprocessingOutput

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

type Client

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

AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight. <p>Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources. </p> <p>AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.</p>

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

func (c *Client) BatchPutMessage(ctx context.Context, params *BatchPutMessageInput, optFns ...func(*Options)) (*BatchPutMessageOutput, error)

Sends messages to a channel.

func (*Client) CancelPipelineReprocessing

func (c *Client) CancelPipelineReprocessing(ctx context.Context, params *CancelPipelineReprocessingInput, optFns ...func(*Options)) (*CancelPipelineReprocessingOutput, error)

Cancels the reprocessing of data through the pipeline.

func (*Client) CreateChannel

func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)

Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

func (*Client) CreateDataset

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify.

func (*Client) CreateDatasetContent

func (c *Client) CreateDatasetContent(ctx context.Context, params *CreateDatasetContentInput, optFns ...func(*Options)) (*CreateDatasetContentOutput, error)

Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).

func (*Client) CreateDatastore

func (c *Client) CreateDatastore(ctx context.Context, params *CreateDatastoreInput, optFns ...func(*Options)) (*CreateDatastoreOutput, error)

Creates a data store, which is a repository for messages.

func (*Client) CreatePipeline

func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error)

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

func (*Client) DeleteChannel

func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)

Deletes the specified channel.

func (*Client) DeleteDataset

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation.

func (*Client) DeleteDatasetContent

func (c *Client) DeleteDatasetContent(ctx context.Context, params *DeleteDatasetContentInput, optFns ...func(*Options)) (*DeleteDatasetContentOutput, error)

Deletes the content of the specified data set.

func (*Client) DeleteDatastore

func (c *Client) DeleteDatastore(ctx context.Context, params *DeleteDatastoreInput, optFns ...func(*Options)) (*DeleteDatastoreOutput, error)

Deletes the specified data store.

func (*Client) DeletePipeline

func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error)

Deletes the specified pipeline.

func (*Client) DescribeChannel

func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error)

Retrieves information about a channel.

func (*Client) DescribeDataset

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Retrieves information about a data set.

func (*Client) DescribeDatastore

func (c *Client) DescribeDatastore(ctx context.Context, params *DescribeDatastoreInput, optFns ...func(*Options)) (*DescribeDatastoreOutput, error)

Retrieves information about a data store.

func (*Client) DescribeLoggingOptions

func (c *Client) DescribeLoggingOptions(ctx context.Context, params *DescribeLoggingOptionsInput, optFns ...func(*Options)) (*DescribeLoggingOptionsOutput, error)

Retrieves the current settings of the AWS IoT Analytics logging options.

func (*Client) DescribePipeline

func (c *Client) DescribePipeline(ctx context.Context, params *DescribePipelineInput, optFns ...func(*Options)) (*DescribePipelineOutput, error)

Retrieves information about a pipeline.

func (*Client) GetDatasetContent

func (c *Client) GetDatasetContent(ctx context.Context, params *GetDatasetContentInput, optFns ...func(*Options)) (*GetDatasetContentOutput, error)

Retrieves the contents of a data set as pre-signed URIs.

func (*Client) ListChannels

func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)

Retrieves a list of channels.

func (*Client) ListDatasetContents

func (c *Client) ListDatasetContents(ctx context.Context, params *ListDatasetContentsInput, optFns ...func(*Options)) (*ListDatasetContentsOutput, error)

Lists information about data set contents that have been created.

func (*Client) ListDatasets

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

Retrieves information about data sets.

func (*Client) ListDatastores

func (c *Client) ListDatastores(ctx context.Context, params *ListDatastoresInput, optFns ...func(*Options)) (*ListDatastoresOutput, error)

Retrieves a list of data stores.

func (*Client) ListPipelines

func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error)

Retrieves a list of pipelines.

func (*Client) ListTagsForResource

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

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

func (*Client) PutLoggingOptions

func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error)

Sets or updates the AWS IoT Analytics logging options. Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.

func (*Client) RunPipelineActivity

func (c *Client) RunPipelineActivity(ctx context.Context, params *RunPipelineActivityInput, optFns ...func(*Options)) (*RunPipelineActivityOutput, error)

Simulates the results of running a pipeline activity on a message payload.

func (*Client) SampleChannelData

func (c *Client) SampleChannelData(ctx context.Context, params *SampleChannelDataInput, optFns ...func(*Options)) (*SampleChannelDataOutput, error)

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

func (*Client) StartPipelineReprocessing

func (c *Client) StartPipelineReprocessing(ctx context.Context, params *StartPipelineReprocessingInput, optFns ...func(*Options)) (*StartPipelineReprocessingOutput, error)

Starts the reprocessing of raw message data through the pipeline.

func (*Client) TagResource

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

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

func (*Client) UntagResource

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

Removes the given tags (metadata) from the resource.

func (*Client) UpdateChannel

func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)

Updates the settings of a channel.

func (*Client) UpdateDataset

func (c *Client) UpdateDataset(ctx context.Context, params *UpdateDatasetInput, optFns ...func(*Options)) (*UpdateDatasetOutput, error)

Updates the settings of a data set.

func (*Client) UpdateDatastore

func (c *Client) UpdateDatastore(ctx context.Context, params *UpdateDatastoreInput, optFns ...func(*Options)) (*UpdateDatastoreOutput, error)

Updates the settings of a data store.

func (*Client) UpdatePipeline

func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error)

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

type CreateChannelInput

type CreateChannelInput struct {

	// Where channel data is stored. You may choose one of "serviceManagedS3" or
	// "customerManagedS3" storage. If not specified, the default is
	// "serviceManagedS3". This cannot be changed after creation of the channel.
	ChannelStorage *types.ChannelStorage

	// How long, in days, message data is kept for the channel. When
	// "customerManagedS3" storage is selected, this parameter is ignored.
	RetentionPeriod *types.RetentionPeriod

	// Metadata which can be used to manage the channel.
	Tags []*types.Tag

	// The name of the channel.
	//
	// This member is required.
	ChannelName *string
}

type CreateChannelOutput

type CreateChannelOutput struct {

	// How long, in days, message data is kept for the channel.
	RetentionPeriod *types.RetentionPeriod

	// The ARN of the channel.
	ChannelArn *string

	// The name of the channel.
	ChannelName *string

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

type CreateDatasetContentInput

type CreateDatasetContentInput struct {

	// The name of the data set.
	//
	// This member is required.
	DatasetName *string
}

type CreateDatasetContentOutput

type CreateDatasetContentOutput struct {

	// The version ID of the data set contents which are being created.
	VersionId *string

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

type CreateDatasetInput

type CreateDatasetInput struct {

	// [Optional] How many versions of data set contents are kept. If not specified or
	// set to null, only the latest version plus the latest succeeded version (if they
	// are different) are kept for the time period specified by the "retentionPeriod"
	// parameter. (For more information, see
	// https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
	VersioningConfiguration *types.VersioningConfiguration

	// A list of actions that create the data set contents.
	//
	// This member is required.
	Actions []*types.DatasetAction

	// When data set contents are created they are delivered to destinations specified
	// here.
	ContentDeliveryRules []*types.DatasetContentDeliveryRule

	// The name of the data set.
	//
	// This member is required.
	DatasetName *string

	// A list of triggers. A trigger causes data set contents to be populated at a
	// specified time interval or when another data set's contents are created. The
	// list of triggers can be empty or contain up to five DataSetTrigger objects.
	Triggers []*types.DatasetTrigger

	// Metadata which can be used to manage the data set.
	Tags []*types.Tag

	// [Optional] How long, in days, versions of data set contents are kept for the
	// data set. If not specified or set to null, versions of data set contents are
	// retained for at most 90 days. The number of versions of data set contents
	// retained is determined by the versioningConfiguration parameter. (For more
	// information, see
	// https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
	RetentionPeriod *types.RetentionPeriod
}

type CreateDatasetOutput

type CreateDatasetOutput struct {

	// How long, in days, data set contents are kept for the data set.
	RetentionPeriod *types.RetentionPeriod

	// The name of the data set.
	DatasetName *string

	// The ARN of the data set.
	DatasetArn *string

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

type CreateDatastoreInput

type CreateDatastoreInput struct {

	// How long, in days, message data is kept for the data store. When
	// "customerManagedS3" storage is selected, this parameter is ignored.
	RetentionPeriod *types.RetentionPeriod

	// The name of the data store.
	//
	// This member is required.
	DatastoreName *string

	// Metadata which can be used to manage the data store.
	Tags []*types.Tag

	// Where data store data is stored. You may choose one of "serviceManagedS3" or
	// "customerManagedS3" storage. If not specified, the default is
	// "serviceManagedS3". This cannot be changed after the data store is created.
	DatastoreStorage *types.DatastoreStorage
}

type CreateDatastoreOutput

type CreateDatastoreOutput struct {

	// The ARN of the data store.
	DatastoreArn *string

	// How long, in days, message data is kept for the data store.
	RetentionPeriod *types.RetentionPeriod

	// The name of the data store.
	DatastoreName *string

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

type CreatePipelineInput

type CreatePipelineInput struct {

	// Metadata which can be used to manage the pipeline.
	Tags []*types.Tag

	// A list of "PipelineActivity" objects. Activities perform transformations on your
	// messages, such as removing, renaming or adding message attributes; filtering
	// messages based on attribute values; invoking your Lambda functions on messages
	// for advanced processing; or performing mathematical transformations to normalize
	// device data. The list can be 2-25 PipelineActivity objects and must contain both
	// a channel and a datastore activity. Each entry in the list must contain only one
	// activity, for example: pipelineActivities = [ { "channel": { ... } }, {
	// "lambda": { ... } }, ... ]
	//
	// This member is required.
	PipelineActivities []*types.PipelineActivity

	// The name of the pipeline.
	//
	// This member is required.
	PipelineName *string
}

type CreatePipelineOutput

type CreatePipelineOutput struct {

	// The name of the pipeline.
	PipelineName *string

	// The ARN of the pipeline.
	PipelineArn *string

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

type DeleteChannelInput

type DeleteChannelInput struct {

	// The name of the channel to delete.
	//
	// This member is required.
	ChannelName *string
}

type DeleteChannelOutput

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

type DeleteDatasetContentInput

type DeleteDatasetContentInput struct {

	// The name of the data set whose content is deleted.
	//
	// This member is required.
	DatasetName *string

	// The version of the data set whose content is deleted. You can also use the
	// strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest
	// successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the
	// default.
	VersionId *string
}

type DeleteDatasetContentOutput

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

type DeleteDatasetInput

type DeleteDatasetInput struct {

	// The name of the data set to delete.
	//
	// This member is required.
	DatasetName *string
}

type DeleteDatasetOutput

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

type DeleteDatastoreInput

type DeleteDatastoreInput struct {

	// The name of the data store to delete.
	//
	// This member is required.
	DatastoreName *string
}

type DeleteDatastoreOutput

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

type DeletePipelineInput

type DeletePipelineInput struct {

	// The name of the pipeline to delete.
	//
	// This member is required.
	PipelineName *string
}

type DeletePipelineOutput

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

type DescribeChannelInput

type DescribeChannelInput struct {

	// The name of the channel whose information is retrieved.
	//
	// This member is required.
	ChannelName *string

	// If true, additional statistical information about the channel is included in the
	// response. This feature cannot be used with a channel whose S3 storage is
	// customer-managed.
	IncludeStatistics *bool
}

type DescribeChannelOutput

type DescribeChannelOutput struct {

	// Statistics about the channel. Included if the 'includeStatistics' parameter is
	// set to true in the request.
	Statistics *types.ChannelStatistics

	// An object that contains information about the channel.
	Channel *types.Channel

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

type DescribeDatasetInput

type DescribeDatasetInput struct {

	// The name of the data set whose information is retrieved.
	//
	// This member is required.
	DatasetName *string
}

type DescribeDatasetOutput

type DescribeDatasetOutput struct {

	// An object that contains information about the data set.
	Dataset *types.Dataset

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

type DescribeDatastoreInput

type DescribeDatastoreInput struct {

	// The name of the data store
	//
	// This member is required.
	DatastoreName *string

	// If true, additional statistical information about the data store is included in
	// the response. This feature cannot be used with a data store whose S3 storage is
	// customer-managed.
	IncludeStatistics *bool
}

type DescribeDatastoreOutput

type DescribeDatastoreOutput struct {

	// Information about the data store.
	Datastore *types.Datastore

	// Additional statistical information about the data store. Included if the
	// 'includeStatistics' parameter is set to true in the request.
	Statistics *types.DatastoreStatistics

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

type DescribeLoggingOptionsInput

type DescribeLoggingOptionsInput struct {
}

type DescribeLoggingOptionsOutput

type DescribeLoggingOptionsOutput struct {

	// The current settings of the AWS IoT Analytics logging options.
	LoggingOptions *types.LoggingOptions

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

type DescribePipelineInput

type DescribePipelineInput struct {

	// The name of the pipeline whose information is retrieved.
	//
	// This member is required.
	PipelineName *string
}

type DescribePipelineOutput

type DescribePipelineOutput struct {

	// A "Pipeline" object that contains information about the pipeline.
	Pipeline *types.Pipeline

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)

type GetDatasetContentInput

type GetDatasetContentInput struct {

	// The name of the data set whose contents are retrieved.
	//
	// This member is required.
	DatasetName *string

	// The version of the data set whose contents are retrieved. You can also use the
	// strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest
	// or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED"
	// is the default.
	VersionId *string
}

type GetDatasetContentOutput

type GetDatasetContentOutput struct {

	// A list of "DatasetEntry" objects.
	Entries []*types.DatasetEntry

	// The time when the request was made.
	Timestamp *time.Time

	// The status of the data set content.
	Status *types.DatasetContentStatus

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

type HTTPClient

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

type HTTPSignerV4

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

type ListChannelsInput

type ListChannelsInput struct {

	// The maximum number of results to return in this request. The default value is
	// 100.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
}

type ListChannelsOutput

type ListChannelsOutput struct {

	// A list of "ChannelSummary" objects.
	ChannelSummaries []*types.ChannelSummary

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

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

type ListDatasetContentsInput

type ListDatasetContentsInput struct {

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

	// The name of the data set whose contents information you want to list.
	//
	// This member is required.
	DatasetName *string

	// A filter to limit results to those data set contents whose creation is scheduled
	// on or after the given time. See the field triggers.schedule in the CreateDataset
	// request. (timestamp)
	ScheduledOnOrAfter *time.Time

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

	// A filter to limit results to those data set contents whose creation is scheduled
	// before the given time. See the field triggers.schedule in the CreateDataset
	// request. (timestamp)
	ScheduledBefore *time.Time
}

type ListDatasetContentsOutput

type ListDatasetContentsOutput struct {

	// Summary information about data set contents that have been created.
	DatasetContentSummaries []*types.DatasetContentSummary

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

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

type ListDatasetsInput

type ListDatasetsInput struct {

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

	// The maximum number of results to return in this request. The default value is
	// 100.
	MaxResults *int32
}

type ListDatasetsOutput

type ListDatasetsOutput struct {

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

	// A list of "DatasetSummary" objects.
	DatasetSummaries []*types.DatasetSummary

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

type ListDatastoresInput

type ListDatastoresInput struct {

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

	// The maximum number of results to return in this request. The default value is
	// 100.
	MaxResults *int32
}

type ListDatastoresOutput

type ListDatastoresOutput struct {

	// A list of "DatastoreSummary" objects.
	DatastoreSummaries []*types.DatastoreSummary

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

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

type ListPipelinesInput

type ListPipelinesInput struct {

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

	// The maximum number of results to return in this request. The default value is
	// 100.
	MaxResults *int32
}

type ListPipelinesOutput

type ListPipelinesOutput struct {

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

	// A list of "PipelineSummary" objects.
	PipelineSummaries []*types.PipelineSummary

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

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN of the resource whose tags you want to list.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags (metadata) which you have assigned to the resource.
	Tags []*types.Tag

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

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 credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutLoggingOptionsInput

type PutLoggingOptionsInput struct {

	// The new values of the AWS IoT Analytics logging options.
	//
	// This member is required.
	LoggingOptions *types.LoggingOptions
}

type PutLoggingOptionsOutput

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type RunPipelineActivityInput

type RunPipelineActivityInput struct {

	// The pipeline activity that is run. This must not be a 'channel' activity or a
	// 'datastore' activity because these activities are used in a pipeline only to
	// load the original message and to store the (possibly) transformed message. If a
	// 'lambda' activity is specified, only short-running Lambda functions (those with
	// a timeout of less than 30 seconds or less) can be used.
	//
	// This member is required.
	PipelineActivity *types.PipelineActivity

	// The sample message payloads on which the pipeline activity is run.
	//
	// This member is required.
	Payloads [][]byte
}

type RunPipelineActivityOutput

type RunPipelineActivityOutput struct {

	// The enriched or transformed sample message payloads as base64-encoded strings.
	// (The results of running the pipeline activity on each input sample message
	// payload, encoded in base64.)
	Payloads [][]byte

	// In case the pipeline activity fails, the log message that is generated.
	LogResult *string

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

type SampleChannelDataInput

type SampleChannelDataInput struct {

	// The end of the time window from which sample messages are retrieved.
	EndTime *time.Time

	// The start of the time window from which sample messages are retrieved.
	StartTime *time.Time

	// The name of the channel whose message samples are retrieved.
	//
	// This member is required.
	ChannelName *string

	// The number of sample messages to be retrieved. The limit is 10, the default is
	// also 10.
	MaxMessages *int32
}

type SampleChannelDataOutput

type SampleChannelDataOutput struct {

	// The list of message samples. Each sample message is returned as a base64-encoded
	// string.
	Payloads [][]byte

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

type StartPipelineReprocessingInput

type StartPipelineReprocessingInput struct {

	// The end time (exclusive) of raw message data that is reprocessed.
	EndTime *time.Time

	// The name of the pipeline on which to start reprocessing.
	//
	// This member is required.
	PipelineName *string

	// The start time (inclusive) of raw message data that is reprocessed.
	StartTime *time.Time
}

type StartPipelineReprocessingOutput

type StartPipelineReprocessingOutput struct {

	// The ID of the pipeline reprocessing activity that was started.
	ReprocessingId *string

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

type TagResourceInput

type TagResourceInput struct {

	// The new or modified tags for the resource.
	//
	// This member is required.
	Tags []*types.Tag

	// The ARN of the resource whose tags you want to modify.
	//
	// This member is required.
	ResourceArn *string
}

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The keys of those tags which you want to remove.
	//
	// This member is required.
	TagKeys []*string

	// The ARN of the resource whose tags you want to remove.
	//
	// This member is required.
	ResourceArn *string
}

type UntagResourceOutput

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

type UpdateChannelInput

type UpdateChannelInput struct {

	// The name of the channel to be updated.
	//
	// This member is required.
	ChannelName *string

	// How long, in days, message data is kept for the channel. The retention period
	// cannot be updated if the channel's S3 storage is customer-managed.
	RetentionPeriod *types.RetentionPeriod

	// Where channel data is stored. You may choose one of "serviceManagedS3" or
	// "customerManagedS3" storage. If not specified, the default is
	// "serviceManagedS3". This cannot be changed after creation of the channel.
	ChannelStorage *types.ChannelStorage
}

type UpdateChannelOutput

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

type UpdateDatasetInput

type UpdateDatasetInput struct {

	// The name of the data set to update.
	//
	// This member is required.
	DatasetName *string

	// [Optional] How many versions of data set contents are kept. If not specified or
	// set to null, only the latest version plus the latest succeeded version (if they
	// are different) are kept for the time period specified by the "retentionPeriod"
	// parameter. (For more information, see
	// https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
	VersioningConfiguration *types.VersioningConfiguration

	// When data set contents are created they are delivered to destinations specified
	// here.
	ContentDeliveryRules []*types.DatasetContentDeliveryRule

	// A list of "DatasetAction" objects.
	//
	// This member is required.
	Actions []*types.DatasetAction

	// How long, in days, data set contents are kept for the data set.
	RetentionPeriod *types.RetentionPeriod

	// A list of "DatasetTrigger" objects. The list can be empty or can contain up to
	// five DataSetTrigger objects.
	Triggers []*types.DatasetTrigger
}

type UpdateDatasetOutput

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

type UpdateDatastoreInput

type UpdateDatastoreInput struct {

	// The name of the data store to be updated.
	//
	// This member is required.
	DatastoreName *string

	// Where data store data is stored. You may choose one of "serviceManagedS3" or
	// "customerManagedS3" storage. If not specified, the default is
	// "serviceManagedS3". This cannot be changed after the data store is created.
	DatastoreStorage *types.DatastoreStorage

	// How long, in days, message data is kept for the data store. The retention period
	// cannot be updated if the data store's S3 storage is customer-managed.
	RetentionPeriod *types.RetentionPeriod
}

type UpdateDatastoreOutput

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

type UpdatePipelineInput

type UpdatePipelineInput struct {

	// The name of the pipeline to update.
	//
	// This member is required.
	PipelineName *string

	// A list of "PipelineActivity" objects. Activities perform transformations on your
	// messages, such as removing, renaming or adding message attributes; filtering
	// messages based on attribute values; invoking your Lambda functions on messages
	// for advanced processing; or performing mathematical transformations to normalize
	// device data. The list can be 2-25 PipelineActivity objects and must contain both
	// a channel and a datastore activity. Each entry in the list must contain only one
	// activity, for example: pipelineActivities = [ { "channel": { ... } }, {
	// "lambda": { ... } }, ... ]
	//
	// This member is required.
	PipelineActivities []*types.PipelineActivity
}

type UpdatePipelineOutput

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

Source Files

api_client.go api_op_BatchPutMessage.go api_op_CancelPipelineReprocessing.go api_op_CreateChannel.go api_op_CreateDataset.go api_op_CreateDatasetContent.go api_op_CreateDatastore.go api_op_CreatePipeline.go api_op_DeleteChannel.go api_op_DeleteDataset.go api_op_DeleteDatasetContent.go api_op_DeleteDatastore.go api_op_DeletePipeline.go api_op_DescribeChannel.go api_op_DescribeDataset.go api_op_DescribeDatastore.go api_op_DescribeLoggingOptions.go api_op_DescribePipeline.go api_op_GetDatasetContent.go api_op_ListChannels.go api_op_ListDatasetContents.go api_op_ListDatasets.go api_op_ListDatastores.go api_op_ListPipelines.go api_op_ListTagsForResource.go api_op_PutLoggingOptions.go api_op_RunPipelineActivity.go api_op_SampleChannelData.go api_op_StartPipelineReprocessing.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateChannel.go api_op_UpdateDataset.go api_op_UpdateDatastore.go api_op_UpdatePipeline.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.26.0
Published
Oct 1, 2020
Platform
darwin/amd64
Imports
27 packages
Last checked
now

Tools for package owners.