iot

package
v1.1.35-0...-ce9b3bb Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2016 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package iot provides a client for AWS IoT.

Index

Examples

Constants

View Source
const (
	// @enum CACertificateStatus
	CACertificateStatusActive = "ACTIVE"
	// @enum CACertificateStatus
	CACertificateStatusInactive = "INACTIVE"
)
View Source
const (
	// @enum CertificateStatus
	CertificateStatusActive = "ACTIVE"
	// @enum CertificateStatus
	CertificateStatusInactive = "INACTIVE"
	// @enum CertificateStatus
	CertificateStatusRevoked = "REVOKED"
	// @enum CertificateStatus
	CertificateStatusPendingTransfer = "PENDING_TRANSFER"
	// @enum CertificateStatus
	CertificateStatusRegisterInactive = "REGISTER_INACTIVE"
)
View Source
const (
	// @enum DynamoKeyType
	DynamoKeyTypeString = "STRING"
	// @enum DynamoKeyType
	DynamoKeyTypeNumber = "NUMBER"
)
View Source
const (
	// @enum LogLevel
	LogLevelDebug = "DEBUG"
	// @enum LogLevel
	LogLevelInfo = "INFO"
	// @enum LogLevel
	LogLevelError = "ERROR"
	// @enum LogLevel
	LogLevelWarn = "WARN"
	// @enum LogLevel
	LogLevelDisabled = "DISABLED"
)
View Source
const (
	// @enum MessageFormat
	MessageFormatRaw = "RAW"
	// @enum MessageFormat
	MessageFormatJson = "JSON"
)
View Source
const ServiceName = "iot"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptCertificateTransferInput

type AcceptCertificateTransferInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// Specifies whether the certificate is active.
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the AcceptCertificateTransfer operation.

func (AcceptCertificateTransferInput) GoString

GoString returns the string representation

func (AcceptCertificateTransferInput) String

String returns the string representation

func (*AcceptCertificateTransferInput) Validate

func (s *AcceptCertificateTransferInput) Validate() error

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

type AcceptCertificateTransferOutput

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

func (AcceptCertificateTransferOutput) GoString

GoString returns the string representation

func (AcceptCertificateTransferOutput) String

String returns the string representation

type Action

type Action struct {

	// Change the state of a CloudWatch alarm.
	CloudwatchAlarm *CloudwatchAlarmAction `locationName:"cloudwatchAlarm" type:"structure"`

	// Capture a CloudWatch metric.
	CloudwatchMetric *CloudwatchMetricAction `locationName:"cloudwatchMetric" type:"structure"`

	// Write to a DynamoDB table.
	DynamoDB *DynamoDBAction `locationName:"dynamoDB" type:"structure"`

	// Write data to an Amazon Elasticsearch Service; domain.
	Elasticsearch *ElasticsearchAction `locationName:"elasticsearch" type:"structure"`

	// Write to an Amazon Kinesis Firehose stream.
	Firehose *FirehoseAction `locationName:"firehose" type:"structure"`

	// Write data to an Amazon Kinesis stream.
	Kinesis *KinesisAction `locationName:"kinesis" type:"structure"`

	// Invoke a Lambda function.
	Lambda *LambdaAction `locationName:"lambda" type:"structure"`

	// Publish to another MQTT topic.
	Republish *RepublishAction `locationName:"republish" type:"structure"`

	// Write to an Amazon S3 bucket.
	S3 *S3Action `locationName:"s3" type:"structure"`

	// Publish to an Amazon SNS topic.
	Sns *SnsAction `locationName:"sns" type:"structure"`

	// Publish to an Amazon SQS queue.
	Sqs *SqsAction `locationName:"sqs" type:"structure"`
	// contains filtered or unexported fields
}

Describes the actions associated with a rule.

func (Action) GoString

func (s Action) GoString() string

GoString returns the string representation

func (Action) String

func (s Action) String() string

String returns the string representation

func (*Action) Validate

func (s *Action) Validate() error

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

type AttachPrincipalPolicyInput

type AttachPrincipalPolicyInput struct {

	// The policy name.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The principal, which can be a certificate ARN (as returned from the CreateCertificate
	// operation) or an Amazon Cognito ID.
	Principal *string `location:"header" locationName:"x-amzn-iot-principal" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the AttachPrincipalPolicy operation.

func (AttachPrincipalPolicyInput) GoString

func (s AttachPrincipalPolicyInput) GoString() string

GoString returns the string representation

func (AttachPrincipalPolicyInput) String

String returns the string representation

func (*AttachPrincipalPolicyInput) Validate

func (s *AttachPrincipalPolicyInput) Validate() error

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

type AttachPrincipalPolicyOutput

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

func (AttachPrincipalPolicyOutput) GoString

func (s AttachPrincipalPolicyOutput) GoString() string

GoString returns the string representation

func (AttachPrincipalPolicyOutput) String

String returns the string representation

type AttachThingPrincipalInput

type AttachThingPrincipalInput struct {

	// The principal (certificate or other credential).
	Principal *string `location:"header" locationName:"x-amzn-principal" type:"string" required:"true"`

	// The name of the thing.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the AttachThingPrincipal operation.

func (AttachThingPrincipalInput) GoString

func (s AttachThingPrincipalInput) GoString() string

GoString returns the string representation

func (AttachThingPrincipalInput) String

func (s AttachThingPrincipalInput) String() string

String returns the string representation

func (*AttachThingPrincipalInput) Validate

func (s *AttachThingPrincipalInput) Validate() error

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

type AttachThingPrincipalOutput

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

The output from the AttachThingPrincipal operation.

func (AttachThingPrincipalOutput) GoString

func (s AttachThingPrincipalOutput) GoString() string

GoString returns the string representation

func (AttachThingPrincipalOutput) String

String returns the string representation

type AttributePayload

type AttributePayload struct {

	// A JSON string containing up to three key-value pair in JSON format (for example,
	// {\"attributes\":{\"string1\":\"string2\"}}).
	Attributes map[string]*string `locationName:"attributes" type:"map"`
	// contains filtered or unexported fields
}

The attribute payload, a JSON string containing up to three key-value pairs (for example, {\"attributes\":{\"string1\":\"string2\"}}).

func (AttributePayload) GoString

func (s AttributePayload) GoString() string

GoString returns the string representation

func (AttributePayload) String

func (s AttributePayload) String() string

String returns the string representation

type CACertificate

type CACertificate struct {

	// The ARN of the CA certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the CA certificate.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The date the CA certificate was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The status of the CA certificate.
	//
	// The status value REGISTER_INACTIVE is deprecated and should not be used.
	Status *string `locationName:"status" type:"string" enum:"CACertificateStatus"`
	// contains filtered or unexported fields
}

A CA certificate.

func (CACertificate) GoString

func (s CACertificate) GoString() string

GoString returns the string representation

func (CACertificate) String

func (s CACertificate) String() string

String returns the string representation

type CACertificateDescription

type CACertificateDescription struct {

	// The CA certificate ARN.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The CA certificate ID.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The CA certificate data, in PEM format.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`

	// The date the CA certificate was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The owner of the CA certificate.
	OwnedBy *string `locationName:"ownedBy" type:"string"`

	// The status of a CA certificate.
	Status *string `locationName:"status" type:"string" enum:"CACertificateStatus"`
	// contains filtered or unexported fields
}

Describes a CA certificate.

func (CACertificateDescription) GoString

func (s CACertificateDescription) GoString() string

GoString returns the string representation

func (CACertificateDescription) String

func (s CACertificateDescription) String() string

String returns the string representation

type CancelCertificateTransferInput

type CancelCertificateTransferInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CancelCertificateTransfer operation.

func (CancelCertificateTransferInput) GoString

GoString returns the string representation

func (CancelCertificateTransferInput) String

String returns the string representation

func (*CancelCertificateTransferInput) Validate

func (s *CancelCertificateTransferInput) Validate() error

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

type CancelCertificateTransferOutput

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

func (CancelCertificateTransferOutput) GoString

GoString returns the string representation

func (CancelCertificateTransferOutput) String

String returns the string representation

type Certificate

type Certificate struct {

	// The ARN of the certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the certificate.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The date and time the certificate was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The status of the certificate.
	//
	// The status value REGISTER_INACTIVE is deprecated and should not be used.
	Status *string `locationName:"status" type:"string" enum:"CertificateStatus"`
	// contains filtered or unexported fields
}

Information about a certificate.

func (Certificate) GoString

func (s Certificate) GoString() string

GoString returns the string representation

func (Certificate) String

func (s Certificate) String() string

String returns the string representation

type CertificateDescription

type CertificateDescription struct {

	// The certificate ID of the CA certificate used to sign this certificate.
	CaCertificateId *string `locationName:"caCertificateId" min:"64" type:"string"`

	// The ARN of the certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the certificate.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The certificate data, in PEM format.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`

	// The date and time the certificate was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The date and time the certificate was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`

	// The ID of the AWS account that owns the certificate.
	OwnedBy *string `locationName:"ownedBy" type:"string"`

	// The ID of the AWS account of the previous owner of the certificate.
	PreviousOwnedBy *string `locationName:"previousOwnedBy" type:"string"`

	// The status of the certificate.
	Status *string `locationName:"status" type:"string" enum:"CertificateStatus"`

	// The transfer data.
	TransferData *TransferData `locationName:"transferData" type:"structure"`
	// contains filtered or unexported fields
}

Describes a certificate.

func (CertificateDescription) GoString

func (s CertificateDescription) GoString() string

GoString returns the string representation

func (CertificateDescription) String

func (s CertificateDescription) String() string

String returns the string representation

type CloudwatchAlarmAction

type CloudwatchAlarmAction struct {

	// The CloudWatch alarm name.
	AlarmName *string `locationName:"alarmName" type:"string" required:"true"`

	// The IAM role that allows access to the CloudWatch alarm.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The reason for the alarm change.
	StateReason *string `locationName:"stateReason" type:"string" required:"true"`

	// The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
	StateValue *string `locationName:"stateValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action that updates a CloudWatch alarm.

func (CloudwatchAlarmAction) GoString

func (s CloudwatchAlarmAction) GoString() string

GoString returns the string representation

func (CloudwatchAlarmAction) String

func (s CloudwatchAlarmAction) String() string

String returns the string representation

func (*CloudwatchAlarmAction) Validate

func (s *CloudwatchAlarmAction) Validate() error

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

type CloudwatchMetricAction

type CloudwatchMetricAction struct {

	// The CloudWatch metric name.
	MetricName *string `locationName:"metricName" type:"string" required:"true"`

	// The CloudWatch metric namespace name.
	MetricNamespace *string `locationName:"metricNamespace" type:"string" required:"true"`

	// An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
	MetricTimestamp *string `locationName:"metricTimestamp" type:"string"`

	// The metric unit (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
	// supported by CloudWatch.
	MetricUnit *string `locationName:"metricUnit" type:"string" required:"true"`

	// The CloudWatch metric value.
	MetricValue *string `locationName:"metricValue" type:"string" required:"true"`

	// The IAM role that allows access to the CloudWatch metric.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action that captures a CloudWatch metric.

func (CloudwatchMetricAction) GoString

func (s CloudwatchMetricAction) GoString() string

GoString returns the string representation

func (CloudwatchMetricAction) String

func (s CloudwatchMetricAction) String() string

String returns the string representation

func (*CloudwatchMetricAction) Validate

func (s *CloudwatchMetricAction) Validate() error

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

type CreateCertificateFromCsrInput

type CreateCertificateFromCsrInput struct {

	// The certificate signing request (CSR).
	CertificateSigningRequest *string `locationName:"certificateSigningRequest" min:"1" type:"string" required:"true"`

	// Specifies whether the certificate is active.
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the CreateCertificateFromCsr operation.

func (CreateCertificateFromCsrInput) GoString

GoString returns the string representation

func (CreateCertificateFromCsrInput) String

String returns the string representation

func (*CreateCertificateFromCsrInput) Validate

func (s *CreateCertificateFromCsrInput) Validate() error

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

type CreateCertificateFromCsrOutput

type CreateCertificateFromCsrOutput struct {

	// The Amazon Resource Name (ARN) of the certificate. You can use the ARN as
	// a principal for policy operations.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the certificate. Certificate management operations only take a
	// certificateId.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The certificate data, in PEM format.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output from the CreateCertificateFromCsr operation.

func (CreateCertificateFromCsrOutput) GoString

GoString returns the string representation

func (CreateCertificateFromCsrOutput) String

String returns the string representation

type CreateKeysAndCertificateInput

type CreateKeysAndCertificateInput struct {

	// Specifies whether the certificate is active.
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the CreateKeysAndCertificate operation.

func (CreateKeysAndCertificateInput) GoString

GoString returns the string representation

func (CreateKeysAndCertificateInput) String

String returns the string representation

type CreateKeysAndCertificateOutput

type CreateKeysAndCertificateOutput struct {

	// The ARN of the certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the certificate. AWS IoT issues a default subject name for the
	// certificate (for example, AWS IoT Certificate).
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The certificate data, in PEM format.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`

	// The generated key pair.
	KeyPair *KeyPair `locationName:"keyPair" type:"structure"`
	// contains filtered or unexported fields
}

The output of the CreateKeysAndCertificate operation.

func (CreateKeysAndCertificateOutput) GoString

GoString returns the string representation

func (CreateKeysAndCertificateOutput) String

String returns the string representation

type CreatePolicyInput

type CreatePolicyInput struct {

	// The JSON document that describes the policy. policyDocument must have a minimum
	// length of 1, with a maximum length of 2048, excluding whitespace.
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`

	// The policy name.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CreatePolicy operation.

func (CreatePolicyInput) GoString

func (s CreatePolicyInput) GoString() string

GoString returns the string representation

func (CreatePolicyInput) String

func (s CreatePolicyInput) String() string

String returns the string representation

func (*CreatePolicyInput) Validate

func (s *CreatePolicyInput) Validate() error

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

type CreatePolicyOutput

type CreatePolicyOutput struct {

	// The policy ARN.
	PolicyArn *string `locationName:"policyArn" type:"string"`

	// The JSON document that describes the policy.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

	// The policy name.
	PolicyName *string `locationName:"policyName" min:"1" type:"string"`

	// The policy version ID.
	PolicyVersionId *string `locationName:"policyVersionId" type:"string"`
	// contains filtered or unexported fields
}

The output from the CreatePolicy operation.

func (CreatePolicyOutput) GoString

func (s CreatePolicyOutput) GoString() string

GoString returns the string representation

func (CreatePolicyOutput) String

func (s CreatePolicyOutput) String() string

String returns the string representation

type CreatePolicyVersionInput

type CreatePolicyVersionInput struct {

	// The JSON document that describes the policy. Minimum length of 1. Maximum
	// length of 2048, excluding whitespaces
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`

	// The policy name.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// Specifies whether the policy version is set as the default. When this parameter
	// is true, the new policy version becomes the operative version (that is, the
	// version that is in effect for the certificates to which the policy is attached).
	SetAsDefault *bool `location:"querystring" locationName:"setAsDefault" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the CreatePolicyVersion operation.

func (CreatePolicyVersionInput) GoString

func (s CreatePolicyVersionInput) GoString() string

GoString returns the string representation

func (CreatePolicyVersionInput) String

func (s CreatePolicyVersionInput) String() string

String returns the string representation

func (*CreatePolicyVersionInput) Validate

func (s *CreatePolicyVersionInput) Validate() error

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

type CreatePolicyVersionOutput

type CreatePolicyVersionOutput struct {

	// Specifies whether the policy version is the default.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The policy ARN.
	PolicyArn *string `locationName:"policyArn" type:"string"`

	// The JSON document that describes the policy.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

	// The policy version ID.
	PolicyVersionId *string `locationName:"policyVersionId" type:"string"`
	// contains filtered or unexported fields
}

The output of the CreatePolicyVersion operation.

func (CreatePolicyVersionOutput) GoString

func (s CreatePolicyVersionOutput) GoString() string

GoString returns the string representation

func (CreatePolicyVersionOutput) String

func (s CreatePolicyVersionOutput) String() string

String returns the string representation

type CreateThingInput

type CreateThingInput struct {

	// The attribute payload, which consists of up to 3 name/value pairs in a JSON
	// document (for example, {\"attributes\":{\"string1\":\"string2\"}}).
	AttributePayload *AttributePayload `locationName:"attributePayload" type:"structure"`

	// The name of the thing.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CreateThing operation.

func (CreateThingInput) GoString

func (s CreateThingInput) GoString() string

GoString returns the string representation

func (CreateThingInput) String

func (s CreateThingInput) String() string

String returns the string representation

func (*CreateThingInput) Validate

func (s *CreateThingInput) Validate() error

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

type CreateThingOutput

type CreateThingOutput struct {

	// The thing ARN.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The name of the thing.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output of the CreateThing operation.

func (CreateThingOutput) GoString

func (s CreateThingOutput) GoString() string

GoString returns the string representation

func (CreateThingOutput) String

func (s CreateThingOutput) String() string

String returns the string representation

type CreateTopicRuleInput

type CreateTopicRuleInput struct {

	// The name of the rule.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`

	// The rule payload.
	TopicRulePayload *TopicRulePayload `locationName:"topicRulePayload" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input for the CreateTopicRule operation.

func (CreateTopicRuleInput) GoString

func (s CreateTopicRuleInput) GoString() string

GoString returns the string representation

func (CreateTopicRuleInput) String

func (s CreateTopicRuleInput) String() string

String returns the string representation

func (*CreateTopicRuleInput) Validate

func (s *CreateTopicRuleInput) Validate() error

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

type CreateTopicRuleOutput

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

func (CreateTopicRuleOutput) GoString

func (s CreateTopicRuleOutput) GoString() string

GoString returns the string representation

func (CreateTopicRuleOutput) String

func (s CreateTopicRuleOutput) String() string

String returns the string representation

type DeleteCACertificateInput

type DeleteCACertificateInput struct {

	// The ID of the certificate to delete.
	CertificateId *string `location:"uri" locationName:"caCertificateId" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for the DeleteCACertificate operation.

func (DeleteCACertificateInput) GoString

func (s DeleteCACertificateInput) GoString() string

GoString returns the string representation

func (DeleteCACertificateInput) String

func (s DeleteCACertificateInput) String() string

String returns the string representation

func (*DeleteCACertificateInput) Validate

func (s *DeleteCACertificateInput) Validate() error

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

type DeleteCACertificateOutput

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

The output for the DeleteCACertificate operation.

func (DeleteCACertificateOutput) GoString

func (s DeleteCACertificateOutput) GoString() string

GoString returns the string representation

func (DeleteCACertificateOutput) String

func (s DeleteCACertificateOutput) String() string

String returns the string representation

type DeleteCertificateInput

type DeleteCertificateInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeleteCertificate operation.

func (DeleteCertificateInput) GoString

func (s DeleteCertificateInput) GoString() string

GoString returns the string representation

func (DeleteCertificateInput) String

func (s DeleteCertificateInput) String() string

String returns the string representation

func (*DeleteCertificateInput) Validate

func (s *DeleteCertificateInput) Validate() error

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

type DeleteCertificateOutput

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

func (DeleteCertificateOutput) GoString

func (s DeleteCertificateOutput) GoString() string

GoString returns the string representation

func (DeleteCertificateOutput) String

func (s DeleteCertificateOutput) String() string

String returns the string representation

type DeletePolicyInput

type DeletePolicyInput struct {

	// The name of the policy to delete.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeletePolicy operation.

func (DeletePolicyInput) GoString

func (s DeletePolicyInput) GoString() string

GoString returns the string representation

func (DeletePolicyInput) String

func (s DeletePolicyInput) String() string

String returns the string representation

func (*DeletePolicyInput) Validate

func (s *DeletePolicyInput) Validate() error

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

type DeletePolicyOutput

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

func (DeletePolicyOutput) GoString

func (s DeletePolicyOutput) GoString() string

GoString returns the string representation

func (DeletePolicyOutput) String

func (s DeletePolicyOutput) String() string

String returns the string representation

type DeletePolicyVersionInput

type DeletePolicyVersionInput struct {

	// The name of the policy.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The policy version ID.
	PolicyVersionId *string `location:"uri" locationName:"policyVersionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeletePolicyVersion operation.

func (DeletePolicyVersionInput) GoString

func (s DeletePolicyVersionInput) GoString() string

GoString returns the string representation

func (DeletePolicyVersionInput) String

func (s DeletePolicyVersionInput) String() string

String returns the string representation

func (*DeletePolicyVersionInput) Validate

func (s *DeletePolicyVersionInput) Validate() error

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

type DeletePolicyVersionOutput

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

func (DeletePolicyVersionOutput) GoString

func (s DeletePolicyVersionOutput) GoString() string

GoString returns the string representation

func (DeletePolicyVersionOutput) String

func (s DeletePolicyVersionOutput) String() string

String returns the string representation

type DeleteRegistrationCodeInput

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

The input for the DeleteRegistrationCode operation.

func (DeleteRegistrationCodeInput) GoString

func (s DeleteRegistrationCodeInput) GoString() string

GoString returns the string representation

func (DeleteRegistrationCodeInput) String

String returns the string representation

type DeleteRegistrationCodeOutput

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

The output for the DeleteRegistrationCode operation.

func (DeleteRegistrationCodeOutput) GoString

func (s DeleteRegistrationCodeOutput) GoString() string

GoString returns the string representation

func (DeleteRegistrationCodeOutput) String

String returns the string representation

type DeleteThingInput

type DeleteThingInput struct {

	// The thing name.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeleteThing operation.

func (DeleteThingInput) GoString

func (s DeleteThingInput) GoString() string

GoString returns the string representation

func (DeleteThingInput) String

func (s DeleteThingInput) String() string

String returns the string representation

func (*DeleteThingInput) Validate

func (s *DeleteThingInput) Validate() error

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

type DeleteThingOutput

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

The output of the DeleteThing operation.

func (DeleteThingOutput) GoString

func (s DeleteThingOutput) GoString() string

GoString returns the string representation

func (DeleteThingOutput) String

func (s DeleteThingOutput) String() string

String returns the string representation

type DeleteTopicRuleInput

type DeleteTopicRuleInput struct {

	// The name of the rule.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeleteTopicRule operation.

func (DeleteTopicRuleInput) GoString

func (s DeleteTopicRuleInput) GoString() string

GoString returns the string representation

func (DeleteTopicRuleInput) String

func (s DeleteTopicRuleInput) String() string

String returns the string representation

func (*DeleteTopicRuleInput) Validate

func (s *DeleteTopicRuleInput) Validate() error

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

type DeleteTopicRuleOutput

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

func (DeleteTopicRuleOutput) GoString

func (s DeleteTopicRuleOutput) GoString() string

GoString returns the string representation

func (DeleteTopicRuleOutput) String

func (s DeleteTopicRuleOutput) String() string

String returns the string representation

type DescribeCACertificateInput

type DescribeCACertificateInput struct {

	// The CA certificate identifier.
	CertificateId *string `location:"uri" locationName:"caCertificateId" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DescribeCACertificate operation.

func (DescribeCACertificateInput) GoString

func (s DescribeCACertificateInput) GoString() string

GoString returns the string representation

func (DescribeCACertificateInput) String

String returns the string representation

func (*DescribeCACertificateInput) Validate

func (s *DescribeCACertificateInput) Validate() error

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

type DescribeCACertificateOutput

type DescribeCACertificateOutput struct {

	// The CA certificate description.
	CertificateDescription *CACertificateDescription `locationName:"certificateDescription" type:"structure"`
	// contains filtered or unexported fields
}

The output from the DescribeCACertificate operation.

func (DescribeCACertificateOutput) GoString

func (s DescribeCACertificateOutput) GoString() string

GoString returns the string representation

func (DescribeCACertificateOutput) String

String returns the string representation

type DescribeCertificateInput

type DescribeCertificateInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DescribeCertificate operation.

func (DescribeCertificateInput) GoString

func (s DescribeCertificateInput) GoString() string

GoString returns the string representation

func (DescribeCertificateInput) String

func (s DescribeCertificateInput) String() string

String returns the string representation

func (*DescribeCertificateInput) Validate

func (s *DescribeCertificateInput) Validate() error

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

type DescribeCertificateOutput

type DescribeCertificateOutput struct {

	// The description of the certificate.
	CertificateDescription *CertificateDescription `locationName:"certificateDescription" type:"structure"`
	// contains filtered or unexported fields
}

The output of the DescribeCertificate operation.

func (DescribeCertificateOutput) GoString

func (s DescribeCertificateOutput) GoString() string

GoString returns the string representation

func (DescribeCertificateOutput) String

func (s DescribeCertificateOutput) String() string

String returns the string representation

type DescribeEndpointInput

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

The input for the DescribeEndpoint operation.

func (DescribeEndpointInput) GoString

func (s DescribeEndpointInput) GoString() string

GoString returns the string representation

func (DescribeEndpointInput) String

func (s DescribeEndpointInput) String() string

String returns the string representation

type DescribeEndpointOutput

type DescribeEndpointOutput struct {

	// The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
	EndpointAddress *string `locationName:"endpointAddress" type:"string"`
	// contains filtered or unexported fields
}

The output from the DescribeEndpoint operation.

func (DescribeEndpointOutput) GoString

func (s DescribeEndpointOutput) GoString() string

GoString returns the string representation

func (DescribeEndpointOutput) String

func (s DescribeEndpointOutput) String() string

String returns the string representation

type DescribeThingInput

type DescribeThingInput struct {

	// The name of the thing.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DescribeThing operation.

func (DescribeThingInput) GoString

func (s DescribeThingInput) GoString() string

GoString returns the string representation

func (DescribeThingInput) String

func (s DescribeThingInput) String() string

String returns the string representation

func (*DescribeThingInput) Validate

func (s *DescribeThingInput) Validate() error

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

type DescribeThingOutput

type DescribeThingOutput struct {

	// The attributes, which are name/value pairs in JSON format (for example: {\"attributes\":{\"some-name1\":\"some-value1\"},
	// {\"some-name2\":\"some-value2\"}, {\"some-name3\":\"some-value3\"}})
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// The default client ID.
	DefaultClientId *string `locationName:"defaultClientId" type:"string"`

	// The name of the thing.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output from the DescribeThing operation.

func (DescribeThingOutput) GoString

func (s DescribeThingOutput) GoString() string

GoString returns the string representation

func (DescribeThingOutput) String

func (s DescribeThingOutput) String() string

String returns the string representation

type DetachPrincipalPolicyInput

type DetachPrincipalPolicyInput struct {

	// The name of the policy to detach.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The principal.
	//
	// If the principal is a certificate, specify the certificate ARN. If the principal
	// is an Amazon Cognito identity, specify the identity ID.
	Principal *string `location:"header" locationName:"x-amzn-iot-principal" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DetachPrincipalPolicy operation.

func (DetachPrincipalPolicyInput) GoString

func (s DetachPrincipalPolicyInput) GoString() string

GoString returns the string representation

func (DetachPrincipalPolicyInput) String

String returns the string representation

func (*DetachPrincipalPolicyInput) Validate

func (s *DetachPrincipalPolicyInput) Validate() error

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

type DetachPrincipalPolicyOutput

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

func (DetachPrincipalPolicyOutput) GoString

func (s DetachPrincipalPolicyOutput) GoString() string

GoString returns the string representation

func (DetachPrincipalPolicyOutput) String

String returns the string representation

type DetachThingPrincipalInput

type DetachThingPrincipalInput struct {

	// The principal.
	//
	// If the principal is a certificate, specify the certificate ARN. If the principal
	// is an Amazon Cognito identity, specify the identity ID.
	Principal *string `location:"header" locationName:"x-amzn-principal" type:"string" required:"true"`

	// The name of the thing.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DetachThingPrincipal operation.

func (DetachThingPrincipalInput) GoString

func (s DetachThingPrincipalInput) GoString() string

GoString returns the string representation

func (DetachThingPrincipalInput) String

func (s DetachThingPrincipalInput) String() string

String returns the string representation

func (*DetachThingPrincipalInput) Validate

func (s *DetachThingPrincipalInput) Validate() error

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

type DetachThingPrincipalOutput

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

The output from the DetachThingPrincipal operation.

func (DetachThingPrincipalOutput) GoString

func (s DetachThingPrincipalOutput) GoString() string

GoString returns the string representation

func (DetachThingPrincipalOutput) String

String returns the string representation

type DisableTopicRuleInput

type DisableTopicRuleInput struct {

	// The name of the rule to disable.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DisableTopicRuleRequest operation.

func (DisableTopicRuleInput) GoString

func (s DisableTopicRuleInput) GoString() string

GoString returns the string representation

func (DisableTopicRuleInput) String

func (s DisableTopicRuleInput) String() string

String returns the string representation

func (*DisableTopicRuleInput) Validate

func (s *DisableTopicRuleInput) Validate() error

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

type DisableTopicRuleOutput

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

func (DisableTopicRuleOutput) GoString

func (s DisableTopicRuleOutput) GoString() string

GoString returns the string representation

func (DisableTopicRuleOutput) String

func (s DisableTopicRuleOutput) String() string

String returns the string representation

type DynamoDBAction

type DynamoDBAction struct {

	// The hash key name.
	HashKeyField *string `locationName:"hashKeyField" type:"string" required:"true"`

	// The hash key type. Valid values are "STRING" or "NUMBER"
	HashKeyType *string `locationName:"hashKeyType" type:"string" enum:"DynamoKeyType"`

	// The hash key value.
	HashKeyValue *string `locationName:"hashKeyValue" type:"string" required:"true"`

	// The action payload. This name can be customized.
	PayloadField *string `locationName:"payloadField" type:"string"`

	// The range key name.
	RangeKeyField *string `locationName:"rangeKeyField" type:"string"`

	// The range key type. Valid values are "STRING" or "NUMBER"
	RangeKeyType *string `locationName:"rangeKeyType" type:"string" enum:"DynamoKeyType"`

	// The range key value.
	RangeKeyValue *string `locationName:"rangeKeyValue" type:"string"`

	// The ARN of the IAM role that grants access to the DynamoDB table.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the DynamoDB table.
	TableName *string `locationName:"tableName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

func (DynamoDBAction) GoString

func (s DynamoDBAction) GoString() string

GoString returns the string representation

func (DynamoDBAction) String

func (s DynamoDBAction) String() string

String returns the string representation

func (*DynamoDBAction) Validate

func (s *DynamoDBAction) Validate() error

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

type ElasticsearchAction

type ElasticsearchAction struct {

	// The endpoint of your Elasticsearch domain.
	Endpoint *string `locationName:"endpoint" type:"string" required:"true"`

	// The unique identifier for the document you are storing.
	Id *string `locationName:"id" type:"string" required:"true"`

	// The Elasticsearch index where you want to store your data.
	Index *string `locationName:"index" type:"string" required:"true"`

	// The IAM role ARN that has access to Elasticsearch.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The type of document you are storing.
	Type *string `locationName:"type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action that writes data to an Amazon Elasticsearch Service; domain.

func (ElasticsearchAction) GoString

func (s ElasticsearchAction) GoString() string

GoString returns the string representation

func (ElasticsearchAction) String

func (s ElasticsearchAction) String() string

String returns the string representation

func (*ElasticsearchAction) Validate

func (s *ElasticsearchAction) Validate() error

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

type EnableTopicRuleInput

type EnableTopicRuleInput struct {

	// The name of the topic rule to enable.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the EnableTopicRuleRequest operation.

func (EnableTopicRuleInput) GoString

func (s EnableTopicRuleInput) GoString() string

GoString returns the string representation

func (EnableTopicRuleInput) String

func (s EnableTopicRuleInput) String() string

String returns the string representation

func (*EnableTopicRuleInput) Validate

func (s *EnableTopicRuleInput) Validate() error

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

type EnableTopicRuleOutput

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

func (EnableTopicRuleOutput) GoString

func (s EnableTopicRuleOutput) GoString() string

GoString returns the string representation

func (EnableTopicRuleOutput) String

func (s EnableTopicRuleOutput) String() string

String returns the string representation

type FirehoseAction

type FirehoseAction struct {

	// The delivery stream name.
	DeliveryStreamName *string `locationName:"deliveryStreamName" type:"string" required:"true"`

	// The IAM role that grants access to the Amazon Kinesis Firehost stream.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action that writes data to an Amazon Kinesis Firehose stream.

func (FirehoseAction) GoString

func (s FirehoseAction) GoString() string

GoString returns the string representation

func (FirehoseAction) String

func (s FirehoseAction) String() string

String returns the string representation

func (*FirehoseAction) Validate

func (s *FirehoseAction) Validate() error

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

type GetLoggingOptionsInput

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

The input for the GetLoggingOptions operation.

func (GetLoggingOptionsInput) GoString

func (s GetLoggingOptionsInput) GoString() string

GoString returns the string representation

func (GetLoggingOptionsInput) String

func (s GetLoggingOptionsInput) String() string

String returns the string representation

type GetLoggingOptionsOutput

type GetLoggingOptionsOutput struct {

	// The logging level.
	LogLevel *string `locationName:"logLevel" type:"string" enum:"LogLevel"`

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

The output from the GetLoggingOptions operation.

func (GetLoggingOptionsOutput) GoString

func (s GetLoggingOptionsOutput) GoString() string

GoString returns the string representation

func (GetLoggingOptionsOutput) String

func (s GetLoggingOptionsOutput) String() string

String returns the string representation

type GetPolicyInput

type GetPolicyInput struct {

	// The name of the policy.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetPolicy operation.

func (GetPolicyInput) GoString

func (s GetPolicyInput) GoString() string

GoString returns the string representation

func (GetPolicyInput) String

func (s GetPolicyInput) String() string

String returns the string representation

func (*GetPolicyInput) Validate

func (s *GetPolicyInput) Validate() error

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

type GetPolicyOutput

type GetPolicyOutput struct {

	// The default policy version ID.
	DefaultVersionId *string `locationName:"defaultVersionId" type:"string"`

	// The policy ARN.
	PolicyArn *string `locationName:"policyArn" type:"string"`

	// The JSON document that describes the policy.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

	// The policy name.
	PolicyName *string `locationName:"policyName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output from the GetPolicy operation.

func (GetPolicyOutput) GoString

func (s GetPolicyOutput) GoString() string

GoString returns the string representation

func (GetPolicyOutput) String

func (s GetPolicyOutput) String() string

String returns the string representation

type GetPolicyVersionInput

type GetPolicyVersionInput struct {

	// The name of the policy.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The policy version ID.
	PolicyVersionId *string `location:"uri" locationName:"policyVersionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetPolicyVersion operation.

func (GetPolicyVersionInput) GoString

func (s GetPolicyVersionInput) GoString() string

GoString returns the string representation

func (GetPolicyVersionInput) String

func (s GetPolicyVersionInput) String() string

String returns the string representation

func (*GetPolicyVersionInput) Validate

func (s *GetPolicyVersionInput) Validate() error

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

type GetPolicyVersionOutput

type GetPolicyVersionOutput struct {

	// Specifies whether the policy version is the default.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The policy ARN.
	PolicyArn *string `locationName:"policyArn" type:"string"`

	// The JSON document that describes the policy.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

	// The policy name.
	PolicyName *string `locationName:"policyName" min:"1" type:"string"`

	// The policy version ID.
	PolicyVersionId *string `locationName:"policyVersionId" type:"string"`
	// contains filtered or unexported fields
}

The output from the GetPolicyVersion operation.

func (GetPolicyVersionOutput) GoString

func (s GetPolicyVersionOutput) GoString() string

GoString returns the string representation

func (GetPolicyVersionOutput) String

func (s GetPolicyVersionOutput) String() string

String returns the string representation

type GetRegistrationCodeInput

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

The input to the GetRegistrationCode operation.

func (GetRegistrationCodeInput) GoString

func (s GetRegistrationCodeInput) GoString() string

GoString returns the string representation

func (GetRegistrationCodeInput) String

func (s GetRegistrationCodeInput) String() string

String returns the string representation

type GetRegistrationCodeOutput

type GetRegistrationCodeOutput struct {

	// The CA certificate registration code.
	RegistrationCode *string `locationName:"registrationCode" min:"64" type:"string"`
	// contains filtered or unexported fields
}

The output from the GetRegistrationCode operation.

func (GetRegistrationCodeOutput) GoString

func (s GetRegistrationCodeOutput) GoString() string

GoString returns the string representation

func (GetRegistrationCodeOutput) String

func (s GetRegistrationCodeOutput) String() string

String returns the string representation

type GetTopicRuleInput

type GetTopicRuleInput struct {

	// The name of the rule.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetTopicRule operation.

func (GetTopicRuleInput) GoString

func (s GetTopicRuleInput) GoString() string

GoString returns the string representation

func (GetTopicRuleInput) String

func (s GetTopicRuleInput) String() string

String returns the string representation

func (*GetTopicRuleInput) Validate

func (s *GetTopicRuleInput) Validate() error

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

type GetTopicRuleOutput

type GetTopicRuleOutput struct {

	// The rule.
	Rule *TopicRule `locationName:"rule" type:"structure"`

	// The rule ARN.
	RuleArn *string `locationName:"ruleArn" type:"string"`
	// contains filtered or unexported fields
}

The output from the GetTopicRule operation.

func (GetTopicRuleOutput) GoString

func (s GetTopicRuleOutput) GoString() string

GoString returns the string representation

func (GetTopicRuleOutput) String

func (s GetTopicRuleOutput) String() string

String returns the string representation

type IoT

type IoT struct {
	*client.Client
}

AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.

For more information about how AWS IoT works, see the Developer Guide (http://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoT

New creates a new instance of the IoT client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a IoT client from just a session.
svc := iot.New(mySession)

// Create a IoT client with additional configuration
svc := iot.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoT) AcceptCertificateTransfer

func (c *IoT) AcceptCertificateTransfer(input *AcceptCertificateTransferInput) (*AcceptCertificateTransferOutput, error)

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

Example
Output:

func (*IoT) AcceptCertificateTransferRequest

func (c *IoT) AcceptCertificateTransferRequest(input *AcceptCertificateTransferInput) (req *request.Request, output *AcceptCertificateTransferOutput)

AcceptCertificateTransferRequest generates a request for the AcceptCertificateTransfer operation.

func (*IoT) AttachPrincipalPolicy

func (c *IoT) AttachPrincipalPolicy(input *AttachPrincipalPolicyInput) (*AttachPrincipalPolicyOutput, error)

Attaches the specified policy to the specified principal (certificate or other credential).

Example
Output:

func (*IoT) AttachPrincipalPolicyRequest

func (c *IoT) AttachPrincipalPolicyRequest(input *AttachPrincipalPolicyInput) (req *request.Request, output *AttachPrincipalPolicyOutput)

AttachPrincipalPolicyRequest generates a request for the AttachPrincipalPolicy operation.

func (*IoT) AttachThingPrincipal

func (c *IoT) AttachThingPrincipal(input *AttachThingPrincipalInput) (*AttachThingPrincipalOutput, error)

Attaches the specified principal to the specified thing.

Example
Output:

func (*IoT) AttachThingPrincipalRequest

func (c *IoT) AttachThingPrincipalRequest(input *AttachThingPrincipalInput) (req *request.Request, output *AttachThingPrincipalOutput)

AttachThingPrincipalRequest generates a request for the AttachThingPrincipal operation.

func (*IoT) CancelCertificateTransfer

func (c *IoT) CancelCertificateTransfer(input *CancelCertificateTransferInput) (*CancelCertificateTransferOutput, error)

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Example
Output:

func (*IoT) CancelCertificateTransferRequest

func (c *IoT) CancelCertificateTransferRequest(input *CancelCertificateTransferInput) (req *request.Request, output *CancelCertificateTransferOutput)

CancelCertificateTransferRequest generates a request for the CancelCertificateTransfer operation.

func (*IoT) CreateCertificateFromCsr

func (c *IoT) CreateCertificateFromCsr(input *CreateCertificateFromCsrInput) (*CreateCertificateFromCsrOutput, error)

Creates an X.509 certificate using the specified certificate signing request.

Note Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR

file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be

run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr

--certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs

in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request

file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all

CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr

--certificate-signing-request file://@path"

Example
Output:

func (*IoT) CreateCertificateFromCsrRequest

func (c *IoT) CreateCertificateFromCsrRequest(input *CreateCertificateFromCsrInput) (req *request.Request, output *CreateCertificateFromCsrOutput)

CreateCertificateFromCsrRequest generates a request for the CreateCertificateFromCsr operation.

func (*IoT) CreateKeysAndCertificate

func (c *IoT) CreateKeysAndCertificate(input *CreateKeysAndCertificateInput) (*CreateKeysAndCertificateOutput, error)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Example
Output:

func (*IoT) CreateKeysAndCertificateRequest

func (c *IoT) CreateKeysAndCertificateRequest(input *CreateKeysAndCertificateInput) (req *request.Request, output *CreateKeysAndCertificateOutput)

CreateKeysAndCertificateRequest generates a request for the CreateKeysAndCertificate operation.

func (*IoT) CreatePolicy

func (c *IoT) CreatePolicy(input *CreatePolicyInput) (*CreatePolicyOutput, error)

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

Example
Output:

func (*IoT) CreatePolicyRequest

func (c *IoT) CreatePolicyRequest(input *CreatePolicyInput) (req *request.Request, output *CreatePolicyOutput)

CreatePolicyRequest generates a request for the CreatePolicy operation.

func (*IoT) CreatePolicyVersion

func (c *IoT) CreatePolicyVersion(input *CreatePolicyVersionInput) (*CreatePolicyVersionOutput, error)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Example
Output:

func (*IoT) CreatePolicyVersionRequest

func (c *IoT) CreatePolicyVersionRequest(input *CreatePolicyVersionInput) (req *request.Request, output *CreatePolicyVersionOutput)

CreatePolicyVersionRequest generates a request for the CreatePolicyVersion operation.

func (*IoT) CreateThing

func (c *IoT) CreateThing(input *CreateThingInput) (*CreateThingOutput, error)

Creates a thing in the Thing Registry.

Example
Output:

func (*IoT) CreateThingRequest

func (c *IoT) CreateThingRequest(input *CreateThingInput) (req *request.Request, output *CreateThingOutput)

CreateThingRequest generates a request for the CreateThing operation.

func (*IoT) CreateTopicRule

func (c *IoT) CreateTopicRule(input *CreateTopicRuleInput) (*CreateTopicRuleOutput, error)

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Example
Output:

func (*IoT) CreateTopicRuleRequest

func (c *IoT) CreateTopicRuleRequest(input *CreateTopicRuleInput) (req *request.Request, output *CreateTopicRuleOutput)

CreateTopicRuleRequest generates a request for the CreateTopicRule operation.

func (*IoT) DeleteCACertificate

func (c *IoT) DeleteCACertificate(input *DeleteCACertificateInput) (*DeleteCACertificateOutput, error)

Deletes a registered CA certificate.

Example
Output:

func (*IoT) DeleteCACertificateRequest

func (c *IoT) DeleteCACertificateRequest(input *DeleteCACertificateInput) (req *request.Request, output *DeleteCACertificateOutput)

DeleteCACertificateRequest generates a request for the DeleteCACertificate operation.

func (*IoT) DeleteCertificate

func (c *IoT) DeleteCertificate(input *DeleteCertificateInput) (*DeleteCertificateOutput, error)

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

Example
Output:

func (*IoT) DeleteCertificateRequest

func (c *IoT) DeleteCertificateRequest(input *DeleteCertificateInput) (req *request.Request, output *DeleteCertificateOutput)

DeleteCertificateRequest generates a request for the DeleteCertificate operation.

func (*IoT) DeletePolicy

func (c *IoT) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error)

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Example
Output:

func (*IoT) DeletePolicyRequest

func (c *IoT) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput)

DeletePolicyRequest generates a request for the DeletePolicy operation.

func (*IoT) DeletePolicyVersion

func (c *IoT) DeletePolicyVersion(input *DeletePolicyVersionInput) (*DeletePolicyVersionOutput, error)

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Example
Output:

func (*IoT) DeletePolicyVersionRequest

func (c *IoT) DeletePolicyVersionRequest(input *DeletePolicyVersionInput) (req *request.Request, output *DeletePolicyVersionOutput)

DeletePolicyVersionRequest generates a request for the DeletePolicyVersion operation.

func (*IoT) DeleteRegistrationCode

func (c *IoT) DeleteRegistrationCode(input *DeleteRegistrationCodeInput) (*DeleteRegistrationCodeOutput, error)

Deletes a CA certificate registration code.

Example
Output:

func (*IoT) DeleteRegistrationCodeRequest

func (c *IoT) DeleteRegistrationCodeRequest(input *DeleteRegistrationCodeInput) (req *request.Request, output *DeleteRegistrationCodeOutput)

DeleteRegistrationCodeRequest generates a request for the DeleteRegistrationCode operation.

func (*IoT) DeleteThing

func (c *IoT) DeleteThing(input *DeleteThingInput) (*DeleteThingOutput, error)

Deletes the specified thing from the Thing Registry.

Example
Output:

func (*IoT) DeleteThingRequest

func (c *IoT) DeleteThingRequest(input *DeleteThingInput) (req *request.Request, output *DeleteThingOutput)

DeleteThingRequest generates a request for the DeleteThing operation.

func (*IoT) DeleteTopicRule

func (c *IoT) DeleteTopicRule(input *DeleteTopicRuleInput) (*DeleteTopicRuleOutput, error)

Deletes the specified rule.

Example
Output:

func (*IoT) DeleteTopicRuleRequest

func (c *IoT) DeleteTopicRuleRequest(input *DeleteTopicRuleInput) (req *request.Request, output *DeleteTopicRuleOutput)

DeleteTopicRuleRequest generates a request for the DeleteTopicRule operation.

func (*IoT) DescribeCACertificate

func (c *IoT) DescribeCACertificate(input *DescribeCACertificateInput) (*DescribeCACertificateOutput, error)

Describes a registered CA certificate.

Example
Output:

func (*IoT) DescribeCACertificateRequest

func (c *IoT) DescribeCACertificateRequest(input *DescribeCACertificateInput) (req *request.Request, output *DescribeCACertificateOutput)

DescribeCACertificateRequest generates a request for the DescribeCACertificate operation.

func (*IoT) DescribeCertificate

func (c *IoT) DescribeCertificate(input *DescribeCertificateInput) (*DescribeCertificateOutput, error)

Gets information about the specified certificate.

Example
Output:

func (*IoT) DescribeCertificateRequest

func (c *IoT) DescribeCertificateRequest(input *DescribeCertificateInput) (req *request.Request, output *DescribeCertificateOutput)

DescribeCertificateRequest generates a request for the DescribeCertificate operation.

func (*IoT) DescribeEndpoint

func (c *IoT) DescribeEndpoint(input *DescribeEndpointInput) (*DescribeEndpointOutput, error)

Returns a unique endpoint specific to the AWS account making the call.

Example
Output:

func (*IoT) DescribeEndpointRequest

func (c *IoT) DescribeEndpointRequest(input *DescribeEndpointInput) (req *request.Request, output *DescribeEndpointOutput)

DescribeEndpointRequest generates a request for the DescribeEndpoint operation.

func (*IoT) DescribeThing

func (c *IoT) DescribeThing(input *DescribeThingInput) (*DescribeThingOutput, error)

Gets information about the specified thing.

Example
Output:

func (*IoT) DescribeThingRequest

func (c *IoT) DescribeThingRequest(input *DescribeThingInput) (req *request.Request, output *DescribeThingOutput)

DescribeThingRequest generates a request for the DescribeThing operation.

func (*IoT) DetachPrincipalPolicy

func (c *IoT) DetachPrincipalPolicy(input *DetachPrincipalPolicyInput) (*DetachPrincipalPolicyOutput, error)

Removes the specified policy from the specified certificate.

Example
Output:

func (*IoT) DetachPrincipalPolicyRequest

func (c *IoT) DetachPrincipalPolicyRequest(input *DetachPrincipalPolicyInput) (req *request.Request, output *DetachPrincipalPolicyOutput)

DetachPrincipalPolicyRequest generates a request for the DetachPrincipalPolicy operation.

func (*IoT) DetachThingPrincipal

func (c *IoT) DetachThingPrincipal(input *DetachThingPrincipalInput) (*DetachThingPrincipalOutput, error)

Detaches the specified principal from the specified thing.

Example
Output:

func (*IoT) DetachThingPrincipalRequest

func (c *IoT) DetachThingPrincipalRequest(input *DetachThingPrincipalInput) (req *request.Request, output *DetachThingPrincipalOutput)

DetachThingPrincipalRequest generates a request for the DetachThingPrincipal operation.

func (*IoT) DisableTopicRule

func (c *IoT) DisableTopicRule(input *DisableTopicRuleInput) (*DisableTopicRuleOutput, error)

Disables the specified rule.

Example
Output:

func (*IoT) DisableTopicRuleRequest

func (c *IoT) DisableTopicRuleRequest(input *DisableTopicRuleInput) (req *request.Request, output *DisableTopicRuleOutput)

DisableTopicRuleRequest generates a request for the DisableTopicRule operation.

func (*IoT) EnableTopicRule

func (c *IoT) EnableTopicRule(input *EnableTopicRuleInput) (*EnableTopicRuleOutput, error)

Enables the specified rule.

Example
Output:

func (*IoT) EnableTopicRuleRequest

func (c *IoT) EnableTopicRuleRequest(input *EnableTopicRuleInput) (req *request.Request, output *EnableTopicRuleOutput)

EnableTopicRuleRequest generates a request for the EnableTopicRule operation.

func (*IoT) GetLoggingOptions

func (c *IoT) GetLoggingOptions(input *GetLoggingOptionsInput) (*GetLoggingOptionsOutput, error)

Gets the logging options.

Example
Output:

func (*IoT) GetLoggingOptionsRequest

func (c *IoT) GetLoggingOptionsRequest(input *GetLoggingOptionsInput) (req *request.Request, output *GetLoggingOptionsOutput)

GetLoggingOptionsRequest generates a request for the GetLoggingOptions operation.

func (*IoT) GetPolicy

func (c *IoT) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error)

Gets information about the specified policy with the policy document of the default version.

Example
Output:

func (*IoT) GetPolicyRequest

func (c *IoT) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, output *GetPolicyOutput)

GetPolicyRequest generates a request for the GetPolicy operation.

func (*IoT) GetPolicyVersion

func (c *IoT) GetPolicyVersion(input *GetPolicyVersionInput) (*GetPolicyVersionOutput, error)

Gets information about the specified policy version.

Example
Output:

func (*IoT) GetPolicyVersionRequest

func (c *IoT) GetPolicyVersionRequest(input *GetPolicyVersionInput) (req *request.Request, output *GetPolicyVersionOutput)

GetPolicyVersionRequest generates a request for the GetPolicyVersion operation.

func (*IoT) GetRegistrationCode

func (c *IoT) GetRegistrationCode(input *GetRegistrationCodeInput) (*GetRegistrationCodeOutput, error)

Gets a registration code used to register a CA certificate with AWS IoT.

Example
Output:

func (*IoT) GetRegistrationCodeRequest

func (c *IoT) GetRegistrationCodeRequest(input *GetRegistrationCodeInput) (req *request.Request, output *GetRegistrationCodeOutput)

GetRegistrationCodeRequest generates a request for the GetRegistrationCode operation.

func (*IoT) GetTopicRule

func (c *IoT) GetTopicRule(input *GetTopicRuleInput) (*GetTopicRuleOutput, error)

Gets information about the specified rule.

Example
Output:

func (*IoT) GetTopicRuleRequest

func (c *IoT) GetTopicRuleRequest(input *GetTopicRuleInput) (req *request.Request, output *GetTopicRuleOutput)

GetTopicRuleRequest generates a request for the GetTopicRule operation.

func (*IoT) ListCACertificates

func (c *IoT) ListCACertificates(input *ListCACertificatesInput) (*ListCACertificatesOutput, error)

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Example
Output:

func (*IoT) ListCACertificatesRequest

func (c *IoT) ListCACertificatesRequest(input *ListCACertificatesInput) (req *request.Request, output *ListCACertificatesOutput)

ListCACertificatesRequest generates a request for the ListCACertificates operation.

func (*IoT) ListCertificates

func (c *IoT) ListCertificates(input *ListCertificatesInput) (*ListCertificatesOutput, error)

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Example
Output:

func (*IoT) ListCertificatesByCA

func (c *IoT) ListCertificatesByCA(input *ListCertificatesByCAInput) (*ListCertificatesByCAOutput, error)

List the device certificates signed by the specified CA certificate.

Example
Output:

func (*IoT) ListCertificatesByCARequest

func (c *IoT) ListCertificatesByCARequest(input *ListCertificatesByCAInput) (req *request.Request, output *ListCertificatesByCAOutput)

ListCertificatesByCARequest generates a request for the ListCertificatesByCA operation.

func (*IoT) ListCertificatesRequest

func (c *IoT) ListCertificatesRequest(input *ListCertificatesInput) (req *request.Request, output *ListCertificatesOutput)

ListCertificatesRequest generates a request for the ListCertificates operation.

func (*IoT) ListPolicies

func (c *IoT) ListPolicies(input *ListPoliciesInput) (*ListPoliciesOutput, error)

Lists your policies.

Example
Output:

func (*IoT) ListPoliciesRequest

func (c *IoT) ListPoliciesRequest(input *ListPoliciesInput) (req *request.Request, output *ListPoliciesOutput)

ListPoliciesRequest generates a request for the ListPolicies operation.

func (*IoT) ListPolicyPrincipals

func (c *IoT) ListPolicyPrincipals(input *ListPolicyPrincipalsInput) (*ListPolicyPrincipalsOutput, error)

Lists the principals associated with the specified policy.

Example
Output:

func (*IoT) ListPolicyPrincipalsRequest

func (c *IoT) ListPolicyPrincipalsRequest(input *ListPolicyPrincipalsInput) (req *request.Request, output *ListPolicyPrincipalsOutput)

ListPolicyPrincipalsRequest generates a request for the ListPolicyPrincipals operation.

func (*IoT) ListPolicyVersions

func (c *IoT) ListPolicyVersions(input *ListPolicyVersionsInput) (*ListPolicyVersionsOutput, error)

Lists the versions of the specified policy and identifies the default version.

Example
Output:

func (*IoT) ListPolicyVersionsRequest

func (c *IoT) ListPolicyVersionsRequest(input *ListPolicyVersionsInput) (req *request.Request, output *ListPolicyVersionsOutput)

ListPolicyVersionsRequest generates a request for the ListPolicyVersions operation.

func (*IoT) ListPrincipalPolicies

func (c *IoT) ListPrincipalPolicies(input *ListPrincipalPoliciesInput) (*ListPrincipalPoliciesOutput, error)

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax).

Example
Output:

func (*IoT) ListPrincipalPoliciesRequest

func (c *IoT) ListPrincipalPoliciesRequest(input *ListPrincipalPoliciesInput) (req *request.Request, output *ListPrincipalPoliciesOutput)

ListPrincipalPoliciesRequest generates a request for the ListPrincipalPolicies operation.

func (*IoT) ListPrincipalThings

func (c *IoT) ListPrincipalThings(input *ListPrincipalThingsInput) (*ListPrincipalThingsOutput, error)

Lists the things associated with the specified principal.

Example
Output:

func (*IoT) ListPrincipalThingsRequest

func (c *IoT) ListPrincipalThingsRequest(input *ListPrincipalThingsInput) (req *request.Request, output *ListPrincipalThingsOutput)

ListPrincipalThingsRequest generates a request for the ListPrincipalThings operation.

func (*IoT) ListThingPrincipals

func (c *IoT) ListThingPrincipals(input *ListThingPrincipalsInput) (*ListThingPrincipalsOutput, error)

Lists the principals associated with the specified thing.

Example
Output:

func (*IoT) ListThingPrincipalsRequest

func (c *IoT) ListThingPrincipalsRequest(input *ListThingPrincipalsInput) (req *request.Request, output *ListThingPrincipalsOutput)

ListThingPrincipalsRequest generates a request for the ListThingPrincipals operation.

func (*IoT) ListThings

func (c *IoT) ListThings(input *ListThingsInput) (*ListThingsOutput, error)

Lists your things. You can pass an AttributeName or AttributeValue to filter your things (for example, "ListThings where AttributeName=Color and AttributeValue=Red").

Example
Output:

func (*IoT) ListThingsRequest

func (c *IoT) ListThingsRequest(input *ListThingsInput) (req *request.Request, output *ListThingsOutput)

ListThingsRequest generates a request for the ListThings operation.

func (*IoT) ListTopicRules

func (c *IoT) ListTopicRules(input *ListTopicRulesInput) (*ListTopicRulesOutput, error)

Lists the rules for the specific topic.

Example
Output:

func (*IoT) ListTopicRulesRequest

func (c *IoT) ListTopicRulesRequest(input *ListTopicRulesInput) (req *request.Request, output *ListTopicRulesOutput)

ListTopicRulesRequest generates a request for the ListTopicRules operation.

func (*IoT) RegisterCACertificate

func (c *IoT) RegisterCACertificate(input *RegisterCACertificateInput) (*RegisterCACertificateOutput, error)

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field and public key. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

Example
Output:

func (*IoT) RegisterCACertificateRequest

func (c *IoT) RegisterCACertificateRequest(input *RegisterCACertificateInput) (req *request.Request, output *RegisterCACertificateOutput)

RegisterCACertificateRequest generates a request for the RegisterCACertificate operation.

func (*IoT) RegisterCertificate

func (c *IoT) RegisterCertificate(input *RegisterCertificateInput) (*RegisterCertificateOutput, error)

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

Example
Output:

func (*IoT) RegisterCertificateRequest

func (c *IoT) RegisterCertificateRequest(input *RegisterCertificateInput) (req *request.Request, output *RegisterCertificateOutput)

RegisterCertificateRequest generates a request for the RegisterCertificate operation.

func (*IoT) RejectCertificateTransfer

func (c *IoT) RejectCertificateTransfer(input *RejectCertificateTransferInput) (*RejectCertificateTransferOutput, error)

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Example
Output:

func (*IoT) RejectCertificateTransferRequest

func (c *IoT) RejectCertificateTransferRequest(input *RejectCertificateTransferInput) (req *request.Request, output *RejectCertificateTransferOutput)

RejectCertificateTransferRequest generates a request for the RejectCertificateTransfer operation.

func (*IoT) ReplaceTopicRule

func (c *IoT) ReplaceTopicRule(input *ReplaceTopicRuleInput) (*ReplaceTopicRuleOutput, error)

Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Example
Output:

func (*IoT) ReplaceTopicRuleRequest

func (c *IoT) ReplaceTopicRuleRequest(input *ReplaceTopicRuleInput) (req *request.Request, output *ReplaceTopicRuleOutput)

ReplaceTopicRuleRequest generates a request for the ReplaceTopicRule operation.

func (*IoT) SetDefaultPolicyVersion

func (c *IoT) SetDefaultPolicyVersion(input *SetDefaultPolicyVersionInput) (*SetDefaultPolicyVersionOutput, error)

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

Example
Output:

func (*IoT) SetDefaultPolicyVersionRequest

func (c *IoT) SetDefaultPolicyVersionRequest(input *SetDefaultPolicyVersionInput) (req *request.Request, output *SetDefaultPolicyVersionOutput)

SetDefaultPolicyVersionRequest generates a request for the SetDefaultPolicyVersion operation.

func (*IoT) SetLoggingOptions

func (c *IoT) SetLoggingOptions(input *SetLoggingOptionsInput) (*SetLoggingOptionsOutput, error)

Sets the logging options.

Example
Output:

func (*IoT) SetLoggingOptionsRequest

func (c *IoT) SetLoggingOptionsRequest(input *SetLoggingOptionsInput) (req *request.Request, output *SetLoggingOptionsOutput)

SetLoggingOptionsRequest generates a request for the SetLoggingOptions operation.

func (*IoT) TransferCertificate

func (c *IoT) TransferCertificate(input *TransferCertificateInput) (*TransferCertificateOutput, error)

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

Example
Output:

func (*IoT) TransferCertificateRequest

func (c *IoT) TransferCertificateRequest(input *TransferCertificateInput) (req *request.Request, output *TransferCertificateOutput)

TransferCertificateRequest generates a request for the TransferCertificate operation.

func (*IoT) UpdateCACertificate

func (c *IoT) UpdateCACertificate(input *UpdateCACertificateInput) (*UpdateCACertificateOutput, error)

Updates a registered CA certificate.

Example
Output:

func (*IoT) UpdateCACertificateRequest

func (c *IoT) UpdateCACertificateRequest(input *UpdateCACertificateInput) (req *request.Request, output *UpdateCACertificateOutput)

UpdateCACertificateRequest generates a request for the UpdateCACertificate operation.

func (*IoT) UpdateCertificate

func (c *IoT) UpdateCertificate(input *UpdateCertificateInput) (*UpdateCertificateOutput, error)

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Example
Output:

func (*IoT) UpdateCertificateRequest

func (c *IoT) UpdateCertificateRequest(input *UpdateCertificateInput) (req *request.Request, output *UpdateCertificateOutput)

UpdateCertificateRequest generates a request for the UpdateCertificate operation.

func (*IoT) UpdateThing

func (c *IoT) UpdateThing(input *UpdateThingInput) (*UpdateThingOutput, error)

Updates the data for a thing.

Example
Output:

func (*IoT) UpdateThingRequest

func (c *IoT) UpdateThingRequest(input *UpdateThingInput) (req *request.Request, output *UpdateThingOutput)

UpdateThingRequest generates a request for the UpdateThing operation.

type KeyPair

type KeyPair struct {

	// The private key.
	PrivateKey *string `min:"1" type:"string"`

	// The public key.
	PublicKey *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a key pair.

func (KeyPair) GoString

func (s KeyPair) GoString() string

GoString returns the string representation

func (KeyPair) String

func (s KeyPair) String() string

String returns the string representation

type KinesisAction

type KinesisAction struct {

	// The partition key.
	PartitionKey *string `locationName:"partitionKey" type:"string"`

	// The ARN of the IAM role that grants access to the Amazon Kinesis stream.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the Amazon Kinesis stream.
	StreamName *string `locationName:"streamName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to write data to an Amazon Kinesis stream.

func (KinesisAction) GoString

func (s KinesisAction) GoString() string

GoString returns the string representation

func (KinesisAction) String

func (s KinesisAction) String() string

String returns the string representation

func (*KinesisAction) Validate

func (s *KinesisAction) Validate() error

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

type LambdaAction

type LambdaAction struct {

	// The ARN of the Lambda function.
	FunctionArn *string `locationName:"functionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to invoke a Lambda function.

func (LambdaAction) GoString

func (s LambdaAction) GoString() string

GoString returns the string representation

func (LambdaAction) String

func (s LambdaAction) String() string

String returns the string representation

func (*LambdaAction) Validate

func (s *LambdaAction) Validate() error

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

type ListCACertificatesInput

type ListCACertificatesInput struct {

	// Determines the order of the results.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Input for the ListCACertificates operation.

func (ListCACertificatesInput) GoString

func (s ListCACertificatesInput) GoString() string

GoString returns the string representation

func (ListCACertificatesInput) String

func (s ListCACertificatesInput) String() string

String returns the string representation

func (*ListCACertificatesInput) Validate

func (s *ListCACertificatesInput) Validate() error

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

type ListCACertificatesOutput

type ListCACertificatesOutput struct {

	// The CA certificates registered in your AWS account.
	Certificates []*CACertificate `locationName:"certificates" type:"list"`

	// The current position within the list of CA certificates.
	NextMarker *string `locationName:"nextMarker" type:"string"`
	// contains filtered or unexported fields
}

The output from the ListCACertificates operation.

func (ListCACertificatesOutput) GoString

func (s ListCACertificatesOutput) GoString() string

GoString returns the string representation

func (ListCACertificatesOutput) String

func (s ListCACertificatesOutput) String() string

String returns the string representation

type ListCertificatesByCAInput

type ListCertificatesByCAInput struct {

	// Specifies the order for results. If True, the results are returned in ascending
	// order, based on the creation date.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The ID of the CA certificate. This operation will list all registered device
	// certificate that were signed by this CA certificate.
	CaCertificateId *string `location:"uri" locationName:"caCertificateId" min:"64" type:"string" required:"true"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The input to the ListCertificatesByCA operation.

func (ListCertificatesByCAInput) GoString

func (s ListCertificatesByCAInput) GoString() string

GoString returns the string representation

func (ListCertificatesByCAInput) String

func (s ListCertificatesByCAInput) String() string

String returns the string representation

func (*ListCertificatesByCAInput) Validate

func (s *ListCertificatesByCAInput) Validate() error

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

type ListCertificatesByCAOutput

type ListCertificatesByCAOutput struct {

	// The device certificates signed by the specified CA certificate.
	Certificates []*Certificate `locationName:"certificates" type:"list"`

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string `locationName:"nextMarker" type:"string"`
	// contains filtered or unexported fields
}

The output of the ListCertificatesByCA operation.

func (ListCertificatesByCAOutput) GoString

func (s ListCertificatesByCAOutput) GoString() string

GoString returns the string representation

func (ListCertificatesByCAOutput) String

String returns the string representation

type ListCertificatesInput

type ListCertificatesInput struct {

	// Specifies the order for results. If True, the results are returned in ascending
	// order, based on the creation date.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The input for the ListCertificates operation.

func (ListCertificatesInput) GoString

func (s ListCertificatesInput) GoString() string

GoString returns the string representation

func (ListCertificatesInput) String

func (s ListCertificatesInput) String() string

String returns the string representation

func (*ListCertificatesInput) Validate

func (s *ListCertificatesInput) Validate() error

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

type ListCertificatesOutput

type ListCertificatesOutput struct {

	// The descriptions of the certificates.
	Certificates []*Certificate `locationName:"certificates" type:"list"`

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string `locationName:"nextMarker" type:"string"`
	// contains filtered or unexported fields
}

The output of the ListCertificates operation.

func (ListCertificatesOutput) GoString

func (s ListCertificatesOutput) GoString() string

GoString returns the string representation

func (ListCertificatesOutput) String

func (s ListCertificatesOutput) String() string

String returns the string representation

type ListPoliciesInput

type ListPoliciesInput struct {

	// Specifies the order for results. If true, the results are returned in ascending
	// creation order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The input for the ListPolicies operation.

func (ListPoliciesInput) GoString

func (s ListPoliciesInput) GoString() string

GoString returns the string representation

func (ListPoliciesInput) String

func (s ListPoliciesInput) String() string

String returns the string representation

func (*ListPoliciesInput) Validate

func (s *ListPoliciesInput) Validate() error

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

type ListPoliciesOutput

type ListPoliciesOutput struct {

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The descriptions of the policies.
	Policies []*Policy `locationName:"policies" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListPolicies operation.

func (ListPoliciesOutput) GoString

func (s ListPoliciesOutput) GoString() string

GoString returns the string representation

func (ListPoliciesOutput) String

func (s ListPoliciesOutput) String() string

String returns the string representation

type ListPolicyPrincipalsInput

type ListPolicyPrincipalsInput struct {

	// Specifies the order for results. If true, the results are returned in ascending
	// creation order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

	// The policy name.
	PolicyName *string `location:"header" locationName:"x-amzn-iot-policy" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListPolicyPrincipals operation.

func (ListPolicyPrincipalsInput) GoString

func (s ListPolicyPrincipalsInput) GoString() string

GoString returns the string representation

func (ListPolicyPrincipalsInput) String

func (s ListPolicyPrincipalsInput) String() string

String returns the string representation

func (*ListPolicyPrincipalsInput) Validate

func (s *ListPolicyPrincipalsInput) Validate() error

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

type ListPolicyPrincipalsOutput

type ListPolicyPrincipalsOutput struct {

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The descriptions of the principals.
	Principals []*string `locationName:"principals" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListPolicyPrincipals operation.

func (ListPolicyPrincipalsOutput) GoString

func (s ListPolicyPrincipalsOutput) GoString() string

GoString returns the string representation

func (ListPolicyPrincipalsOutput) String

String returns the string representation

type ListPolicyVersionsInput

type ListPolicyVersionsInput struct {

	// The policy name.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListPolicyVersions operation.

func (ListPolicyVersionsInput) GoString

func (s ListPolicyVersionsInput) GoString() string

GoString returns the string representation

func (ListPolicyVersionsInput) String

func (s ListPolicyVersionsInput) String() string

String returns the string representation

func (*ListPolicyVersionsInput) Validate

func (s *ListPolicyVersionsInput) Validate() error

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

type ListPolicyVersionsOutput

type ListPolicyVersionsOutput struct {

	// The policy versions.
	PolicyVersions []*PolicyVersion `locationName:"policyVersions" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListPolicyVersions operation.

func (ListPolicyVersionsOutput) GoString

func (s ListPolicyVersionsOutput) GoString() string

GoString returns the string representation

func (ListPolicyVersionsOutput) String

func (s ListPolicyVersionsOutput) String() string

String returns the string representation

type ListPrincipalPoliciesInput

type ListPrincipalPoliciesInput struct {

	// Specifies the order for results. If true, results are returned in ascending
	// creation order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

	// The principal.
	Principal *string `location:"header" locationName:"x-amzn-iot-principal" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListPrincipalPolicies operation.

func (ListPrincipalPoliciesInput) GoString

func (s ListPrincipalPoliciesInput) GoString() string

GoString returns the string representation

func (ListPrincipalPoliciesInput) String

String returns the string representation

func (*ListPrincipalPoliciesInput) Validate

func (s *ListPrincipalPoliciesInput) Validate() error

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

type ListPrincipalPoliciesOutput

type ListPrincipalPoliciesOutput struct {

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The policies.
	Policies []*Policy `locationName:"policies" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListPrincipalPolicies operation.

func (ListPrincipalPoliciesOutput) GoString

func (s ListPrincipalPoliciesOutput) GoString() string

GoString returns the string representation

func (ListPrincipalPoliciesOutput) String

String returns the string representation

type ListPrincipalThingsInput

type ListPrincipalThingsInput struct {

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

	// A token used to retrieve the next value.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The principal.
	Principal *string `location:"header" locationName:"x-amzn-principal" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListPrincipalThings operation.

func (ListPrincipalThingsInput) GoString

func (s ListPrincipalThingsInput) GoString() string

GoString returns the string representation

func (ListPrincipalThingsInput) String

func (s ListPrincipalThingsInput) String() string

String returns the string representation

func (*ListPrincipalThingsInput) Validate

func (s *ListPrincipalThingsInput) Validate() error

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

type ListPrincipalThingsOutput

type ListPrincipalThingsOutput struct {

	// A token used to retrieve the next value.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The things.
	Things []*string `locationName:"things" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListPrincipalThings operation.

func (ListPrincipalThingsOutput) GoString

func (s ListPrincipalThingsOutput) GoString() string

GoString returns the string representation

func (ListPrincipalThingsOutput) String

func (s ListPrincipalThingsOutput) String() string

String returns the string representation

type ListThingPrincipalsInput

type ListThingPrincipalsInput struct {

	// The name of the thing.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListThingPrincipal operation.

func (ListThingPrincipalsInput) GoString

func (s ListThingPrincipalsInput) GoString() string

GoString returns the string representation

func (ListThingPrincipalsInput) String

func (s ListThingPrincipalsInput) String() string

String returns the string representation

func (*ListThingPrincipalsInput) Validate

func (s *ListThingPrincipalsInput) Validate() error

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

type ListThingPrincipalsOutput

type ListThingPrincipalsOutput struct {

	// The principals.
	Principals []*string `locationName:"principals" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListThingPrincipals operation.

func (ListThingPrincipalsOutput) GoString

func (s ListThingPrincipalsOutput) GoString() string

GoString returns the string representation

func (ListThingPrincipalsOutput) String

func (s ListThingPrincipalsOutput) String() string

String returns the string representation

type ListThingsInput

type ListThingsInput struct {

	// The attribute name.
	AttributeName *string `location:"querystring" locationName:"attributeName" type:"string"`

	// The attribute value.
	AttributeValue *string `location:"querystring" locationName:"attributeValue" type:"string"`

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

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

The input for the ListThings operation.

func (ListThingsInput) GoString

func (s ListThingsInput) GoString() string

GoString returns the string representation

func (ListThingsInput) String

func (s ListThingsInput) String() string

String returns the string representation

func (*ListThingsInput) Validate

func (s *ListThingsInput) Validate() error

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

type ListThingsOutput

type ListThingsOutput struct {

	// A token used to retrieve the next value.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The things.
	Things []*ThingAttribute `locationName:"things" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListThings operation.

func (ListThingsOutput) GoString

func (s ListThingsOutput) GoString() string

GoString returns the string representation

func (ListThingsOutput) String

func (s ListThingsOutput) String() string

String returns the string representation

type ListTopicRulesInput

type ListTopicRulesInput struct {

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

	// A token used to retrieve the next value.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Specifies whether the rule is disabled.
	RuleDisabled *bool `location:"querystring" locationName:"ruleDisabled" type:"boolean"`

	// The topic.
	Topic *string `location:"querystring" locationName:"topic" type:"string"`
	// contains filtered or unexported fields
}

The input for the ListTopicRules operation.

func (ListTopicRulesInput) GoString

func (s ListTopicRulesInput) GoString() string

GoString returns the string representation

func (ListTopicRulesInput) String

func (s ListTopicRulesInput) String() string

String returns the string representation

func (*ListTopicRulesInput) Validate

func (s *ListTopicRulesInput) Validate() error

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

type ListTopicRulesOutput

type ListTopicRulesOutput struct {

	// A token used to retrieve the next value.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The rules.
	Rules []*TopicRuleListItem `locationName:"rules" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListTopicRules operation.

func (ListTopicRulesOutput) GoString

func (s ListTopicRulesOutput) GoString() string

GoString returns the string representation

func (ListTopicRulesOutput) String

func (s ListTopicRulesOutput) String() string

String returns the string representation

type LoggingOptionsPayload

type LoggingOptionsPayload struct {

	// The logging level.
	LogLevel *string `locationName:"logLevel" type:"string" enum:"LogLevel"`

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the logging options payload.

func (LoggingOptionsPayload) GoString

func (s LoggingOptionsPayload) GoString() string

GoString returns the string representation

func (LoggingOptionsPayload) String

func (s LoggingOptionsPayload) String() string

String returns the string representation

func (*LoggingOptionsPayload) Validate

func (s *LoggingOptionsPayload) Validate() error

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

type Policy

type Policy struct {

	// The policy ARN.
	PolicyArn *string `locationName:"policyArn" type:"string"`

	// The policy name.
	PolicyName *string `locationName:"policyName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an AWS IoT policy.

func (Policy) GoString

func (s Policy) GoString() string

GoString returns the string representation

func (Policy) String

func (s Policy) String() string

String returns the string representation

type PolicyVersion

type PolicyVersion struct {

	// The date and time the policy was created.
	CreateDate *time.Time `locationName:"createDate" type:"timestamp" timestampFormat:"unix"`

	// Specifies whether the policy version is the default.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The policy version ID.
	VersionId *string `locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

Describes a policy version.

func (PolicyVersion) GoString

func (s PolicyVersion) GoString() string

GoString returns the string representation

func (PolicyVersion) String

func (s PolicyVersion) String() string

String returns the string representation

type RegisterCACertificateInput

type RegisterCACertificateInput struct {

	// The CA certificate.
	CaCertificate *string `locationName:"caCertificate" min:"1" type:"string" required:"true"`

	// A boolean value that specifies if the CA certificate is set to active.
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`

	// The private key verification certificate.
	VerificationCertificate *string `locationName:"verificationCertificate" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input to the RegisterCACertificate operation.

func (RegisterCACertificateInput) GoString

func (s RegisterCACertificateInput) GoString() string

GoString returns the string representation

func (RegisterCACertificateInput) String

String returns the string representation

func (*RegisterCACertificateInput) Validate

func (s *RegisterCACertificateInput) Validate() error

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

type RegisterCACertificateOutput

type RegisterCACertificateOutput struct {

	// The CA certificate ARN.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The CA certificate identifier.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`
	// contains filtered or unexported fields
}

The output from the RegisterCACertificateResponse operation.

func (RegisterCACertificateOutput) GoString

func (s RegisterCACertificateOutput) GoString() string

GoString returns the string representation

func (RegisterCACertificateOutput) String

String returns the string representation

type RegisterCertificateInput

type RegisterCertificateInput struct {

	// The CA certificate used to sign the device certificate being registered.
	CaCertificatePem *string `locationName:"caCertificatePem" min:"1" type:"string"`

	// The certificate data, in PEM format.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string" required:"true"`

	// A boolean value that specifies if the CA certificate is set to active.
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`
	// contains filtered or unexported fields
}

The input to the RegisterCertificate operation.

func (RegisterCertificateInput) GoString

func (s RegisterCertificateInput) GoString() string

GoString returns the string representation

func (RegisterCertificateInput) String

func (s RegisterCertificateInput) String() string

String returns the string representation

func (*RegisterCertificateInput) Validate

func (s *RegisterCertificateInput) Validate() error

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

type RegisterCertificateOutput

type RegisterCertificateOutput struct {

	// The certificate ARN.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The certificate identifier.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`
	// contains filtered or unexported fields
}

The output from the RegisterCertificate operation.

func (RegisterCertificateOutput) GoString

func (s RegisterCertificateOutput) GoString() string

GoString returns the string representation

func (RegisterCertificateOutput) String

func (s RegisterCertificateOutput) String() string

String returns the string representation

type RejectCertificateTransferInput

type RejectCertificateTransferInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// The reason the certificate transfer was rejected.
	RejectReason *string `locationName:"rejectReason" type:"string"`
	// contains filtered or unexported fields
}

The input for the RejectCertificateTransfer operation.

func (RejectCertificateTransferInput) GoString

GoString returns the string representation

func (RejectCertificateTransferInput) String

String returns the string representation

func (*RejectCertificateTransferInput) Validate

func (s *RejectCertificateTransferInput) Validate() error

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

type RejectCertificateTransferOutput

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

func (RejectCertificateTransferOutput) GoString

GoString returns the string representation

func (RejectCertificateTransferOutput) String

String returns the string representation

type ReplaceTopicRuleInput

type ReplaceTopicRuleInput struct {

	// The name of the rule.
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`

	// The rule payload.
	TopicRulePayload *TopicRulePayload `locationName:"topicRulePayload" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input for the ReplaceTopicRule operation.

func (ReplaceTopicRuleInput) GoString

func (s ReplaceTopicRuleInput) GoString() string

GoString returns the string representation

func (ReplaceTopicRuleInput) String

func (s ReplaceTopicRuleInput) String() string

String returns the string representation

func (*ReplaceTopicRuleInput) Validate

func (s *ReplaceTopicRuleInput) Validate() error

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

type ReplaceTopicRuleOutput

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

func (ReplaceTopicRuleOutput) GoString

func (s ReplaceTopicRuleOutput) GoString() string

GoString returns the string representation

func (ReplaceTopicRuleOutput) String

func (s ReplaceTopicRuleOutput) String() string

String returns the string representation

type RepublishAction

type RepublishAction struct {

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the MQTT topic.
	Topic *string `locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to republish to another topic.

func (RepublishAction) GoString

func (s RepublishAction) GoString() string

GoString returns the string representation

func (RepublishAction) String

func (s RepublishAction) String() string

String returns the string representation

func (*RepublishAction) Validate

func (s *RepublishAction) Validate() error

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

type S3Action

type S3Action struct {

	// The Amazon S3 bucket.
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The object key.
	Key *string `locationName:"key" type:"string" required:"true"`

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to write data to an Amazon S3 bucket.

func (S3Action) GoString

func (s S3Action) GoString() string

GoString returns the string representation

func (S3Action) String

func (s S3Action) String() string

String returns the string representation

func (*S3Action) Validate

func (s *S3Action) Validate() error

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

type SetDefaultPolicyVersionInput

type SetDefaultPolicyVersionInput struct {

	// The policy name.
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The policy version ID.
	PolicyVersionId *string `location:"uri" locationName:"policyVersionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the SetDefaultPolicyVersion operation.

func (SetDefaultPolicyVersionInput) GoString

func (s SetDefaultPolicyVersionInput) GoString() string

GoString returns the string representation

func (SetDefaultPolicyVersionInput) String

String returns the string representation

func (*SetDefaultPolicyVersionInput) Validate

func (s *SetDefaultPolicyVersionInput) Validate() error

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

type SetDefaultPolicyVersionOutput

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

func (SetDefaultPolicyVersionOutput) GoString

GoString returns the string representation

func (SetDefaultPolicyVersionOutput) String

String returns the string representation

type SetLoggingOptionsInput

type SetLoggingOptionsInput struct {

	// The logging options payload.
	LoggingOptionsPayload *LoggingOptionsPayload `locationName:"loggingOptionsPayload" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input for the SetLoggingOptions operation.

func (SetLoggingOptionsInput) GoString

func (s SetLoggingOptionsInput) GoString() string

GoString returns the string representation

func (SetLoggingOptionsInput) String

func (s SetLoggingOptionsInput) String() string

String returns the string representation

func (*SetLoggingOptionsInput) Validate

func (s *SetLoggingOptionsInput) Validate() error

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

type SetLoggingOptionsOutput

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

func (SetLoggingOptionsOutput) GoString

func (s SetLoggingOptionsOutput) GoString() string

GoString returns the string representation

func (SetLoggingOptionsOutput) String

func (s SetLoggingOptionsOutput) String() string

String returns the string representation

type SnsAction

type SnsAction struct {

	// The message format of the message to publish. Optional. Accepted values are
	// "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this
	// setting to determine if the payload should be parsed and relevant platform-specific
	// bits of the payload should be extracted. To read more about SNS message formats,
	// see  refer to their official documentation.
	MessageFormat *string `locationName:"messageFormat" type:"string" enum:"MessageFormat"`

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The ARN of the SNS topic.
	TargetArn *string `locationName:"targetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to publish to an Amazon SNS topic.

func (SnsAction) GoString

func (s SnsAction) GoString() string

GoString returns the string representation

func (SnsAction) String

func (s SnsAction) String() string

String returns the string representation

func (*SnsAction) Validate

func (s *SnsAction) Validate() error

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

type SqsAction

type SqsAction struct {

	// The URL of the Amazon SQS queue.
	QueueUrl *string `locationName:"queueUrl" type:"string" required:"true"`

	// The ARN of the IAM role that grants access.
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// Specifies whether to use Base64 encoding.
	UseBase64 *bool `locationName:"useBase64" type:"boolean"`
	// contains filtered or unexported fields
}

Describes an action to publish data to an Amazon SQS queue.

func (SqsAction) GoString

func (s SqsAction) GoString() string

GoString returns the string representation

func (SqsAction) String

func (s SqsAction) String() string

String returns the string representation

func (*SqsAction) Validate

func (s *SqsAction) Validate() error

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

type ThingAttribute

type ThingAttribute struct {

	// The attributes.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// The name of the thing.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a thing attribute.

func (ThingAttribute) GoString

func (s ThingAttribute) GoString() string

GoString returns the string representation

func (ThingAttribute) String

func (s ThingAttribute) String() string

String returns the string representation

type TopicRule

type TopicRule struct {

	// The actions associated with the rule.
	Actions []*Action `locationName:"actions" type:"list"`

	// The version of the SQL rules engine to use when evaluating the rule.
	AwsIotSqlVersion *string `locationName:"awsIotSqlVersion" type:"string"`

	// The date and time the rule was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The description of the rule.
	Description *string `locationName:"description" type:"string"`

	// Specifies whether the rule is disabled.
	RuleDisabled *bool `locationName:"ruleDisabled" type:"boolean"`

	// The name of the rule.
	RuleName *string `locationName:"ruleName" min:"1" type:"string"`

	// The SQL statement used to query the topic. When using a SQL query with multiple
	// lines, be sure to escape the newline characters.
	Sql *string `locationName:"sql" type:"string"`
	// contains filtered or unexported fields
}

Describes a rule.

func (TopicRule) GoString

func (s TopicRule) GoString() string

GoString returns the string representation

func (TopicRule) String

func (s TopicRule) String() string

String returns the string representation

type TopicRuleListItem

type TopicRuleListItem struct {

	// The date and time the rule was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The rule ARN.
	RuleArn *string `locationName:"ruleArn" type:"string"`

	// Specifies whether the rule is disabled.
	RuleDisabled *bool `locationName:"ruleDisabled" type:"boolean"`

	// The name of the rule.
	RuleName *string `locationName:"ruleName" min:"1" type:"string"`

	// The pattern for the topic names that apply.
	TopicPattern *string `locationName:"topicPattern" type:"string"`
	// contains filtered or unexported fields
}

Describes a rule.

func (TopicRuleListItem) GoString

func (s TopicRuleListItem) GoString() string

GoString returns the string representation

func (TopicRuleListItem) String

func (s TopicRuleListItem) String() string

String returns the string representation

type TopicRulePayload

type TopicRulePayload struct {

	// The actions associated with the rule.
	Actions []*Action `locationName:"actions" type:"list" required:"true"`

	// The version of the SQL rules engine to use when evaluating the rule.
	AwsIotSqlVersion *string `locationName:"awsIotSqlVersion" type:"string"`

	// The description of the rule.
	Description *string `locationName:"description" type:"string"`

	// Specifies whether the rule is disabled.
	RuleDisabled *bool `locationName:"ruleDisabled" type:"boolean"`

	// The SQL statement used to query the topic. For more information, see AWS
	// IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference)
	// in the AWS IoT Developer Guide.
	Sql *string `locationName:"sql" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a rule.

func (TopicRulePayload) GoString

func (s TopicRulePayload) GoString() string

GoString returns the string representation

func (TopicRulePayload) String

func (s TopicRulePayload) String() string

String returns the string representation

func (*TopicRulePayload) Validate

func (s *TopicRulePayload) Validate() error

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

type TransferCertificateInput

type TransferCertificateInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// The AWS account.
	TargetAwsAccount *string `location:"querystring" locationName:"targetAwsAccount" type:"string" required:"true"`

	// The transfer message.
	TransferMessage *string `locationName:"transferMessage" type:"string"`
	// contains filtered or unexported fields
}

The input for the TransferCertificate operation.

func (TransferCertificateInput) GoString

func (s TransferCertificateInput) GoString() string

GoString returns the string representation

func (TransferCertificateInput) String

func (s TransferCertificateInput) String() string

String returns the string representation

func (*TransferCertificateInput) Validate

func (s *TransferCertificateInput) Validate() error

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

type TransferCertificateOutput

type TransferCertificateOutput struct {

	// The ARN of the certificate.
	TransferredCertificateArn *string `locationName:"transferredCertificateArn" type:"string"`
	// contains filtered or unexported fields
}

The output from the TransferCertificate operation.

func (TransferCertificateOutput) GoString

func (s TransferCertificateOutput) GoString() string

GoString returns the string representation

func (TransferCertificateOutput) String

func (s TransferCertificateOutput) String() string

String returns the string representation

type TransferData

type TransferData struct {

	// The date the transfer was accepted.
	AcceptDate *time.Time `locationName:"acceptDate" type:"timestamp" timestampFormat:"unix"`

	// The date the transfer was rejected.
	RejectDate *time.Time `locationName:"rejectDate" type:"timestamp" timestampFormat:"unix"`

	// The reason why the transfer was rejected.
	RejectReason *string `locationName:"rejectReason" type:"string"`

	// The date the transfer took place.
	TransferDate *time.Time `locationName:"transferDate" type:"timestamp" timestampFormat:"unix"`

	// The transfer message.
	TransferMessage *string `locationName:"transferMessage" type:"string"`
	// contains filtered or unexported fields
}

Data used to transfer a certificate to an AWS account.

func (TransferData) GoString

func (s TransferData) GoString() string

GoString returns the string representation

func (TransferData) String

func (s TransferData) String() string

String returns the string representation

type UpdateCACertificateInput

type UpdateCACertificateInput struct {

	// The CA certificate identifier.
	CertificateId *string `location:"uri" locationName:"caCertificateId" min:"64" type:"string" required:"true"`

	// The updated status of the CA certificate.
	//
	// Note: The status value REGISTER_INACTIVE is deprecated and should not be
	// used.
	NewStatus *string `location:"querystring" locationName:"newStatus" type:"string" required:"true" enum:"CACertificateStatus"`
	// contains filtered or unexported fields
}

The input to the UpdateCACertificate operation.

func (UpdateCACertificateInput) GoString

func (s UpdateCACertificateInput) GoString() string

GoString returns the string representation

func (UpdateCACertificateInput) String

func (s UpdateCACertificateInput) String() string

String returns the string representation

func (*UpdateCACertificateInput) Validate

func (s *UpdateCACertificateInput) Validate() error

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

type UpdateCACertificateOutput

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

func (UpdateCACertificateOutput) GoString

func (s UpdateCACertificateOutput) GoString() string

GoString returns the string representation

func (UpdateCACertificateOutput) String

func (s UpdateCACertificateOutput) String() string

String returns the string representation

type UpdateCertificateInput

type UpdateCertificateInput struct {

	// The ID of the certificate.
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// The new status.
	//
	// Note: Setting the status to PENDING_TRANSFER will result in an exception
	// being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It
	// is not intended for developer use.
	//
	// Note: The status value REGISTER_INACTIVE is deprecated and should not be
	// used.
	NewStatus *string `location:"querystring" locationName:"newStatus" type:"string" required:"true" enum:"CertificateStatus"`
	// contains filtered or unexported fields
}

The input for the UpdateCertificate operation.

func (UpdateCertificateInput) GoString

func (s UpdateCertificateInput) GoString() string

GoString returns the string representation

func (UpdateCertificateInput) String

func (s UpdateCertificateInput) String() string

String returns the string representation

func (*UpdateCertificateInput) Validate

func (s *UpdateCertificateInput) Validate() error

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

type UpdateCertificateOutput

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

func (UpdateCertificateOutput) GoString

func (s UpdateCertificateOutput) GoString() string

GoString returns the string representation

func (UpdateCertificateOutput) String

func (s UpdateCertificateOutput) String() string

String returns the string representation

type UpdateThingInput

type UpdateThingInput struct {

	// The attribute payload, a JSON string containing up to three key-value pairs
	// (for example, {\"attributes\":{\"string1\":\"string2\"}}).
	AttributePayload *AttributePayload `locationName:"attributePayload" type:"structure" required:"true"`

	// The thing name.
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the UpdateThing operation.

func (UpdateThingInput) GoString

func (s UpdateThingInput) GoString() string

GoString returns the string representation

func (UpdateThingInput) String

func (s UpdateThingInput) String() string

String returns the string representation

func (*UpdateThingInput) Validate

func (s *UpdateThingInput) Validate() error

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

type UpdateThingOutput

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

The output from the UpdateThing operation.

func (UpdateThingOutput) GoString

func (s UpdateThingOutput) GoString() string

GoString returns the string representation

func (UpdateThingOutput) String

func (s UpdateThingOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package iotiface provides an interface for the AWS IoT.
Package iotiface provides an interface for the AWS IoT.

Jump to

Keyboard shortcuts

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