iotanalytics

package
v0.24.0 Latest Latest
Warning

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

Go to latest
Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 8

Documentation

Overview

Package iotanalytics provides the client and types for making API requests to AWS IoT Analytics.

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.

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.

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.

See https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27 for more information on this service.

See iotanalytics package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotanalytics/

Using the Client

To use AWS IoT Analytics with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Analytics client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotanalytics/#New

Index

Constants

View Source
const (
	ServiceName = "AWS IoT Analytics" // Service's name
	ServiceID   = "IoTAnalytics"      // Service's identifier
	EndpointsID = "iotanalytics"      // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// There was an internal failure.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request was not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The command caused an internal limit to be exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// A resource with the same name already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource with the specified name could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is temporarily unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddAttributesActivity

type AddAttributesActivity struct {

	// A list of 1-50 "AttributeNameMapping" objects that map an existing attribute
	// to a new attribute.
	//
	// The existing attributes remain in the message, so if you want to remove the
	// originals, use "RemoveAttributeActivity".
	//
	// Attributes is a required field
	Attributes map[string]string `locationName:"attributes" min:"1" type:"map" required:"true"`

	// The name of the 'addAttributes' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An activity that adds other attributes based on existing attributes in the message.

func (AddAttributesActivity) MarshalFields

func (s AddAttributesActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddAttributesActivity) String

func (s AddAttributesActivity) String() string

String returns the string representation

func (*AddAttributesActivity) Validate

func (s *AddAttributesActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutMessageErrorEntry

type BatchPutMessageErrorEntry struct {

	// The code associated with the error.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The message associated with the error.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The ID of the message that caused the error. (See the value corresponding
	// to the "messageId" key in the message object.)
	MessageId *string `locationName:"messageId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains informations about errors.

func (BatchPutMessageErrorEntry) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageErrorEntry) String

func (s BatchPutMessageErrorEntry) String() string

String returns the string representation

type BatchPutMessageInput

type BatchPutMessageInput struct {

	// The name of the channel where the messages are sent.
	//
	// ChannelName is a required field
	ChannelName *string `locationName:"channelName" min:"1" type:"string" required:"true"`

	// 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.
	//
	// Messages is a required field
	Messages []Message `locationName:"messages" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutMessageInput) MarshalFields

func (s BatchPutMessageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageInput) String

func (s BatchPutMessageInput) String() string

String returns the string representation

func (*BatchPutMessageInput) Validate

func (s *BatchPutMessageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutMessageOutput

type BatchPutMessageOutput struct {

	// A list of any errors encountered when sending the messages to the channel.
	BatchPutMessageErrorEntries []BatchPutMessageErrorEntry `locationName:"batchPutMessageErrorEntries" type:"list"`
	// contains filtered or unexported fields
}

func (BatchPutMessageOutput) MarshalFields

func (s BatchPutMessageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageOutput) String

func (s BatchPutMessageOutput) String() string

String returns the string representation

type BatchPutMessageRequest

type BatchPutMessageRequest struct {
	*aws.Request
	Input *BatchPutMessageInput
	Copy  func(*BatchPutMessageInput) BatchPutMessageRequest
}

BatchPutMessageRequest is the request type for the BatchPutMessage API operation.

func (BatchPutMessageRequest) Send

Send marshals and sends the BatchPutMessage API request.

type BatchPutMessageResponse added in v0.9.0

type BatchPutMessageResponse struct {
	*BatchPutMessageOutput
	// contains filtered or unexported fields
}

BatchPutMessageResponse is the response type for the BatchPutMessage API operation.

func (*BatchPutMessageResponse) SDKResponseMetdata added in v0.9.0

func (r *BatchPutMessageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchPutMessage request.

type CancelPipelineReprocessingInput

type CancelPipelineReprocessingInput struct {

	// The name of pipeline for which data reprocessing is canceled.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// The ID of the reprocessing task (returned by "StartPipelineReprocessing").
	//
	// ReprocessingId is a required field
	ReprocessingId *string `location:"uri" locationName:"reprocessingId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelPipelineReprocessingInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelPipelineReprocessingInput) String

String returns the string representation

func (*CancelPipelineReprocessingInput) Validate

func (s *CancelPipelineReprocessingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelPipelineReprocessingOutput

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

func (CancelPipelineReprocessingOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelPipelineReprocessingOutput) String

String returns the string representation

type CancelPipelineReprocessingRequest

type CancelPipelineReprocessingRequest struct {
	*aws.Request
	Input *CancelPipelineReprocessingInput
	Copy  func(*CancelPipelineReprocessingInput) CancelPipelineReprocessingRequest
}

CancelPipelineReprocessingRequest is the request type for the CancelPipelineReprocessing API operation.

func (CancelPipelineReprocessingRequest) Send

Send marshals and sends the CancelPipelineReprocessing API request.

type CancelPipelineReprocessingResponse added in v0.9.0

type CancelPipelineReprocessingResponse struct {
	*CancelPipelineReprocessingOutput
	// contains filtered or unexported fields
}

CancelPipelineReprocessingResponse is the response type for the CancelPipelineReprocessing API operation.

func (*CancelPipelineReprocessingResponse) SDKResponseMetdata added in v0.9.0

func (r *CancelPipelineReprocessingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelPipelineReprocessing request.

type Channel

type Channel struct {

	// The ARN of the channel.
	Arn *string `locationName:"arn" type:"string"`

	// When the channel was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// When the channel was last updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The name of the channel.
	Name *string `locationName:"name" min:"1" type:"string"`

	// How long, in days, message data is kept for the channel.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The status of the channel.
	Status ChannelStatus `locationName:"status" type:"string" enum:"true"`

	// 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.
	Storage *ChannelStorage `locationName:"storage" type:"structure"`
	// contains filtered or unexported fields
}

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

func (Channel) MarshalFields

func (s Channel) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Channel) String

func (s Channel) String() string

String returns the string representation

type ChannelActivity

type ChannelActivity struct {

	// The name of the channel from which the messages are processed.
	//
	// ChannelName is a required field
	ChannelName *string `locationName:"channelName" min:"1" type:"string" required:"true"`

	// The name of the 'channel' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The activity that determines the source of the messages to be processed.

func (ChannelActivity) MarshalFields

func (s ChannelActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelActivity) String

func (s ChannelActivity) String() string

String returns the string representation

func (*ChannelActivity) Validate

func (s *ChannelActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ChannelStatistics added in v0.5.0

type ChannelStatistics struct {

	// The estimated size of the channel.
	Size *EstimatedResourceSize `locationName:"size" type:"structure"`
	// contains filtered or unexported fields
}

Statistics information about the channel.

func (ChannelStatistics) MarshalFields added in v0.5.0

func (s ChannelStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelStatistics) String added in v0.5.0

func (s ChannelStatistics) String() string

String returns the string representation

type ChannelStatus

type ChannelStatus string
const (
	ChannelStatusCreating ChannelStatus = "CREATING"
	ChannelStatusActive   ChannelStatus = "ACTIVE"
	ChannelStatusDeleting ChannelStatus = "DELETING"
)

Enum values for ChannelStatus

func (ChannelStatus) MarshalValue

func (enum ChannelStatus) MarshalValue() (string, error)

func (ChannelStatus) MarshalValueBuf

func (enum ChannelStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ChannelStorage added in v0.10.0

type ChannelStorage struct {

	// Use this to store channel data in an S3 bucket that you manage. If customer
	// managed storage is selected, the "retentionPeriod" parameter is ignored.
	// The choice of service-managed or customer-managed S3 storage cannot be changed
	// after creation of the channel.
	CustomerManagedS3 *CustomerManagedChannelS3Storage `locationName:"customerManagedS3" type:"structure"`

	// Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics
	// service. The choice of service-managed or customer-managed S3 storage cannot
	// be changed after creation of the channel.
	ServiceManagedS3 *ServiceManagedChannelS3Storage `locationName:"serviceManagedS3" type:"structure"`
	// contains filtered or unexported fields
}

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.

func (ChannelStorage) MarshalFields added in v0.10.0

func (s ChannelStorage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelStorage) String added in v0.10.0

func (s ChannelStorage) String() string

String returns the string representation

func (*ChannelStorage) Validate added in v0.10.0

func (s *ChannelStorage) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ChannelStorageSummary added in v0.10.0

type ChannelStorageSummary struct {

	// Used to store channel data in an S3 bucket that you manage.
	CustomerManagedS3 *CustomerManagedChannelS3StorageSummary `locationName:"customerManagedS3" type:"structure"`

	// Used to store channel data in an S3 bucket managed by the AWS IoT Analytics
	// service.
	ServiceManagedS3 *ServiceManagedChannelS3StorageSummary `locationName:"serviceManagedS3" type:"structure"`
	// contains filtered or unexported fields
}

Where channel data is stored.

func (ChannelStorageSummary) MarshalFields added in v0.10.0

func (s ChannelStorageSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelStorageSummary) String added in v0.10.0

func (s ChannelStorageSummary) String() string

String returns the string representation

type ChannelSummary

type ChannelSummary struct {

	// The name of the channel.
	ChannelName *string `locationName:"channelName" min:"1" type:"string"`

	// Where channel data is stored.
	ChannelStorage *ChannelStorageSummary `locationName:"channelStorage" type:"structure"`

	// When the channel was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The last time the channel was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the channel.
	Status ChannelStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A summary of information about a channel.

func (ChannelSummary) MarshalFields

func (s ChannelSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelSummary) String

func (s ChannelSummary) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Analytics. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := iotanalytics.New(myConfig)

func (*Client) BatchPutMessageRequest added in v0.9.0

func (c *Client) BatchPutMessageRequest(input *BatchPutMessageInput) BatchPutMessageRequest

BatchPutMessageRequest returns a request value for making API operation for AWS IoT Analytics.

Sends messages to a channel.

// Example sending a request using BatchPutMessageRequest.
req := client.BatchPutMessageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/BatchPutMessage

func (*Client) CancelPipelineReprocessingRequest added in v0.9.0

func (c *Client) CancelPipelineReprocessingRequest(input *CancelPipelineReprocessingInput) CancelPipelineReprocessingRequest

CancelPipelineReprocessingRequest returns a request value for making API operation for AWS IoT Analytics.

Cancels the reprocessing of data through the pipeline.

// Example sending a request using CancelPipelineReprocessingRequest.
req := client.CancelPipelineReprocessingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CancelPipelineReprocessing

func (*Client) CreateChannelRequest added in v0.9.0

func (c *Client) CreateChannelRequest(input *CreateChannelInput) CreateChannelRequest

CreateChannelRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using CreateChannelRequest.
req := client.CreateChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CreateChannel

func (*Client) CreateDatasetContentRequest added in v0.9.0

func (c *Client) CreateDatasetContentRequest(input *CreateDatasetContentInput) CreateDatasetContentRequest

CreateDatasetContentRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using CreateDatasetContentRequest.
req := client.CreateDatasetContentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CreateDatasetContent

func (*Client) CreateDatasetRequest added in v0.9.0

func (c *Client) CreateDatasetRequest(input *CreateDatasetInput) CreateDatasetRequest

CreateDatasetRequest returns a request value for making API operation for AWS IoT Analytics.

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.

// Example sending a request using CreateDatasetRequest.
req := client.CreateDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CreateDataset

func (*Client) CreateDatastoreRequest added in v0.9.0

func (c *Client) CreateDatastoreRequest(input *CreateDatastoreInput) CreateDatastoreRequest

CreateDatastoreRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using CreateDatastoreRequest.
req := client.CreateDatastoreRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CreateDatastore

func (*Client) CreatePipelineRequest added in v0.9.0

func (c *Client) CreatePipelineRequest(input *CreatePipelineInput) CreatePipelineRequest

CreatePipelineRequest returns a request value for making API operation for AWS IoT Analytics.

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.

// Example sending a request using CreatePipelineRequest.
req := client.CreatePipelineRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/CreatePipeline

func (*Client) DeleteChannelRequest added in v0.9.0

func (c *Client) DeleteChannelRequest(input *DeleteChannelInput) DeleteChannelRequest

DeleteChannelRequest returns a request value for making API operation for AWS IoT Analytics.

Deletes the specified channel.

// Example sending a request using DeleteChannelRequest.
req := client.DeleteChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DeleteChannel

func (*Client) DeleteDatasetContentRequest added in v0.9.0

func (c *Client) DeleteDatasetContentRequest(input *DeleteDatasetContentInput) DeleteDatasetContentRequest

DeleteDatasetContentRequest returns a request value for making API operation for AWS IoT Analytics.

Deletes the content of the specified data set.

// Example sending a request using DeleteDatasetContentRequest.
req := client.DeleteDatasetContentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DeleteDatasetContent

func (*Client) DeleteDatasetRequest added in v0.9.0

func (c *Client) DeleteDatasetRequest(input *DeleteDatasetInput) DeleteDatasetRequest

DeleteDatasetRequest returns a request value for making API operation for AWS IoT Analytics.

Deletes the specified data set.

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

// Example sending a request using DeleteDatasetRequest.
req := client.DeleteDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DeleteDataset

func (*Client) DeleteDatastoreRequest added in v0.9.0

func (c *Client) DeleteDatastoreRequest(input *DeleteDatastoreInput) DeleteDatastoreRequest

DeleteDatastoreRequest returns a request value for making API operation for AWS IoT Analytics.

Deletes the specified data store.

// Example sending a request using DeleteDatastoreRequest.
req := client.DeleteDatastoreRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DeleteDatastore

func (*Client) DeletePipelineRequest added in v0.9.0

func (c *Client) DeletePipelineRequest(input *DeletePipelineInput) DeletePipelineRequest

DeletePipelineRequest returns a request value for making API operation for AWS IoT Analytics.

Deletes the specified pipeline.

// Example sending a request using DeletePipelineRequest.
req := client.DeletePipelineRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DeletePipeline

func (*Client) DescribeChannelRequest added in v0.9.0

func (c *Client) DescribeChannelRequest(input *DescribeChannelInput) DescribeChannelRequest

DescribeChannelRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves information about a channel.

// Example sending a request using DescribeChannelRequest.
req := client.DescribeChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DescribeChannel

func (*Client) DescribeDatasetRequest added in v0.9.0

func (c *Client) DescribeDatasetRequest(input *DescribeDatasetInput) DescribeDatasetRequest

DescribeDatasetRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves information about a data set.

// Example sending a request using DescribeDatasetRequest.
req := client.DescribeDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DescribeDataset

func (*Client) DescribeDatastoreRequest added in v0.9.0

func (c *Client) DescribeDatastoreRequest(input *DescribeDatastoreInput) DescribeDatastoreRequest

DescribeDatastoreRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves information about a data store.

// Example sending a request using DescribeDatastoreRequest.
req := client.DescribeDatastoreRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DescribeDatastore

func (*Client) DescribeLoggingOptionsRequest added in v0.9.0

func (c *Client) DescribeLoggingOptionsRequest(input *DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest

DescribeLoggingOptionsRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using DescribeLoggingOptionsRequest.
req := client.DescribeLoggingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DescribeLoggingOptions

func (*Client) DescribePipelineRequest added in v0.9.0

func (c *Client) DescribePipelineRequest(input *DescribePipelineInput) DescribePipelineRequest

DescribePipelineRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves information about a pipeline.

// Example sending a request using DescribePipelineRequest.
req := client.DescribePipelineRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/DescribePipeline

func (*Client) GetDatasetContentRequest added in v0.9.0

func (c *Client) GetDatasetContentRequest(input *GetDatasetContentInput) GetDatasetContentRequest

GetDatasetContentRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using GetDatasetContentRequest.
req := client.GetDatasetContentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/GetDatasetContent

func (*Client) ListChannelsRequest added in v0.9.0

func (c *Client) ListChannelsRequest(input *ListChannelsInput) ListChannelsRequest

ListChannelsRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves a list of channels.

// Example sending a request using ListChannelsRequest.
req := client.ListChannelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListChannels

func (*Client) ListDatasetContentsRequest added in v0.9.0

func (c *Client) ListDatasetContentsRequest(input *ListDatasetContentsInput) ListDatasetContentsRequest

ListDatasetContentsRequest returns a request value for making API operation for AWS IoT Analytics.

Lists information about data set contents that have been created.

// Example sending a request using ListDatasetContentsRequest.
req := client.ListDatasetContentsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListDatasetContents

func (*Client) ListDatasetsRequest added in v0.9.0

func (c *Client) ListDatasetsRequest(input *ListDatasetsInput) ListDatasetsRequest

ListDatasetsRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves information about data sets.

// Example sending a request using ListDatasetsRequest.
req := client.ListDatasetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListDatasets

func (*Client) ListDatastoresRequest added in v0.9.0

func (c *Client) ListDatastoresRequest(input *ListDatastoresInput) ListDatastoresRequest

ListDatastoresRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves a list of data stores.

// Example sending a request using ListDatastoresRequest.
req := client.ListDatastoresRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListDatastores

func (*Client) ListPipelinesRequest added in v0.9.0

func (c *Client) ListPipelinesRequest(input *ListPipelinesInput) ListPipelinesRequest

ListPipelinesRequest returns a request value for making API operation for AWS IoT Analytics.

Retrieves a list of pipelines.

// Example sending a request using ListPipelinesRequest.
req := client.ListPipelinesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListPipelines

func (*Client) ListTagsForResourceRequest added in v0.9.0

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListTagsForResource

func (*Client) PutLoggingOptionsRequest added in v0.9.0

func (c *Client) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) PutLoggingOptionsRequest

PutLoggingOptionsRequest returns a request value for making API operation for AWS IoT Analytics.

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.

// Example sending a request using PutLoggingOptionsRequest.
req := client.PutLoggingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/PutLoggingOptions

func (*Client) RunPipelineActivityRequest added in v0.9.0

func (c *Client) RunPipelineActivityRequest(input *RunPipelineActivityInput) RunPipelineActivityRequest

RunPipelineActivityRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using RunPipelineActivityRequest.
req := client.RunPipelineActivityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/RunPipelineActivity

func (*Client) SampleChannelDataRequest added in v0.9.0

func (c *Client) SampleChannelDataRequest(input *SampleChannelDataInput) SampleChannelDataRequest

SampleChannelDataRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using SampleChannelDataRequest.
req := client.SampleChannelDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/SampleChannelData

func (*Client) StartPipelineReprocessingRequest added in v0.9.0

func (c *Client) StartPipelineReprocessingRequest(input *StartPipelineReprocessingInput) StartPipelineReprocessingRequest

StartPipelineReprocessingRequest returns a request value for making API operation for AWS IoT Analytics.

Starts the reprocessing of raw message data through the pipeline.

// Example sending a request using StartPipelineReprocessingRequest.
req := client.StartPipelineReprocessingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/StartPipelineReprocessing

func (*Client) TagResourceRequest added in v0.9.0

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS IoT Analytics.

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

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/TagResource

func (*Client) UntagResourceRequest added in v0.9.0

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS IoT Analytics.

Removes the given tags (metadata) from the resource.

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/UntagResource

func (*Client) UpdateChannelRequest added in v0.9.0

func (c *Client) UpdateChannelRequest(input *UpdateChannelInput) UpdateChannelRequest

UpdateChannelRequest returns a request value for making API operation for AWS IoT Analytics.

Updates the settings of a channel.

// Example sending a request using UpdateChannelRequest.
req := client.UpdateChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/UpdateChannel

func (*Client) UpdateDatasetRequest added in v0.9.0

func (c *Client) UpdateDatasetRequest(input *UpdateDatasetInput) UpdateDatasetRequest

UpdateDatasetRequest returns a request value for making API operation for AWS IoT Analytics.

Updates the settings of a data set.

// Example sending a request using UpdateDatasetRequest.
req := client.UpdateDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/UpdateDataset

func (*Client) UpdateDatastoreRequest added in v0.9.0

func (c *Client) UpdateDatastoreRequest(input *UpdateDatastoreInput) UpdateDatastoreRequest

UpdateDatastoreRequest returns a request value for making API operation for AWS IoT Analytics.

Updates the settings of a data store.

// Example sending a request using UpdateDatastoreRequest.
req := client.UpdateDatastoreRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/UpdateDatastore

func (*Client) UpdatePipelineRequest added in v0.9.0

func (c *Client) UpdatePipelineRequest(input *UpdatePipelineInput) UpdatePipelineRequest

UpdatePipelineRequest returns a request value for making API operation for AWS IoT Analytics.

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.

// Example sending a request using UpdatePipelineRequest.
req := client.UpdatePipelineRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/UpdatePipeline

type ComputeType added in v0.5.0

type ComputeType string
const (
	ComputeTypeAcu1 ComputeType = "ACU_1"
	ComputeTypeAcu2 ComputeType = "ACU_2"
)

Enum values for ComputeType

func (ComputeType) MarshalValue added in v0.5.0

func (enum ComputeType) MarshalValue() (string, error)

func (ComputeType) MarshalValueBuf added in v0.5.0

func (enum ComputeType) MarshalValueBuf(b []byte) ([]byte, error)

type ContainerDatasetAction added in v0.5.0

type ContainerDatasetAction struct {

	// The ARN of the role which gives permission to the system to access needed
	// resources in order to run the "containerAction". This includes, at minimum,
	// permission to retrieve the data set contents which are the input to the containerized
	// application.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" min:"20" type:"string" required:"true"`

	// The ARN of the Docker container stored in your account. The Docker container
	// contains an application and needed support libraries and is used to generate
	// data set contents.
	//
	// Image is a required field
	Image *string `locationName:"image" type:"string" required:"true"`

	// Configuration of the resource which executes the "containerAction".
	//
	// ResourceConfiguration is a required field
	ResourceConfiguration *ResourceConfiguration `locationName:"resourceConfiguration" type:"structure" required:"true"`

	// The values of variables used within the context of the execution of the containerized
	// application (basically, parameters passed to the application). Each variable
	// must have a name and a value given by one of "stringValue", "datasetContentVersionValue",
	// or "outputFileUriValue".
	Variables []Variable `locationName:"variables" type:"list"`
	// contains filtered or unexported fields
}

Information needed to run the "containerAction" to produce data set contents.

func (ContainerDatasetAction) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ContainerDatasetAction) String added in v0.5.0

func (s ContainerDatasetAction) String() string

String returns the string representation

func (*ContainerDatasetAction) Validate added in v0.5.0

func (s *ContainerDatasetAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateChannelInput

type CreateChannelInput struct {

	// The name of the channel.
	//
	// ChannelName is a required field
	ChannelName *string `locationName:"channelName" min:"1" type:"string" required:"true"`

	// 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 *ChannelStorage `locationName:"channelStorage" type:"structure"`

	// How long, in days, message data is kept for the channel. When "customerManagedS3"
	// storage is selected, this parameter is ignored.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// Metadata which can be used to manage the channel.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateChannelInput) MarshalFields

func (s CreateChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateChannelInput) String

func (s CreateChannelInput) String() string

String returns the string representation

func (*CreateChannelInput) Validate

func (s *CreateChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateChannelOutput

type CreateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string `locationName:"channelArn" type:"string"`

	// The name of the channel.
	ChannelName *string `locationName:"channelName" min:"1" type:"string"`

	// How long, in days, message data is kept for the channel.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateChannelOutput) MarshalFields

func (s CreateChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateChannelOutput) String

func (s CreateChannelOutput) String() string

String returns the string representation

type CreateChannelRequest

type CreateChannelRequest struct {
	*aws.Request
	Input *CreateChannelInput
	Copy  func(*CreateChannelInput) CreateChannelRequest
}

CreateChannelRequest is the request type for the CreateChannel API operation.

func (CreateChannelRequest) Send

Send marshals and sends the CreateChannel API request.

type CreateChannelResponse added in v0.9.0

type CreateChannelResponse struct {
	*CreateChannelOutput
	// contains filtered or unexported fields
}

CreateChannelResponse is the response type for the CreateChannel API operation.

func (*CreateChannelResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateChannel request.

type CreateDatasetContentInput

type CreateDatasetContentInput struct {

	// The name of the data set.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDatasetContentInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatasetContentInput) String

func (s CreateDatasetContentInput) String() string

String returns the string representation

func (*CreateDatasetContentInput) Validate

func (s *CreateDatasetContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetContentOutput

type CreateDatasetContentOutput struct {

	// The version ID of the data set contents which are being created.
	VersionId *string `locationName:"versionId" min:"7" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetContentOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatasetContentOutput) String

String returns the string representation

type CreateDatasetContentRequest

type CreateDatasetContentRequest struct {
	*aws.Request
	Input *CreateDatasetContentInput
	Copy  func(*CreateDatasetContentInput) CreateDatasetContentRequest
}

CreateDatasetContentRequest is the request type for the CreateDatasetContent API operation.

func (CreateDatasetContentRequest) Send

Send marshals and sends the CreateDatasetContent API request.

type CreateDatasetContentResponse added in v0.9.0

type CreateDatasetContentResponse struct {
	*CreateDatasetContentOutput
	// contains filtered or unexported fields
}

CreateDatasetContentResponse is the response type for the CreateDatasetContent API operation.

func (*CreateDatasetContentResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateDatasetContentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDatasetContent request.

type CreateDatasetInput

type CreateDatasetInput struct {

	// A list of actions that create the data set contents.
	//
	// Actions is a required field
	Actions []DatasetAction `locationName:"actions" min:"1" type:"list" required:"true"`

	// When data set contents are created they are delivered to destinations specified
	// here.
	ContentDeliveryRules []DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`

	// The name of the data set.
	//
	// DatasetName is a required field
	DatasetName *string `locationName:"datasetName" min:"1" type:"string" required:"true"`

	// [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 *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// Metadata which can be used to manage the data set.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`

	// 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 []DatasetTrigger `locationName:"triggers" type:"list"`

	// [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 *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDatasetInput) MarshalFields

func (s CreateDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatasetInput) String

func (s CreateDatasetInput) String() string

String returns the string representation

func (*CreateDatasetInput) Validate

func (s *CreateDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetOutput

type CreateDatasetOutput struct {

	// The ARN of the data set.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// The name of the data set.
	DatasetName *string `locationName:"datasetName" min:"1" type:"string"`

	// How long, in days, data set contents are kept for the data set.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDatasetOutput) MarshalFields

func (s CreateDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatasetOutput) String

func (s CreateDatasetOutput) String() string

String returns the string representation

type CreateDatasetRequest

type CreateDatasetRequest struct {
	*aws.Request
	Input *CreateDatasetInput
	Copy  func(*CreateDatasetInput) CreateDatasetRequest
}

CreateDatasetRequest is the request type for the CreateDataset API operation.

func (CreateDatasetRequest) Send

Send marshals and sends the CreateDataset API request.

type CreateDatasetResponse added in v0.9.0

type CreateDatasetResponse struct {
	*CreateDatasetOutput
	// contains filtered or unexported fields
}

CreateDatasetResponse is the response type for the CreateDataset API operation.

func (*CreateDatasetResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDataset request.

type CreateDatastoreInput

type CreateDatastoreInput struct {

	// The name of the data store.
	//
	// DatastoreName is a required field
	DatastoreName *string `locationName:"datastoreName" min:"1" type:"string" required:"true"`

	// 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 *DatastoreStorage `locationName:"datastoreStorage" type:"structure"`

	// How long, in days, message data is kept for the data store. When "customerManagedS3"
	// storage is selected, this parameter is ignored.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// Metadata which can be used to manage the data store.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDatastoreInput) MarshalFields

func (s CreateDatastoreInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatastoreInput) String

func (s CreateDatastoreInput) String() string

String returns the string representation

func (*CreateDatastoreInput) Validate

func (s *CreateDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatastoreOutput

type CreateDatastoreOutput struct {

	// The ARN of the data store.
	DatastoreArn *string `locationName:"datastoreArn" type:"string"`

	// The name of the data store.
	DatastoreName *string `locationName:"datastoreName" min:"1" type:"string"`

	// How long, in days, message data is kept for the data store.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDatastoreOutput) MarshalFields

func (s CreateDatastoreOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDatastoreOutput) String

func (s CreateDatastoreOutput) String() string

String returns the string representation

type CreateDatastoreRequest

type CreateDatastoreRequest struct {
	*aws.Request
	Input *CreateDatastoreInput
	Copy  func(*CreateDatastoreInput) CreateDatastoreRequest
}

CreateDatastoreRequest is the request type for the CreateDatastore API operation.

func (CreateDatastoreRequest) Send

Send marshals and sends the CreateDatastore API request.

type CreateDatastoreResponse added in v0.9.0

type CreateDatastoreResponse struct {
	*CreateDatastoreOutput
	// contains filtered or unexported fields
}

CreateDatastoreResponse is the response type for the CreateDatastore API operation.

func (*CreateDatastoreResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateDatastoreResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDatastore request.

type CreatePipelineInput

type CreatePipelineInput struct {

	// 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": { ... } }, ...
	// ]
	//
	// PipelineActivities is a required field
	PipelineActivities []PipelineActivity `locationName:"pipelineActivities" min:"1" type:"list" required:"true"`

	// The name of the pipeline.
	//
	// PipelineName is a required field
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// Metadata which can be used to manage the pipeline.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreatePipelineInput) MarshalFields

func (s CreatePipelineInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePipelineInput) String

func (s CreatePipelineInput) String() string

String returns the string representation

func (*CreatePipelineInput) Validate

func (s *CreatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePipelineOutput

type CreatePipelineOutput struct {

	// The ARN of the pipeline.
	PipelineArn *string `locationName:"pipelineArn" type:"string"`

	// The name of the pipeline.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePipelineOutput) MarshalFields

func (s CreatePipelineOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePipelineOutput) String

func (s CreatePipelineOutput) String() string

String returns the string representation

type CreatePipelineRequest

type CreatePipelineRequest struct {
	*aws.Request
	Input *CreatePipelineInput
	Copy  func(*CreatePipelineInput) CreatePipelineRequest
}

CreatePipelineRequest is the request type for the CreatePipeline API operation.

func (CreatePipelineRequest) Send

Send marshals and sends the CreatePipeline API request.

type CreatePipelineResponse added in v0.9.0

type CreatePipelineResponse struct {
	*CreatePipelineOutput
	// contains filtered or unexported fields
}

CreatePipelineResponse is the response type for the CreatePipeline API operation.

func (*CreatePipelineResponse) SDKResponseMetdata added in v0.9.0

func (r *CreatePipelineResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreatePipeline request.

type CustomerManagedChannelS3Storage added in v0.10.0

type CustomerManagedChannelS3Storage struct {

	// The name of the Amazon S3 bucket in which channel data is stored.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// [Optional] The prefix used to create the keys of the channel data objects.
	// Each object in an Amazon S3 bucket has a key that is its unique identifier
	// within the bucket (each object in a bucket has exactly one key). The prefix
	// must end with a '/'.
	KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`

	// The ARN of the role which grants AWS IoT Analytics permission to interact
	// with your Amazon S3 resources.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

func (CustomerManagedChannelS3Storage) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CustomerManagedChannelS3Storage) String added in v0.10.0

String returns the string representation

func (*CustomerManagedChannelS3Storage) Validate added in v0.10.0

func (s *CustomerManagedChannelS3Storage) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CustomerManagedChannelS3StorageSummary added in v0.10.0

type CustomerManagedChannelS3StorageSummary struct {

	// The name of the Amazon S3 bucket in which channel data is stored.
	Bucket *string `locationName:"bucket" min:"3" type:"string"`

	// [Optional] The prefix used to create the keys of the channel data objects.
	// Each object in an Amazon S3 bucket has a key that is its unique identifier
	// within the bucket (each object in a bucket has exactly one key). The prefix
	// must end with a '/'.
	KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`

	// The ARN of the role which grants AWS IoT Analytics permission to interact
	// with your Amazon S3 resources.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Used to store channel data in an S3 bucket that you manage.

func (CustomerManagedChannelS3StorageSummary) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CustomerManagedChannelS3StorageSummary) String added in v0.10.0

String returns the string representation

type CustomerManagedDatastoreS3Storage added in v0.10.0

type CustomerManagedDatastoreS3Storage struct {

	// The name of the Amazon S3 bucket in which data store data is stored.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// [Optional] The prefix used to create the keys of the data store data objects.
	// Each object in an Amazon S3 bucket has a key that is its unique identifier
	// within the bucket (each object in a bucket has exactly one key). The prefix
	// must end with a '/'.
	KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`

	// The ARN of the role which grants AWS IoT Analytics permission to interact
	// with your Amazon S3 resources.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

func (CustomerManagedDatastoreS3Storage) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CustomerManagedDatastoreS3Storage) String added in v0.10.0

String returns the string representation

func (*CustomerManagedDatastoreS3Storage) Validate added in v0.10.0

Validate inspects the fields of the type to determine if they are valid.

type CustomerManagedDatastoreS3StorageSummary added in v0.10.0

type CustomerManagedDatastoreS3StorageSummary struct {

	// The name of the Amazon S3 bucket in which data store data is stored.
	Bucket *string `locationName:"bucket" min:"3" type:"string"`

	// [Optional] The prefix used to create the keys of the data store data objects.
	// Each object in an Amazon S3 bucket has a key that is its unique identifier
	// within the bucket (each object in a bucket has exactly one key). The prefix
	// must end with a '/'.
	KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`

	// The ARN of the role which grants AWS IoT Analytics permission to interact
	// with your Amazon S3 resources.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Used to store data store data in an S3 bucket that you manage.

func (CustomerManagedDatastoreS3StorageSummary) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CustomerManagedDatastoreS3StorageSummary) String added in v0.10.0

String returns the string representation

type Dataset

type Dataset struct {

	// The "DatasetAction" objects that automatically create the data set contents.
	Actions []DatasetAction `locationName:"actions" min:"1" type:"list"`

	// The ARN of the data set.
	Arn *string `locationName:"arn" type:"string"`

	// When data set contents are created they are delivered to destinations specified
	// here.
	ContentDeliveryRules []DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`

	// When the data set was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The last time the data set was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The name of the data set.
	Name *string `locationName:"name" min:"1" type:"string"`

	// [Optional] How long, in days, message data is kept for the data set.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The status of the data set.
	Status DatasetStatus `locationName:"status" type:"string" enum:"true"`

	// The "DatasetTrigger" objects that specify when the data set is automatically
	// updated.
	Triggers []DatasetTrigger `locationName:"triggers" type:"list"`

	// [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 *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Information about a data set.

func (Dataset) MarshalFields

func (s Dataset) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Dataset) String

func (s Dataset) String() string

String returns the string representation

type DatasetAction

type DatasetAction struct {

	// The name of the data set action by which data set contents are automatically
	// created.
	ActionName *string `locationName:"actionName" min:"1" type:"string"`

	// Information which allows the system to run a containerized application in
	// order to create the data set contents. The application must be in a Docker
	// container along with any needed support libraries.
	ContainerAction *ContainerDatasetAction `locationName:"containerAction" type:"structure"`

	// An "SqlQueryDatasetAction" object that uses an SQL query to automatically
	// create data set contents.
	QueryAction *SqlQueryDatasetAction `locationName:"queryAction" type:"structure"`
	// contains filtered or unexported fields
}

A "DatasetAction" object that specifies how data set contents are automatically created.

func (DatasetAction) MarshalFields

func (s DatasetAction) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetAction) String

func (s DatasetAction) String() string

String returns the string representation

func (*DatasetAction) Validate

func (s *DatasetAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetActionSummary added in v0.5.0

type DatasetActionSummary struct {

	// The name of the action which automatically creates the data set's contents.
	ActionName *string `locationName:"actionName" min:"1" type:"string"`

	// The type of action by which the data set's contents are automatically created.
	ActionType DatasetActionType `locationName:"actionType" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about the action which automatically creates the data set's contents.

func (DatasetActionSummary) MarshalFields added in v0.5.0

func (s DatasetActionSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetActionSummary) String added in v0.5.0

func (s DatasetActionSummary) String() string

String returns the string representation

type DatasetActionType added in v0.5.0

type DatasetActionType string
const (
	DatasetActionTypeQuery     DatasetActionType = "QUERY"
	DatasetActionTypeContainer DatasetActionType = "CONTAINER"
)

Enum values for DatasetActionType

func (DatasetActionType) MarshalValue added in v0.5.0

func (enum DatasetActionType) MarshalValue() (string, error)

func (DatasetActionType) MarshalValueBuf added in v0.5.0

func (enum DatasetActionType) MarshalValueBuf(b []byte) ([]byte, error)

type DatasetContentDeliveryDestination added in v0.6.0

type DatasetContentDeliveryDestination struct {

	// Configuration information for delivery of data set contents to AWS IoT Events.
	IotEventsDestinationConfiguration *IotEventsDestinationConfiguration `locationName:"iotEventsDestinationConfiguration" type:"structure"`

	// Configuration information for delivery of data set contents to Amazon S3.
	S3DestinationConfiguration *S3DestinationConfiguration `locationName:"s3DestinationConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The destination to which data set contents are delivered.

func (DatasetContentDeliveryDestination) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetContentDeliveryDestination) String added in v0.6.0

String returns the string representation

func (*DatasetContentDeliveryDestination) Validate added in v0.6.0

Validate inspects the fields of the type to determine if they are valid.

type DatasetContentDeliveryRule added in v0.6.0

type DatasetContentDeliveryRule struct {

	// The destination to which data set contents are delivered.
	//
	// Destination is a required field
	Destination *DatasetContentDeliveryDestination `locationName:"destination" type:"structure" required:"true"`

	// The name of the data set content delivery rules entry.
	EntryName *string `locationName:"entryName" type:"string"`
	// contains filtered or unexported fields
}

When data set contents are created they are delivered to destination specified here.

func (DatasetContentDeliveryRule) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetContentDeliveryRule) String added in v0.6.0

String returns the string representation

func (*DatasetContentDeliveryRule) Validate added in v0.6.0

func (s *DatasetContentDeliveryRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetContentState

type DatasetContentState string
const (
	DatasetContentStateCreating  DatasetContentState = "CREATING"
	DatasetContentStateSucceeded DatasetContentState = "SUCCEEDED"
	DatasetContentStateFailed    DatasetContentState = "FAILED"
)

Enum values for DatasetContentState

func (DatasetContentState) MarshalValue

func (enum DatasetContentState) MarshalValue() (string, error)

func (DatasetContentState) MarshalValueBuf

func (enum DatasetContentState) MarshalValueBuf(b []byte) ([]byte, error)

type DatasetContentStatus

type DatasetContentStatus struct {

	// The reason the data set contents are in this state.
	Reason *string `locationName:"reason" type:"string"`

	// The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED"
	// or "FAILED".
	State DatasetContentState `locationName:"state" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The state of the data set contents and the reason they are in this state.

func (DatasetContentStatus) MarshalFields

func (s DatasetContentStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetContentStatus) String

func (s DatasetContentStatus) String() string

String returns the string representation

type DatasetContentSummary added in v0.5.0

type DatasetContentSummary struct {

	// The time the dataset content status was updated to SUCCEEDED or FAILED.
	CompletionTime *time.Time `locationName:"completionTime" type:"timestamp"`

	// The actual time the creation of the data set contents was started.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The time the creation of the data set contents was scheduled to start.
	ScheduleTime *time.Time `locationName:"scheduleTime" type:"timestamp"`

	// The status of the data set contents.
	Status *DatasetContentStatus `locationName:"status" type:"structure"`

	// The version of the data set contents.
	Version *string `locationName:"version" min:"7" type:"string"`
	// contains filtered or unexported fields
}

Summary information about data set contents.

func (DatasetContentSummary) MarshalFields added in v0.5.0

func (s DatasetContentSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetContentSummary) String added in v0.5.0

func (s DatasetContentSummary) String() string

String returns the string representation

type DatasetContentVersionValue added in v0.5.0

type DatasetContentVersionValue struct {

	// The name of the data set whose latest contents are used as input to the notebook
	// or application.
	//
	// DatasetName is a required field
	DatasetName *string `locationName:"datasetName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The data set whose latest contents are used as input to the notebook or application.

func (DatasetContentVersionValue) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetContentVersionValue) String added in v0.5.0

String returns the string representation

func (*DatasetContentVersionValue) Validate added in v0.5.0

func (s *DatasetContentVersionValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetEntry

type DatasetEntry struct {

	// The pre-signed URI of the data set item.
	DataURI *string `locationName:"dataURI" type:"string"`

	// The name of the data set item.
	EntryName *string `locationName:"entryName" type:"string"`
	// contains filtered or unexported fields
}

The reference to a data set entry.

func (DatasetEntry) MarshalFields

func (s DatasetEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetEntry) String

func (s DatasetEntry) String() string

String returns the string representation

type DatasetStatus

type DatasetStatus string
const (
	DatasetStatusCreating DatasetStatus = "CREATING"
	DatasetStatusActive   DatasetStatus = "ACTIVE"
	DatasetStatusDeleting DatasetStatus = "DELETING"
)

Enum values for DatasetStatus

func (DatasetStatus) MarshalValue

func (enum DatasetStatus) MarshalValue() (string, error)

func (DatasetStatus) MarshalValueBuf

func (enum DatasetStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DatasetSummary

type DatasetSummary struct {

	// A list of "DataActionSummary" objects.
	Actions []DatasetActionSummary `locationName:"actions" min:"1" type:"list"`

	// The time the data set was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The name of the data set.
	DatasetName *string `locationName:"datasetName" min:"1" type:"string"`

	// The last time the data set was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the data set.
	Status DatasetStatus `locationName:"status" type:"string" enum:"true"`

	// A list of triggers. A trigger causes data set content to be populated at
	// a specified time interval or when another data set is populated. The list
	// of triggers can be empty or contain up to five DataSetTrigger objects
	Triggers []DatasetTrigger `locationName:"triggers" type:"list"`
	// contains filtered or unexported fields
}

A summary of information about a data set.

func (DatasetSummary) MarshalFields

func (s DatasetSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetSummary) String

func (s DatasetSummary) String() string

String returns the string representation

type DatasetTrigger

type DatasetTrigger struct {

	// The data set whose content creation triggers the creation of this data set's
	// contents.
	Dataset *TriggeringDataset `locationName:"dataset" type:"structure"`

	// The "Schedule" when the trigger is initiated.
	Schedule *Schedule `locationName:"schedule" type:"structure"`
	// contains filtered or unexported fields
}

The "DatasetTrigger" that specifies when the data set is automatically updated.

func (DatasetTrigger) MarshalFields

func (s DatasetTrigger) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatasetTrigger) String

func (s DatasetTrigger) String() string

String returns the string representation

func (*DatasetTrigger) Validate added in v0.5.0

func (s *DatasetTrigger) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Datastore

type Datastore struct {

	// The ARN of the data store.
	Arn *string `locationName:"arn" type:"string"`

	// When the data store was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The last time the data store was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The name of the data store.
	Name *string `locationName:"name" min:"1" type:"string"`

	// How long, in days, message data is kept for the data store. When "customerManagedS3"
	// storage is selected, this parameter is ignored.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The status of a data store:
	//
	// CREATING
	//
	// The data store is being created.
	//
	// ACTIVE
	//
	// The data store has been created and can be used.
	//
	// DELETING
	//
	// The data store is being deleted.
	Status DatastoreStatus `locationName:"status" type:"string" enum:"true"`

	// 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.
	Storage *DatastoreStorage `locationName:"storage" type:"structure"`
	// contains filtered or unexported fields
}

Information about a data store.

func (Datastore) MarshalFields

func (s Datastore) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Datastore) String

func (s Datastore) String() string

String returns the string representation

type DatastoreActivity

type DatastoreActivity struct {

	// The name of the data store where processed messages are stored.
	//
	// DatastoreName is a required field
	DatastoreName *string `locationName:"datastoreName" min:"1" type:"string" required:"true"`

	// The name of the 'datastore' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The 'datastore' activity that specifies where to store the processed data.

func (DatastoreActivity) MarshalFields

func (s DatastoreActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatastoreActivity) String

func (s DatastoreActivity) String() string

String returns the string representation

func (*DatastoreActivity) Validate

func (s *DatastoreActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatastoreStatistics added in v0.5.0

type DatastoreStatistics struct {

	// The estimated size of the data store.
	Size *EstimatedResourceSize `locationName:"size" type:"structure"`
	// contains filtered or unexported fields
}

Statistical information about the data store.

func (DatastoreStatistics) MarshalFields added in v0.5.0

func (s DatastoreStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatastoreStatistics) String added in v0.5.0

func (s DatastoreStatistics) String() string

String returns the string representation

type DatastoreStatus

type DatastoreStatus string
const (
	DatastoreStatusCreating DatastoreStatus = "CREATING"
	DatastoreStatusActive   DatastoreStatus = "ACTIVE"
	DatastoreStatusDeleting DatastoreStatus = "DELETING"
)

Enum values for DatastoreStatus

func (DatastoreStatus) MarshalValue

func (enum DatastoreStatus) MarshalValue() (string, error)

func (DatastoreStatus) MarshalValueBuf

func (enum DatastoreStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DatastoreStorage added in v0.10.0

type DatastoreStorage struct {

	// Use this to store data store data in an S3 bucket that you manage. When customer
	// managed storage is selected, the "retentionPeriod" parameter is ignored.
	// The choice of service-managed or customer-managed S3 storage cannot be changed
	// after creation of the data store.
	CustomerManagedS3 *CustomerManagedDatastoreS3Storage `locationName:"customerManagedS3" type:"structure"`

	// Use this to store data store data in an S3 bucket managed by the AWS IoT
	// Analytics service. The choice of service-managed or customer-managed S3 storage
	// cannot be changed after creation of the data store.
	ServiceManagedS3 *ServiceManagedDatastoreS3Storage `locationName:"serviceManagedS3" type:"structure"`
	// contains filtered or unexported fields
}

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.

func (DatastoreStorage) MarshalFields added in v0.10.0

func (s DatastoreStorage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatastoreStorage) String added in v0.10.0

func (s DatastoreStorage) String() string

String returns the string representation

func (*DatastoreStorage) Validate added in v0.10.0

func (s *DatastoreStorage) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatastoreStorageSummary added in v0.10.0

type DatastoreStorageSummary struct {

	// Used to store data store data in an S3 bucket that you manage.
	CustomerManagedS3 *CustomerManagedDatastoreS3StorageSummary `locationName:"customerManagedS3" type:"structure"`

	// Used to store data store data in an S3 bucket managed by the AWS IoT Analytics
	// service.
	ServiceManagedS3 *ServiceManagedDatastoreS3StorageSummary `locationName:"serviceManagedS3" type:"structure"`
	// contains filtered or unexported fields
}

Where data store data is stored.

func (DatastoreStorageSummary) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatastoreStorageSummary) String added in v0.10.0

func (s DatastoreStorageSummary) String() string

String returns the string representation

type DatastoreSummary

type DatastoreSummary struct {

	// When the data store was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The name of the data store.
	DatastoreName *string `locationName:"datastoreName" min:"1" type:"string"`

	// Where data store data is stored.
	DatastoreStorage *DatastoreStorageSummary `locationName:"datastoreStorage" type:"structure"`

	// The last time the data store was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the data store.
	Status DatastoreStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A summary of information about a data store.

func (DatastoreSummary) MarshalFields

func (s DatastoreSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DatastoreSummary) String

func (s DatastoreSummary) String() string

String returns the string representation

type DeleteChannelInput

type DeleteChannelInput struct {

	// The name of the channel to delete.
	//
	// ChannelName is a required field
	ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChannelInput) MarshalFields

func (s DeleteChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteChannelInput) String

func (s DeleteChannelInput) String() string

String returns the string representation

func (*DeleteChannelInput) Validate

func (s *DeleteChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteChannelOutput

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

func (DeleteChannelOutput) MarshalFields

func (s DeleteChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteChannelOutput) String

func (s DeleteChannelOutput) String() string

String returns the string representation

type DeleteChannelRequest

type DeleteChannelRequest struct {
	*aws.Request
	Input *DeleteChannelInput
	Copy  func(*DeleteChannelInput) DeleteChannelRequest
}

DeleteChannelRequest is the request type for the DeleteChannel API operation.

func (DeleteChannelRequest) Send

Send marshals and sends the DeleteChannel API request.

type DeleteChannelResponse added in v0.9.0

type DeleteChannelResponse struct {
	*DeleteChannelOutput
	// contains filtered or unexported fields
}

DeleteChannelResponse is the response type for the DeleteChannel API operation.

func (*DeleteChannelResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteChannel request.

type DeleteDatasetContentInput

type DeleteDatasetContentInput struct {

	// The name of the data set whose content is deleted.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"versionId" min:"7" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteDatasetContentInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatasetContentInput) String

func (s DeleteDatasetContentInput) String() string

String returns the string representation

func (*DeleteDatasetContentInput) Validate

func (s *DeleteDatasetContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetContentOutput

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

func (DeleteDatasetContentOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatasetContentOutput) String

String returns the string representation

type DeleteDatasetContentRequest

type DeleteDatasetContentRequest struct {
	*aws.Request
	Input *DeleteDatasetContentInput
	Copy  func(*DeleteDatasetContentInput) DeleteDatasetContentRequest
}

DeleteDatasetContentRequest is the request type for the DeleteDatasetContent API operation.

func (DeleteDatasetContentRequest) Send

Send marshals and sends the DeleteDatasetContent API request.

type DeleteDatasetContentResponse added in v0.9.0

type DeleteDatasetContentResponse struct {
	*DeleteDatasetContentOutput
	// contains filtered or unexported fields
}

DeleteDatasetContentResponse is the response type for the DeleteDatasetContent API operation.

func (*DeleteDatasetContentResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteDatasetContentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDatasetContent request.

type DeleteDatasetInput

type DeleteDatasetInput struct {

	// The name of the data set to delete.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetInput) MarshalFields

func (s DeleteDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatasetInput) String

func (s DeleteDatasetInput) String() string

String returns the string representation

func (*DeleteDatasetInput) Validate

func (s *DeleteDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetOutput

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

func (DeleteDatasetOutput) MarshalFields

func (s DeleteDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatasetOutput) String

func (s DeleteDatasetOutput) String() string

String returns the string representation

type DeleteDatasetRequest

type DeleteDatasetRequest struct {
	*aws.Request
	Input *DeleteDatasetInput
	Copy  func(*DeleteDatasetInput) DeleteDatasetRequest
}

DeleteDatasetRequest is the request type for the DeleteDataset API operation.

func (DeleteDatasetRequest) Send

Send marshals and sends the DeleteDataset API request.

type DeleteDatasetResponse added in v0.9.0

type DeleteDatasetResponse struct {
	*DeleteDatasetOutput
	// contains filtered or unexported fields
}

DeleteDatasetResponse is the response type for the DeleteDataset API operation.

func (*DeleteDatasetResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDataset request.

type DeleteDatastoreInput

type DeleteDatastoreInput struct {

	// The name of the data store to delete.
	//
	// DatastoreName is a required field
	DatastoreName *string `location:"uri" locationName:"datastoreName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatastoreInput) MarshalFields

func (s DeleteDatastoreInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatastoreInput) String

func (s DeleteDatastoreInput) String() string

String returns the string representation

func (*DeleteDatastoreInput) Validate

func (s *DeleteDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatastoreOutput

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

func (DeleteDatastoreOutput) MarshalFields

func (s DeleteDatastoreOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDatastoreOutput) String

func (s DeleteDatastoreOutput) String() string

String returns the string representation

type DeleteDatastoreRequest

type DeleteDatastoreRequest struct {
	*aws.Request
	Input *DeleteDatastoreInput
	Copy  func(*DeleteDatastoreInput) DeleteDatastoreRequest
}

DeleteDatastoreRequest is the request type for the DeleteDatastore API operation.

func (DeleteDatastoreRequest) Send

Send marshals and sends the DeleteDatastore API request.

type DeleteDatastoreResponse added in v0.9.0

type DeleteDatastoreResponse struct {
	*DeleteDatastoreOutput
	// contains filtered or unexported fields
}

DeleteDatastoreResponse is the response type for the DeleteDatastore API operation.

func (*DeleteDatastoreResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteDatastoreResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDatastore request.

type DeletePipelineInput

type DeletePipelineInput struct {

	// The name of the pipeline to delete.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"pipelineName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePipelineInput) MarshalFields

func (s DeletePipelineInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePipelineInput) String

func (s DeletePipelineInput) String() string

String returns the string representation

func (*DeletePipelineInput) Validate

func (s *DeletePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePipelineOutput

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

func (DeletePipelineOutput) MarshalFields

func (s DeletePipelineOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePipelineOutput) String

func (s DeletePipelineOutput) String() string

String returns the string representation

type DeletePipelineRequest

type DeletePipelineRequest struct {
	*aws.Request
	Input *DeletePipelineInput
	Copy  func(*DeletePipelineInput) DeletePipelineRequest
}

DeletePipelineRequest is the request type for the DeletePipeline API operation.

func (DeletePipelineRequest) Send

Send marshals and sends the DeletePipeline API request.

type DeletePipelineResponse added in v0.9.0

type DeletePipelineResponse struct {
	*DeletePipelineOutput
	// contains filtered or unexported fields
}

DeletePipelineResponse is the response type for the DeletePipeline API operation.

func (*DeletePipelineResponse) SDKResponseMetdata added in v0.9.0

func (r *DeletePipelineResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePipeline request.

type DeltaTime added in v0.5.0

type DeltaTime struct {

	// The number of seconds of estimated "in flight" lag time of message data.
	// When you create data set contents using message data from a specified time
	// frame, some message data may still be "in flight" when processing begins,
	// and so will not arrive in time to be processed. Use this field to make allowances
	// for the "in flight" time of your message data, so that data not processed
	// from a previous time frame will be included with the next time frame. Without
	// this, missed message data would be excluded from processing during the next
	// time frame as well, because its timestamp places it within the previous time
	// frame.
	//
	// OffsetSeconds is a required field
	OffsetSeconds *int64 `locationName:"offsetSeconds" type:"integer" required:"true"`

	// An expression by which the time of the message data may be determined. This
	// may be the name of a timestamp field, or a SQL expression which is used to
	// derive the time the message data was generated.
	//
	// TimeExpression is a required field
	TimeExpression *string `locationName:"timeExpression" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Used to limit data to that which has arrived since the last execution of the action.

func (DeltaTime) MarshalFields added in v0.5.0

func (s DeltaTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeltaTime) String added in v0.5.0

func (s DeltaTime) String() string

String returns the string representation

func (*DeltaTime) Validate added in v0.5.0

func (s *DeltaTime) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeChannelInput

type DescribeChannelInput struct {

	// The name of the channel whose information is retrieved.
	//
	// ChannelName is a required field
	ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"includeStatistics" type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeChannelInput) MarshalFields

func (s DescribeChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeChannelInput) String

func (s DescribeChannelInput) String() string

String returns the string representation

func (*DescribeChannelInput) Validate

func (s *DescribeChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeChannelOutput

type DescribeChannelOutput struct {

	// An object that contains information about the channel.
	Channel *Channel `locationName:"channel" type:"structure"`

	// Statistics about the channel. Included if the 'includeStatistics' parameter
	// is set to true in the request.
	Statistics *ChannelStatistics `locationName:"statistics" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelOutput) MarshalFields

func (s DescribeChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeChannelOutput) String

func (s DescribeChannelOutput) String() string

String returns the string representation

type DescribeChannelRequest

type DescribeChannelRequest struct {
	*aws.Request
	Input *DescribeChannelInput
	Copy  func(*DescribeChannelInput) DescribeChannelRequest
}

DescribeChannelRequest is the request type for the DescribeChannel API operation.

func (DescribeChannelRequest) Send

Send marshals and sends the DescribeChannel API request.

type DescribeChannelResponse added in v0.9.0

type DescribeChannelResponse struct {
	*DescribeChannelOutput
	// contains filtered or unexported fields
}

DescribeChannelResponse is the response type for the DescribeChannel API operation.

func (*DescribeChannelResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeChannel request.

type DescribeDatasetInput

type DescribeDatasetInput struct {

	// The name of the data set whose information is retrieved.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetInput) MarshalFields

func (s DescribeDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDatasetInput) String

func (s DescribeDatasetInput) String() string

String returns the string representation

func (*DescribeDatasetInput) Validate

func (s *DescribeDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetOutput

type DescribeDatasetOutput struct {

	// An object that contains information about the data set.
	Dataset *Dataset `locationName:"dataset" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetOutput) MarshalFields

func (s DescribeDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDatasetOutput) String

func (s DescribeDatasetOutput) String() string

String returns the string representation

type DescribeDatasetRequest

type DescribeDatasetRequest struct {
	*aws.Request
	Input *DescribeDatasetInput
	Copy  func(*DescribeDatasetInput) DescribeDatasetRequest
}

DescribeDatasetRequest is the request type for the DescribeDataset API operation.

func (DescribeDatasetRequest) Send

Send marshals and sends the DescribeDataset API request.

type DescribeDatasetResponse added in v0.9.0

type DescribeDatasetResponse struct {
	*DescribeDatasetOutput
	// contains filtered or unexported fields
}

DescribeDatasetResponse is the response type for the DescribeDataset API operation.

func (*DescribeDatasetResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDataset request.

type DescribeDatastoreInput

type DescribeDatastoreInput struct {

	// The name of the data store
	//
	// DatastoreName is a required field
	DatastoreName *string `location:"uri" locationName:"datastoreName" min:"1" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"includeStatistics" type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeDatastoreInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDatastoreInput) String

func (s DescribeDatastoreInput) String() string

String returns the string representation

func (*DescribeDatastoreInput) Validate

func (s *DescribeDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatastoreOutput

type DescribeDatastoreOutput struct {

	// Information about the data store.
	Datastore *Datastore `locationName:"datastore" type:"structure"`

	// Additional statistical information about the data store. Included if the
	// 'includeStatistics' parameter is set to true in the request.
	Statistics *DatastoreStatistics `locationName:"statistics" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatastoreOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDatastoreOutput) String

func (s DescribeDatastoreOutput) String() string

String returns the string representation

type DescribeDatastoreRequest

type DescribeDatastoreRequest struct {
	*aws.Request
	Input *DescribeDatastoreInput
	Copy  func(*DescribeDatastoreInput) DescribeDatastoreRequest
}

DescribeDatastoreRequest is the request type for the DescribeDatastore API operation.

func (DescribeDatastoreRequest) Send

Send marshals and sends the DescribeDatastore API request.

type DescribeDatastoreResponse added in v0.9.0

type DescribeDatastoreResponse struct {
	*DescribeDatastoreOutput
	// contains filtered or unexported fields
}

DescribeDatastoreResponse is the response type for the DescribeDatastore API operation.

func (*DescribeDatastoreResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeDatastoreResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDatastore request.

type DescribeLoggingOptionsInput

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

func (DescribeLoggingOptionsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLoggingOptionsInput) String

String returns the string representation

type DescribeLoggingOptionsOutput

type DescribeLoggingOptionsOutput struct {

	// The current settings of the AWS IoT Analytics logging options.
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeLoggingOptionsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLoggingOptionsOutput) String

String returns the string representation

type DescribeLoggingOptionsRequest

type DescribeLoggingOptionsRequest struct {
	*aws.Request
	Input *DescribeLoggingOptionsInput
	Copy  func(*DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest
}

DescribeLoggingOptionsRequest is the request type for the DescribeLoggingOptions API operation.

func (DescribeLoggingOptionsRequest) Send

Send marshals and sends the DescribeLoggingOptions API request.

type DescribeLoggingOptionsResponse added in v0.9.0

type DescribeLoggingOptionsResponse struct {
	*DescribeLoggingOptionsOutput
	// contains filtered or unexported fields
}

DescribeLoggingOptionsResponse is the response type for the DescribeLoggingOptions API operation.

func (*DescribeLoggingOptionsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeLoggingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLoggingOptions request.

type DescribePipelineInput

type DescribePipelineInput struct {

	// The name of the pipeline whose information is retrieved.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"pipelineName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePipelineInput) MarshalFields

func (s DescribePipelineInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePipelineInput) String

func (s DescribePipelineInput) String() string

String returns the string representation

func (*DescribePipelineInput) Validate

func (s *DescribePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePipelineOutput

type DescribePipelineOutput struct {

	// A "Pipeline" object that contains information about the pipeline.
	Pipeline *Pipeline `locationName:"pipeline" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePipelineOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePipelineOutput) String

func (s DescribePipelineOutput) String() string

String returns the string representation

type DescribePipelineRequest

type DescribePipelineRequest struct {
	*aws.Request
	Input *DescribePipelineInput
	Copy  func(*DescribePipelineInput) DescribePipelineRequest
}

DescribePipelineRequest is the request type for the DescribePipeline API operation.

func (DescribePipelineRequest) Send

Send marshals and sends the DescribePipeline API request.

type DescribePipelineResponse added in v0.9.0

type DescribePipelineResponse struct {
	*DescribePipelineOutput
	// contains filtered or unexported fields
}

DescribePipelineResponse is the response type for the DescribePipeline API operation.

func (*DescribePipelineResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribePipelineResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePipeline request.

type DeviceRegistryEnrichActivity

type DeviceRegistryEnrichActivity struct {

	// The name of the attribute that is added to the message.
	//
	// Attribute is a required field
	Attribute *string `locationName:"attribute" min:"1" type:"string" required:"true"`

	// The name of the 'deviceRegistryEnrich' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`

	// The ARN of the role that allows access to the device's registry information.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The name of the IoT device whose registry information is added to the message.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An activity that adds data from the AWS IoT device registry to your message.

func (DeviceRegistryEnrichActivity) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeviceRegistryEnrichActivity) String

String returns the string representation

func (*DeviceRegistryEnrichActivity) Validate

func (s *DeviceRegistryEnrichActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeviceShadowEnrichActivity

type DeviceShadowEnrichActivity struct {

	// The name of the attribute that is added to the message.
	//
	// Attribute is a required field
	Attribute *string `locationName:"attribute" min:"1" type:"string" required:"true"`

	// The name of the 'deviceShadowEnrich' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`

	// The ARN of the role that allows access to the device's shadow.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The name of the IoT device whose shadow information is added to the message.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An activity that adds information from the AWS IoT Device Shadows service to a message.

func (DeviceShadowEnrichActivity) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeviceShadowEnrichActivity) String

String returns the string representation

func (*DeviceShadowEnrichActivity) Validate

func (s *DeviceShadowEnrichActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EstimatedResourceSize added in v0.5.0

type EstimatedResourceSize struct {

	// The time when the estimate of the size of the resource was made.
	EstimatedOn *time.Time `locationName:"estimatedOn" type:"timestamp"`

	// The estimated size of the resource in bytes.
	EstimatedSizeInBytes *float64 `locationName:"estimatedSizeInBytes" type:"double"`
	// contains filtered or unexported fields
}

The estimated size of the resource.

func (EstimatedResourceSize) MarshalFields added in v0.5.0

func (s EstimatedResourceSize) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EstimatedResourceSize) String added in v0.5.0

func (s EstimatedResourceSize) String() string

String returns the string representation

type FilterActivity

type FilterActivity struct {

	// An expression that looks like a SQL WHERE clause that must return a Boolean
	// value.
	//
	// Filter is a required field
	Filter *string `locationName:"filter" min:"1" type:"string" required:"true"`

	// The name of the 'filter' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An activity that filters a message based on its attributes.

func (FilterActivity) MarshalFields

func (s FilterActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FilterActivity) String

func (s FilterActivity) String() string

String returns the string representation

func (*FilterActivity) Validate

func (s *FilterActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDatasetContentInput

type GetDatasetContentInput struct {

	// The name of the data set whose contents are retrieved.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"versionId" min:"7" type:"string"`
	// contains filtered or unexported fields
}

func (GetDatasetContentInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDatasetContentInput) String

func (s GetDatasetContentInput) String() string

String returns the string representation

func (*GetDatasetContentInput) Validate

func (s *GetDatasetContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDatasetContentOutput

type GetDatasetContentOutput struct {

	// A list of "DatasetEntry" objects.
	Entries []DatasetEntry `locationName:"entries" type:"list"`

	// The status of the data set content.
	Status *DatasetContentStatus `locationName:"status" type:"structure"`

	// The time when the request was made.
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetDatasetContentOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDatasetContentOutput) String

func (s GetDatasetContentOutput) String() string

String returns the string representation

type GetDatasetContentRequest

type GetDatasetContentRequest struct {
	*aws.Request
	Input *GetDatasetContentInput
	Copy  func(*GetDatasetContentInput) GetDatasetContentRequest
}

GetDatasetContentRequest is the request type for the GetDatasetContent API operation.

func (GetDatasetContentRequest) Send

Send marshals and sends the GetDatasetContent API request.

type GetDatasetContentResponse added in v0.9.0

type GetDatasetContentResponse struct {
	*GetDatasetContentOutput
	// contains filtered or unexported fields
}

GetDatasetContentResponse is the response type for the GetDatasetContent API operation.

func (*GetDatasetContentResponse) SDKResponseMetdata added in v0.9.0

func (r *GetDatasetContentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDatasetContent request.

type GlueConfiguration added in v0.9.0

type GlueConfiguration struct {

	// The name of the database in your AWS Glue Data Catalog in which the table
	// is located. (An AWS Glue Data Catalog database contains Glue Data tables.)
	//
	// DatabaseName is a required field
	DatabaseName *string `locationName:"databaseName" min:"1" type:"string" required:"true"`

	// The name of the table in your AWS Glue Data Catalog which is used to perform
	// the ETL (extract, transform and load) operations. (An AWS Glue Data Catalog
	// table contains partitioned data and descriptions of data sources and targets.)
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for coordination with the AWS Glue ETL (extract, transform and load) service.

func (GlueConfiguration) MarshalFields added in v0.9.0

func (s GlueConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GlueConfiguration) String added in v0.9.0

func (s GlueConfiguration) String() string

String returns the string representation

func (*GlueConfiguration) Validate added in v0.9.0

func (s *GlueConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IotEventsDestinationConfiguration added in v0.6.0

type IotEventsDestinationConfiguration struct {

	// The name of the AWS IoT Events input to which data set contents are delivered.
	//
	// InputName is a required field
	InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`

	// The ARN of the role which grants AWS IoT Analytics permission to deliver
	// data set contents to an AWS IoT Events input.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for delivery of data set contents to AWS IoT Events.

func (IotEventsDestinationConfiguration) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (IotEventsDestinationConfiguration) String added in v0.6.0

String returns the string representation

func (*IotEventsDestinationConfiguration) Validate added in v0.6.0

Validate inspects the fields of the type to determine if they are valid.

type LambdaActivity

type LambdaActivity struct {

	// The number of messages passed to the Lambda function for processing.
	//
	// The AWS Lambda function must be able to process all of these messages within
	// five minutes, which is the maximum timeout duration for Lambda functions.
	//
	// BatchSize is a required field
	BatchSize *int64 `locationName:"batchSize" min:"1" type:"integer" required:"true"`

	// The name of the Lambda function that is run on the message.
	//
	// LambdaName is a required field
	LambdaName *string `locationName:"lambdaName" min:"1" type:"string" required:"true"`

	// The name of the 'lambda' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An activity that runs a Lambda function to modify the message.

func (LambdaActivity) MarshalFields

func (s LambdaActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LambdaActivity) String

func (s LambdaActivity) String() string

String returns the string representation

func (*LambdaActivity) Validate

func (s *LambdaActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListChannelsInput

type ListChannelsInput struct {

	// The maximum number of results to return in this request.
	//
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListChannelsInput) MarshalFields

func (s ListChannelsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListChannelsInput) String

func (s ListChannelsInput) String() string

String returns the string representation

func (*ListChannelsInput) Validate

func (s *ListChannelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListChannelsOutput

type ListChannelsOutput struct {

	// A list of "ChannelSummary" objects.
	ChannelSummaries []ChannelSummary `locationName:"channelSummaries" type:"list"`

	// The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListChannelsOutput) MarshalFields

func (s ListChannelsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListChannelsOutput) String

func (s ListChannelsOutput) String() string

String returns the string representation

type ListChannelsPaginator added in v0.9.0

type ListChannelsPaginator struct {
	aws.Pager
}

ListChannelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListChannelsPaginator added in v0.9.0

func NewListChannelsPaginator(req ListChannelsRequest) ListChannelsPaginator

NewListChannelsRequestPaginator returns a paginator for ListChannels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListChannelsRequest(input)
p := iotanalytics.NewListChannelsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListChannelsPaginator) CurrentPage added in v0.9.0

func (p *ListChannelsPaginator) CurrentPage() *ListChannelsOutput

type ListChannelsRequest

type ListChannelsRequest struct {
	*aws.Request
	Input *ListChannelsInput
	Copy  func(*ListChannelsInput) ListChannelsRequest
}

ListChannelsRequest is the request type for the ListChannels API operation.

func (ListChannelsRequest) Send

Send marshals and sends the ListChannels API request.

type ListChannelsResponse added in v0.9.0

type ListChannelsResponse struct {
	*ListChannelsOutput
	// contains filtered or unexported fields
}

ListChannelsResponse is the response type for the ListChannels API operation.

func (*ListChannelsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListChannelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListChannels request.

type ListDatasetContentsInput added in v0.5.0

type ListDatasetContentsInput struct {

	// The name of the data set whose contents information you want to list.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return in this request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// 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 `location:"querystring" locationName:"scheduledBefore" type:"timestamp"`

	// 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 `location:"querystring" locationName:"scheduledOnOrAfter" type:"timestamp"`
	// contains filtered or unexported fields
}

func (ListDatasetContentsInput) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatasetContentsInput) String added in v0.5.0

func (s ListDatasetContentsInput) String() string

String returns the string representation

func (*ListDatasetContentsInput) Validate added in v0.5.0

func (s *ListDatasetContentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetContentsOutput added in v0.5.0

type ListDatasetContentsOutput struct {

	// Summary information about data set contents that have been created.
	DatasetContentSummaries []DatasetContentSummary `locationName:"datasetContentSummaries" type:"list"`

	// The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetContentsOutput) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatasetContentsOutput) String added in v0.5.0

func (s ListDatasetContentsOutput) String() string

String returns the string representation

type ListDatasetContentsPaginator added in v0.9.0

type ListDatasetContentsPaginator struct {
	aws.Pager
}

ListDatasetContentsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatasetContentsPaginator added in v0.9.0

func NewListDatasetContentsPaginator(req ListDatasetContentsRequest) ListDatasetContentsPaginator

NewListDatasetContentsRequestPaginator returns a paginator for ListDatasetContents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatasetContentsRequest(input)
p := iotanalytics.NewListDatasetContentsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatasetContentsPaginator) CurrentPage added in v0.9.0

type ListDatasetContentsRequest added in v0.5.0

type ListDatasetContentsRequest struct {
	*aws.Request
	Input *ListDatasetContentsInput
	Copy  func(*ListDatasetContentsInput) ListDatasetContentsRequest
}

ListDatasetContentsRequest is the request type for the ListDatasetContents API operation.

func (ListDatasetContentsRequest) Send added in v0.5.0

Send marshals and sends the ListDatasetContents API request.

type ListDatasetContentsResponse added in v0.9.0

type ListDatasetContentsResponse struct {
	*ListDatasetContentsOutput
	// contains filtered or unexported fields
}

ListDatasetContentsResponse is the response type for the ListDatasetContents API operation.

func (*ListDatasetContentsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListDatasetContentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatasetContents request.

type ListDatasetsInput

type ListDatasetsInput struct {

	// The maximum number of results to return in this request.
	//
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsInput) MarshalFields

func (s ListDatasetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatasetsInput) String

func (s ListDatasetsInput) String() string

String returns the string representation

func (*ListDatasetsInput) Validate

func (s *ListDatasetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetsOutput

type ListDatasetsOutput struct {

	// A list of "DatasetSummary" objects.
	DatasetSummaries []DatasetSummary `locationName:"datasetSummaries" type:"list"`

	// The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsOutput) MarshalFields

func (s ListDatasetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatasetsOutput) String

func (s ListDatasetsOutput) String() string

String returns the string representation

type ListDatasetsPaginator added in v0.9.0

type ListDatasetsPaginator struct {
	aws.Pager
}

ListDatasetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatasetsPaginator added in v0.9.0

func NewListDatasetsPaginator(req ListDatasetsRequest) ListDatasetsPaginator

NewListDatasetsRequestPaginator returns a paginator for ListDatasets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatasetsRequest(input)
p := iotanalytics.NewListDatasetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatasetsPaginator) CurrentPage added in v0.9.0

func (p *ListDatasetsPaginator) CurrentPage() *ListDatasetsOutput

type ListDatasetsRequest

type ListDatasetsRequest struct {
	*aws.Request
	Input *ListDatasetsInput
	Copy  func(*ListDatasetsInput) ListDatasetsRequest
}

ListDatasetsRequest is the request type for the ListDatasets API operation.

func (ListDatasetsRequest) Send

Send marshals and sends the ListDatasets API request.

type ListDatasetsResponse added in v0.9.0

type ListDatasetsResponse struct {
	*ListDatasetsOutput
	// contains filtered or unexported fields
}

ListDatasetsResponse is the response type for the ListDatasets API operation.

func (*ListDatasetsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListDatasetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatasets request.

type ListDatastoresInput

type ListDatastoresInput struct {

	// The maximum number of results to return in this request.
	//
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatastoresInput) MarshalFields

func (s ListDatastoresInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatastoresInput) String

func (s ListDatastoresInput) String() string

String returns the string representation

func (*ListDatastoresInput) Validate

func (s *ListDatastoresInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatastoresOutput

type ListDatastoresOutput struct {

	// A list of "DatastoreSummary" objects.
	DatastoreSummaries []DatastoreSummary `locationName:"datastoreSummaries" type:"list"`

	// The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatastoresOutput) MarshalFields

func (s ListDatastoresOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDatastoresOutput) String

func (s ListDatastoresOutput) String() string

String returns the string representation

type ListDatastoresPaginator added in v0.9.0

type ListDatastoresPaginator struct {
	aws.Pager
}

ListDatastoresPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatastoresPaginator added in v0.9.0

func NewListDatastoresPaginator(req ListDatastoresRequest) ListDatastoresPaginator

NewListDatastoresRequestPaginator returns a paginator for ListDatastores. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatastoresRequest(input)
p := iotanalytics.NewListDatastoresRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatastoresPaginator) CurrentPage added in v0.9.0

type ListDatastoresRequest

type ListDatastoresRequest struct {
	*aws.Request
	Input *ListDatastoresInput
	Copy  func(*ListDatastoresInput) ListDatastoresRequest
}

ListDatastoresRequest is the request type for the ListDatastores API operation.

func (ListDatastoresRequest) Send

Send marshals and sends the ListDatastores API request.

type ListDatastoresResponse added in v0.9.0

type ListDatastoresResponse struct {
	*ListDatastoresOutput
	// contains filtered or unexported fields
}

ListDatastoresResponse is the response type for the ListDatastores API operation.

func (*ListDatastoresResponse) SDKResponseMetdata added in v0.9.0

func (r *ListDatastoresResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatastores request.

type ListPipelinesInput

type ListPipelinesInput struct {

	// The maximum number of results to return in this request.
	//
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListPipelinesInput) MarshalFields

func (s ListPipelinesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPipelinesInput) String

func (s ListPipelinesInput) String() string

String returns the string representation

func (*ListPipelinesInput) Validate

func (s *ListPipelinesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPipelinesOutput

type ListPipelinesOutput struct {

	// The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of "PipelineSummary" objects.
	PipelineSummaries []PipelineSummary `locationName:"pipelineSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListPipelinesOutput) MarshalFields

func (s ListPipelinesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPipelinesOutput) String

func (s ListPipelinesOutput) String() string

String returns the string representation

type ListPipelinesPaginator added in v0.9.0

type ListPipelinesPaginator struct {
	aws.Pager
}

ListPipelinesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPipelinesPaginator added in v0.9.0

func NewListPipelinesPaginator(req ListPipelinesRequest) ListPipelinesPaginator

NewListPipelinesRequestPaginator returns a paginator for ListPipelines. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListPipelinesRequest(input)
p := iotanalytics.NewListPipelinesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPipelinesPaginator) CurrentPage added in v0.9.0

func (p *ListPipelinesPaginator) CurrentPage() *ListPipelinesOutput

type ListPipelinesRequest

type ListPipelinesRequest struct {
	*aws.Request
	Input *ListPipelinesInput
	Copy  func(*ListPipelinesInput) ListPipelinesRequest
}

ListPipelinesRequest is the request type for the ListPipelines API operation.

func (ListPipelinesRequest) Send

Send marshals and sends the ListPipelines API request.

type ListPipelinesResponse added in v0.9.0

type ListPipelinesResponse struct {
	*ListPipelinesOutput
	// contains filtered or unexported fields
}

ListPipelinesResponse is the response type for the ListPipelines API operation.

func (*ListPipelinesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListPipelinesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPipelines request.

type ListTagsForResourceInput added in v0.5.0

type ListTagsForResourceInput struct {

	// The ARN of the resource whose tags you want to list.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.5.0

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.5.0

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.5.0

type ListTagsForResourceOutput struct {

	// The tags (metadata) which you have assigned to the resource.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.5.0

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.5.0

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.5.0

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LoggingLevel

type LoggingLevel string
const (
	LoggingLevelError LoggingLevel = "ERROR"
)

Enum values for LoggingLevel

func (LoggingLevel) MarshalValue

func (enum LoggingLevel) MarshalValue() (string, error)

func (LoggingLevel) MarshalValueBuf

func (enum LoggingLevel) MarshalValueBuf(b []byte) ([]byte, error)

type LoggingOptions

type LoggingOptions struct {

	// If true, logging is enabled for AWS IoT Analytics.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The logging level. Currently, only "ERROR" is supported.
	//
	// Level is a required field
	Level LoggingLevel `locationName:"level" type:"string" required:"true" enum:"true"`

	// The ARN of the role that grants permission to AWS IoT Analytics to perform
	// logging.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about logging options.

func (LoggingOptions) MarshalFields

func (s LoggingOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LoggingOptions) String

func (s LoggingOptions) String() string

String returns the string representation

func (*LoggingOptions) Validate

func (s *LoggingOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MathActivity

type MathActivity struct {

	// The name of the attribute that contains the result of the math operation.
	//
	// Attribute is a required field
	Attribute *string `locationName:"attribute" min:"1" type:"string" required:"true"`

	// An expression that uses one or more existing attributes and must return an
	// integer value.
	//
	// Math is a required field
	Math *string `locationName:"math" min:"1" type:"string" required:"true"`

	// The name of the 'math' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An activity that computes an arithmetic expression using the message's attributes.

func (MathActivity) MarshalFields

func (s MathActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MathActivity) String

func (s MathActivity) String() string

String returns the string representation

func (*MathActivity) Validate

func (s *MathActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Message

type Message struct {

	// The ID you wish to assign to the message. Each "messageId" must be unique
	// within each batch sent.
	//
	// MessageId is a required field
	MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`

	// The payload of the message. This may be a JSON string or a Base64-encoded
	// string representing binary data (in which case you must decode it by means
	// of a pipeline activity).
	//
	// Payload is automatically base64 encoded/decoded by the SDK.
	//
	// Payload is a required field
	Payload []byte `locationName:"payload" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Information about a message.

func (Message) MarshalFields

func (s Message) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Message) String

func (s Message) String() string

String returns the string representation

func (*Message) Validate

func (s *Message) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OutputFileUriValue added in v0.5.0

type OutputFileUriValue struct {

	// The URI of the location where data set contents are stored, usually the URI
	// of a file in an S3 bucket.
	//
	// FileName is a required field
	FileName *string `locationName:"fileName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The value of the variable as a structure that specifies an output file URI.

func (OutputFileUriValue) MarshalFields added in v0.5.0

func (s OutputFileUriValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OutputFileUriValue) String added in v0.5.0

func (s OutputFileUriValue) String() string

String returns the string representation

func (*OutputFileUriValue) Validate added in v0.5.0

func (s *OutputFileUriValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Pipeline

type Pipeline struct {

	// The activities that perform transformations on the messages.
	Activities []PipelineActivity `locationName:"activities" min:"1" type:"list"`

	// The ARN of the pipeline.
	Arn *string `locationName:"arn" type:"string"`

	// When the pipeline was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The last time the pipeline was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The name of the pipeline.
	Name *string `locationName:"name" min:"1" type:"string"`

	// A summary of information about the pipeline reprocessing.
	ReprocessingSummaries []ReprocessingSummary `locationName:"reprocessingSummaries" type:"list"`
	// contains filtered or unexported fields
}

Contains information about a pipeline.

func (Pipeline) MarshalFields

func (s Pipeline) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Pipeline) String

func (s Pipeline) String() string

String returns the string representation

type PipelineActivity

type PipelineActivity struct {

	// Adds other attributes based on existing attributes in the message.
	AddAttributes *AddAttributesActivity `locationName:"addAttributes" type:"structure"`

	// Determines the source of the messages to be processed.
	Channel *ChannelActivity `locationName:"channel" type:"structure"`

	// Specifies where to store the processed message data.
	Datastore *DatastoreActivity `locationName:"datastore" type:"structure"`

	// Adds data from the AWS IoT device registry to your message.
	DeviceRegistryEnrich *DeviceRegistryEnrichActivity `locationName:"deviceRegistryEnrich" type:"structure"`

	// Adds information from the AWS IoT Device Shadows service to a message.
	DeviceShadowEnrich *DeviceShadowEnrichActivity `locationName:"deviceShadowEnrich" type:"structure"`

	// Filters a message based on its attributes.
	Filter *FilterActivity `locationName:"filter" type:"structure"`

	// Runs a Lambda function to modify the message.
	Lambda *LambdaActivity `locationName:"lambda" type:"structure"`

	// Computes an arithmetic expression using the message's attributes and adds
	// it to the message.
	Math *MathActivity `locationName:"math" type:"structure"`

	// Removes attributes from a message.
	RemoveAttributes *RemoveAttributesActivity `locationName:"removeAttributes" type:"structure"`

	// Creates a new message using only the specified attributes from the original
	// message.
	SelectAttributes *SelectAttributesActivity `locationName:"selectAttributes" type:"structure"`
	// contains filtered or unexported fields
}

An activity that performs a transformation on a message.

func (PipelineActivity) MarshalFields

func (s PipelineActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PipelineActivity) String

func (s PipelineActivity) String() string

String returns the string representation

func (*PipelineActivity) Validate

func (s *PipelineActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PipelineSummary

type PipelineSummary struct {

	// When the pipeline was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// When the pipeline was last updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The name of the pipeline.
	PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`

	// A summary of information about the pipeline reprocessing.
	ReprocessingSummaries []ReprocessingSummary `locationName:"reprocessingSummaries" type:"list"`
	// contains filtered or unexported fields
}

A summary of information about a pipeline.

func (PipelineSummary) MarshalFields

func (s PipelineSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PipelineSummary) String

func (s PipelineSummary) String() string

String returns the string representation

type PutLoggingOptionsInput

type PutLoggingOptionsInput struct {

	// The new values of the AWS IoT Analytics logging options.
	//
	// LoggingOptions is a required field
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutLoggingOptionsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLoggingOptionsInput) String

func (s PutLoggingOptionsInput) String() string

String returns the string representation

func (*PutLoggingOptionsInput) Validate

func (s *PutLoggingOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLoggingOptionsOutput

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

func (PutLoggingOptionsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLoggingOptionsOutput) String

func (s PutLoggingOptionsOutput) String() string

String returns the string representation

type PutLoggingOptionsRequest

type PutLoggingOptionsRequest struct {
	*aws.Request
	Input *PutLoggingOptionsInput
	Copy  func(*PutLoggingOptionsInput) PutLoggingOptionsRequest
}

PutLoggingOptionsRequest is the request type for the PutLoggingOptions API operation.

func (PutLoggingOptionsRequest) Send

Send marshals and sends the PutLoggingOptions API request.

type PutLoggingOptionsResponse added in v0.9.0

type PutLoggingOptionsResponse struct {
	*PutLoggingOptionsOutput
	// contains filtered or unexported fields
}

PutLoggingOptionsResponse is the response type for the PutLoggingOptions API operation.

func (*PutLoggingOptionsResponse) SDKResponseMetdata added in v0.9.0

func (r *PutLoggingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutLoggingOptions request.

type QueryFilter added in v0.5.0

type QueryFilter struct {

	// Used to limit data to that which has arrived since the last execution of
	// the action.
	DeltaTime *DeltaTime `locationName:"deltaTime" type:"structure"`
	// contains filtered or unexported fields
}

Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

func (QueryFilter) MarshalFields added in v0.5.0

func (s QueryFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QueryFilter) String added in v0.5.0

func (s QueryFilter) String() string

String returns the string representation

func (*QueryFilter) Validate added in v0.5.0

func (s *QueryFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveAttributesActivity

type RemoveAttributesActivity struct {

	// A list of 1-50 attributes to remove from the message.
	//
	// Attributes is a required field
	Attributes []string `locationName:"attributes" min:"1" type:"list" required:"true"`

	// The name of the 'removeAttributes' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An activity that removes attributes from a message.

func (RemoveAttributesActivity) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveAttributesActivity) String

func (s RemoveAttributesActivity) String() string

String returns the string representation

func (*RemoveAttributesActivity) Validate

func (s *RemoveAttributesActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReprocessingStatus

type ReprocessingStatus string
const (
	ReprocessingStatusRunning   ReprocessingStatus = "RUNNING"
	ReprocessingStatusSucceeded ReprocessingStatus = "SUCCEEDED"
	ReprocessingStatusCancelled ReprocessingStatus = "CANCELLED"
	ReprocessingStatusFailed    ReprocessingStatus = "FAILED"
)

Enum values for ReprocessingStatus

func (ReprocessingStatus) MarshalValue

func (enum ReprocessingStatus) MarshalValue() (string, error)

func (ReprocessingStatus) MarshalValueBuf

func (enum ReprocessingStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ReprocessingSummary

type ReprocessingSummary struct {

	// The time the pipeline reprocessing was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The 'reprocessingId' returned by "StartPipelineReprocessing".
	Id *string `locationName:"id" type:"string"`

	// The status of the pipeline reprocessing.
	Status ReprocessingStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about pipeline reprocessing.

func (ReprocessingSummary) MarshalFields

func (s ReprocessingSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReprocessingSummary) String

func (s ReprocessingSummary) String() string

String returns the string representation

type ResourceConfiguration added in v0.5.0

type ResourceConfiguration struct {

	// The type of the compute resource used to execute the "containerAction". Possible
	// values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
	//
	// ComputeType is a required field
	ComputeType ComputeType `locationName:"computeType" type:"string" required:"true" enum:"true"`

	// The size (in GB) of the persistent storage available to the resource instance
	// used to execute the "containerAction" (min: 1, max: 50).
	//
	// VolumeSizeInGB is a required field
	VolumeSizeInGB *int64 `locationName:"volumeSizeInGB" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The configuration of the resource used to execute the "containerAction".

func (ResourceConfiguration) MarshalFields added in v0.5.0

func (s ResourceConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceConfiguration) String added in v0.5.0

func (s ResourceConfiguration) String() string

String returns the string representation

func (*ResourceConfiguration) Validate added in v0.5.0

func (s *ResourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetentionPeriod

type RetentionPeriod struct {

	// The number of days that message data is kept. The "unlimited" parameter must
	// be false.
	NumberOfDays *int64 `locationName:"numberOfDays" min:"1" type:"integer"`

	// If true, message data is kept indefinitely.
	Unlimited *bool `locationName:"unlimited" type:"boolean"`
	// contains filtered or unexported fields
}

How long, in days, message data is kept.

func (RetentionPeriod) MarshalFields

func (s RetentionPeriod) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RetentionPeriod) String

func (s RetentionPeriod) String() string

String returns the string representation

func (*RetentionPeriod) Validate

func (s *RetentionPeriod) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RunPipelineActivityInput

type RunPipelineActivityInput struct {

	// The sample message payloads on which the pipeline activity is run.
	//
	// Payloads is a required field
	Payloads [][]byte `locationName:"payloads" min:"1" type:"list" required:"true"`

	// 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.
	//
	// PipelineActivity is a required field
	PipelineActivity *PipelineActivity `locationName:"pipelineActivity" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RunPipelineActivityInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RunPipelineActivityInput) String

func (s RunPipelineActivityInput) String() string

String returns the string representation

func (*RunPipelineActivityInput) Validate

func (s *RunPipelineActivityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RunPipelineActivityOutput

type RunPipelineActivityOutput struct {

	// In case the pipeline activity fails, the log message that is generated.
	LogResult *string `locationName:"logResult" type:"string"`

	// 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 `locationName:"payloads" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (RunPipelineActivityOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RunPipelineActivityOutput) String

func (s RunPipelineActivityOutput) String() string

String returns the string representation

type RunPipelineActivityRequest

type RunPipelineActivityRequest struct {
	*aws.Request
	Input *RunPipelineActivityInput
	Copy  func(*RunPipelineActivityInput) RunPipelineActivityRequest
}

RunPipelineActivityRequest is the request type for the RunPipelineActivity API operation.

func (RunPipelineActivityRequest) Send

Send marshals and sends the RunPipelineActivity API request.

type RunPipelineActivityResponse added in v0.9.0

type RunPipelineActivityResponse struct {
	*RunPipelineActivityOutput
	// contains filtered or unexported fields
}

RunPipelineActivityResponse is the response type for the RunPipelineActivity API operation.

func (*RunPipelineActivityResponse) SDKResponseMetdata added in v0.9.0

func (r *RunPipelineActivityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RunPipelineActivity request.

type S3DestinationConfiguration added in v0.9.0

type S3DestinationConfiguration struct {

	// The name of the Amazon S3 bucket to which data set contents are delivered.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// Configuration information for coordination with the AWS Glue ETL (extract,
	// transform and load) service.
	GlueConfiguration *GlueConfiguration `locationName:"glueConfiguration" type:"structure"`

	// The key of the data set contents object. Each object in an Amazon S3 bucket
	// has a key that is its unique identifier within the bucket (each object in
	// a bucket has exactly one key). To produce a unique key, you can use "!{iotanalytics:scheduledTime}"
	// to insert the time of the scheduled SQL query run, or "!{iotanalytics:versioned}
	// to insert a unique hash identifying the data set, for example: "/DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv".
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The ARN of the role which grants AWS IoT Analytics permission to interact
	// with your Amazon S3 and AWS Glue resources.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for delivery of data set contents to Amazon S3.

func (S3DestinationConfiguration) MarshalFields added in v0.9.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3DestinationConfiguration) String added in v0.9.0

String returns the string representation

func (*S3DestinationConfiguration) Validate added in v0.9.0

func (s *S3DestinationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SampleChannelDataInput

type SampleChannelDataInput struct {

	// The name of the channel whose message samples are retrieved.
	//
	// ChannelName is a required field
	ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`

	// The end of the time window from which sample messages are retrieved.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp"`

	// The number of sample messages to be retrieved. The limit is 10, the default
	// is also 10.
	MaxMessages *int64 `location:"querystring" locationName:"maxMessages" min:"1" type:"integer"`

	// The start of the time window from which sample messages are retrieved.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

func (SampleChannelDataInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SampleChannelDataInput) String

func (s SampleChannelDataInput) String() string

String returns the string representation

func (*SampleChannelDataInput) Validate

func (s *SampleChannelDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SampleChannelDataOutput

type SampleChannelDataOutput struct {

	// The list of message samples. Each sample message is returned as a base64-encoded
	// string.
	Payloads [][]byte `locationName:"payloads" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (SampleChannelDataOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SampleChannelDataOutput) String

func (s SampleChannelDataOutput) String() string

String returns the string representation

type SampleChannelDataRequest

type SampleChannelDataRequest struct {
	*aws.Request
	Input *SampleChannelDataInput
	Copy  func(*SampleChannelDataInput) SampleChannelDataRequest
}

SampleChannelDataRequest is the request type for the SampleChannelData API operation.

func (SampleChannelDataRequest) Send

Send marshals and sends the SampleChannelData API request.

type SampleChannelDataResponse added in v0.9.0

type SampleChannelDataResponse struct {
	*SampleChannelDataOutput
	// contains filtered or unexported fields
}

SampleChannelDataResponse is the response type for the SampleChannelData API operation.

func (*SampleChannelDataResponse) SDKResponseMetdata added in v0.9.0

func (r *SampleChannelDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SampleChannelData request.

type Schedule

type Schedule struct {

	// The expression that defines when to trigger an update. For more information,
	// see Schedule Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)
	// in the Amazon CloudWatch Events User Guide.
	Expression *string `locationName:"expression" type:"string"`
	// contains filtered or unexported fields
}

The schedule for when to trigger an update.

func (Schedule) MarshalFields

func (s Schedule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Schedule) String

func (s Schedule) String() string

String returns the string representation

type SelectAttributesActivity

type SelectAttributesActivity struct {

	// A list of the attributes to select from the message.
	//
	// Attributes is a required field
	Attributes []string `locationName:"attributes" min:"1" type:"list" required:"true"`

	// The name of the 'selectAttributes' activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The next activity in the pipeline.
	Next *string `locationName:"next" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Creates a new message using only the specified attributes from the original message.

func (SelectAttributesActivity) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SelectAttributesActivity) String

func (s SelectAttributesActivity) String() string

String returns the string representation

func (*SelectAttributesActivity) Validate

func (s *SelectAttributesActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceManagedChannelS3Storage added in v0.10.0

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

Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

func (ServiceManagedChannelS3Storage) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServiceManagedChannelS3Storage) String added in v0.10.0

String returns the string representation

type ServiceManagedChannelS3StorageSummary added in v0.10.0

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

Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.

func (ServiceManagedChannelS3StorageSummary) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServiceManagedChannelS3StorageSummary) String added in v0.10.0

String returns the string representation

type ServiceManagedDatastoreS3Storage added in v0.10.0

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

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

func (ServiceManagedDatastoreS3Storage) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServiceManagedDatastoreS3Storage) String added in v0.10.0

String returns the string representation

type ServiceManagedDatastoreS3StorageSummary added in v0.10.0

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

Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

func (ServiceManagedDatastoreS3StorageSummary) MarshalFields added in v0.10.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServiceManagedDatastoreS3StorageSummary) String added in v0.10.0

String returns the string representation

type SqlQueryDatasetAction

type SqlQueryDatasetAction struct {

	// Pre-filters applied to message data.
	Filters []QueryFilter `locationName:"filters" type:"list"`

	// A SQL query string.
	//
	// SqlQuery is a required field
	SqlQuery *string `locationName:"sqlQuery" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The SQL query to modify the message.

func (SqlQueryDatasetAction) MarshalFields

func (s SqlQueryDatasetAction) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SqlQueryDatasetAction) String

func (s SqlQueryDatasetAction) String() string

String returns the string representation

func (*SqlQueryDatasetAction) Validate

func (s *SqlQueryDatasetAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPipelineReprocessingInput

type StartPipelineReprocessingInput struct {

	// The end time (exclusive) of raw message data that is reprocessed.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The name of the pipeline on which to start reprocessing.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"pipelineName" min:"1" type:"string" required:"true"`

	// The start time (inclusive) of raw message data that is reprocessed.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

func (StartPipelineReprocessingInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartPipelineReprocessingInput) String

String returns the string representation

func (*StartPipelineReprocessingInput) Validate

func (s *StartPipelineReprocessingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPipelineReprocessingOutput

type StartPipelineReprocessingOutput struct {

	// The ID of the pipeline reprocessing activity that was started.
	ReprocessingId *string `locationName:"reprocessingId" type:"string"`
	// contains filtered or unexported fields
}

func (StartPipelineReprocessingOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartPipelineReprocessingOutput) String

String returns the string representation

type StartPipelineReprocessingRequest

type StartPipelineReprocessingRequest struct {
	*aws.Request
	Input *StartPipelineReprocessingInput
	Copy  func(*StartPipelineReprocessingInput) StartPipelineReprocessingRequest
}

StartPipelineReprocessingRequest is the request type for the StartPipelineReprocessing API operation.

func (StartPipelineReprocessingRequest) Send

Send marshals and sends the StartPipelineReprocessing API request.

type StartPipelineReprocessingResponse added in v0.9.0

type StartPipelineReprocessingResponse struct {
	*StartPipelineReprocessingOutput
	// contains filtered or unexported fields
}

StartPipelineReprocessingResponse is the response type for the StartPipelineReprocessing API operation.

func (*StartPipelineReprocessingResponse) SDKResponseMetdata added in v0.9.0

func (r *StartPipelineReprocessingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartPipelineReprocessing request.

type Tag added in v0.5.0

type Tag struct {

	// The tag's key.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The tag's value.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A set of key/value pairs which are used to manage the resource.

func (Tag) MarshalFields added in v0.5.0

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tag) String added in v0.5.0

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.5.0

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v0.5.0

type TagResourceInput struct {

	// The ARN of the resource whose tags you want to modify.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The new or modified tags for the resource.
	//
	// Tags is a required field
	Tags []Tag `locationName:"tags" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.5.0

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.5.0

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.5.0

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.5.0

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

func (TagResourceOutput) MarshalFields added in v0.5.0

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.5.0

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.5.0

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.5.0

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TriggeringDataset added in v0.5.0

type TriggeringDataset struct {

	// The name of the data set whose content generation triggers the new data set
	// content generation.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the data set whose content generation triggers the new data set content generation.

func (TriggeringDataset) MarshalFields added in v0.5.0

func (s TriggeringDataset) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TriggeringDataset) String added in v0.5.0

func (s TriggeringDataset) String() string

String returns the string representation

func (*TriggeringDataset) Validate added in v0.5.0

func (s *TriggeringDataset) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput added in v0.5.0

type UntagResourceInput struct {

	// The ARN of the resource whose tags you want to remove.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The keys of those tags which you want to remove.
	//
	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.5.0

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.5.0

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.5.0

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.5.0

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

func (UntagResourceOutput) MarshalFields added in v0.5.0

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.5.0

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.5.0

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.5.0

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateChannelInput

type UpdateChannelInput struct {

	// The name of the channel to be updated.
	//
	// ChannelName is a required field
	ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`

	// 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 *ChannelStorage `locationName:"channelStorage" type:"structure"`

	// 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 *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateChannelInput) MarshalFields

func (s UpdateChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateChannelInput) String

func (s UpdateChannelInput) String() string

String returns the string representation

func (*UpdateChannelInput) Validate

func (s *UpdateChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateChannelOutput

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

func (UpdateChannelOutput) MarshalFields

func (s UpdateChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateChannelOutput) String

func (s UpdateChannelOutput) String() string

String returns the string representation

type UpdateChannelRequest

type UpdateChannelRequest struct {
	*aws.Request
	Input *UpdateChannelInput
	Copy  func(*UpdateChannelInput) UpdateChannelRequest
}

UpdateChannelRequest is the request type for the UpdateChannel API operation.

func (UpdateChannelRequest) Send

Send marshals and sends the UpdateChannel API request.

type UpdateChannelResponse added in v0.9.0

type UpdateChannelResponse struct {
	*UpdateChannelOutput
	// contains filtered or unexported fields
}

UpdateChannelResponse is the response type for the UpdateChannel API operation.

func (*UpdateChannelResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateChannel request.

type UpdateDatasetInput

type UpdateDatasetInput struct {

	// A list of "DatasetAction" objects.
	//
	// Actions is a required field
	Actions []DatasetAction `locationName:"actions" min:"1" type:"list" required:"true"`

	// When data set contents are created they are delivered to destinations specified
	// here.
	ContentDeliveryRules []DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`

	// The name of the data set to update.
	//
	// DatasetName is a required field
	DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`

	// How long, in days, data set contents are kept for the data set.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// A list of "DatasetTrigger" objects. The list can be empty or can contain
	// up to five DataSetTrigger objects.
	Triggers []DatasetTrigger `locationName:"triggers" type:"list"`

	// [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 *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDatasetInput) MarshalFields

func (s UpdateDatasetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDatasetInput) String

func (s UpdateDatasetInput) String() string

String returns the string representation

func (*UpdateDatasetInput) Validate

func (s *UpdateDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDatasetOutput

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

func (UpdateDatasetOutput) MarshalFields

func (s UpdateDatasetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDatasetOutput) String

func (s UpdateDatasetOutput) String() string

String returns the string representation

type UpdateDatasetRequest

type UpdateDatasetRequest struct {
	*aws.Request
	Input *UpdateDatasetInput
	Copy  func(*UpdateDatasetInput) UpdateDatasetRequest
}

UpdateDatasetRequest is the request type for the UpdateDataset API operation.

func (UpdateDatasetRequest) Send

Send marshals and sends the UpdateDataset API request.

type UpdateDatasetResponse added in v0.9.0

type UpdateDatasetResponse struct {
	*UpdateDatasetOutput
	// contains filtered or unexported fields
}

UpdateDatasetResponse is the response type for the UpdateDataset API operation.

func (*UpdateDatasetResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDataset request.

type UpdateDatastoreInput

type UpdateDatastoreInput struct {

	// The name of the data store to be updated.
	//
	// DatastoreName is a required field
	DatastoreName *string `location:"uri" locationName:"datastoreName" min:"1" type:"string" required:"true"`

	// 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 *DatastoreStorage `locationName:"datastoreStorage" type:"structure"`

	// 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 *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDatastoreInput) MarshalFields

func (s UpdateDatastoreInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDatastoreInput) String

func (s UpdateDatastoreInput) String() string

String returns the string representation

func (*UpdateDatastoreInput) Validate

func (s *UpdateDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDatastoreOutput

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

func (UpdateDatastoreOutput) MarshalFields

func (s UpdateDatastoreOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDatastoreOutput) String

func (s UpdateDatastoreOutput) String() string

String returns the string representation

type UpdateDatastoreRequest

type UpdateDatastoreRequest struct {
	*aws.Request
	Input *UpdateDatastoreInput
	Copy  func(*UpdateDatastoreInput) UpdateDatastoreRequest
}

UpdateDatastoreRequest is the request type for the UpdateDatastore API operation.

func (UpdateDatastoreRequest) Send

Send marshals and sends the UpdateDatastore API request.

type UpdateDatastoreResponse added in v0.9.0

type UpdateDatastoreResponse struct {
	*UpdateDatastoreOutput
	// contains filtered or unexported fields
}

UpdateDatastoreResponse is the response type for the UpdateDatastore API operation.

func (*UpdateDatastoreResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateDatastoreResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDatastore request.

type UpdatePipelineInput

type UpdatePipelineInput struct {

	// 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": { ... } }, ...
	// ]
	//
	// PipelineActivities is a required field
	PipelineActivities []PipelineActivity `locationName:"pipelineActivities" min:"1" type:"list" required:"true"`

	// The name of the pipeline to update.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"pipelineName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePipelineInput) MarshalFields

func (s UpdatePipelineInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePipelineInput) String

func (s UpdatePipelineInput) String() string

String returns the string representation

func (*UpdatePipelineInput) Validate

func (s *UpdatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePipelineOutput

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

func (UpdatePipelineOutput) MarshalFields

func (s UpdatePipelineOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePipelineOutput) String

func (s UpdatePipelineOutput) String() string

String returns the string representation

type UpdatePipelineRequest

type UpdatePipelineRequest struct {
	*aws.Request
	Input *UpdatePipelineInput
	Copy  func(*UpdatePipelineInput) UpdatePipelineRequest
}

UpdatePipelineRequest is the request type for the UpdatePipeline API operation.

func (UpdatePipelineRequest) Send

Send marshals and sends the UpdatePipeline API request.

type UpdatePipelineResponse added in v0.9.0

type UpdatePipelineResponse struct {
	*UpdatePipelineOutput
	// contains filtered or unexported fields
}

UpdatePipelineResponse is the response type for the UpdatePipeline API operation.

func (*UpdatePipelineResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdatePipelineResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdatePipeline request.

type Variable added in v0.5.0

type Variable struct {

	// The value of the variable as a structure that specifies a data set content
	// version.
	DatasetContentVersionValue *DatasetContentVersionValue `locationName:"datasetContentVersionValue" type:"structure"`

	// The value of the variable as a double (numeric).
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// The name of the variable.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The value of the variable as a structure that specifies an output file URI.
	OutputFileUriValue *OutputFileUriValue `locationName:"outputFileUriValue" type:"structure"`

	// The value of the variable as a string.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

An instance of a variable to be passed to the "containerAction" execution. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue".

func (Variable) MarshalFields added in v0.5.0

func (s Variable) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Variable) String added in v0.5.0

func (s Variable) String() string

String returns the string representation

func (*Variable) Validate added in v0.5.0

func (s *Variable) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VersioningConfiguration added in v0.8.0

type VersioningConfiguration struct {

	// How many versions of data set contents will be kept. The "unlimited" parameter
	// must be false.
	MaxVersions *int64 `locationName:"maxVersions" min:"1" type:"integer"`

	// If true, unlimited versions of data set contents will be kept.
	Unlimited *bool `locationName:"unlimited" type:"boolean"`
	// contains filtered or unexported fields
}

Information about the versioning of data set contents.

func (VersioningConfiguration) MarshalFields added in v0.8.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VersioningConfiguration) String added in v0.8.0

func (s VersioningConfiguration) String() string

String returns the string representation

func (*VersioningConfiguration) Validate added in v0.8.0

func (s *VersioningConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Directories

Path Synopsis
Package iotanalyticsiface provides an interface to enable mocking the AWS IoT Analytics service client for testing your code.
Package iotanalyticsiface provides an interface to enable mocking the AWS IoT Analytics service client for testing your code.

Jump to

Keyboard shortcuts

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