iot

package
v1.8.18 Latest Latest
Warning

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

Go to latest
Published: Apr 28, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package iot provides a client for AWS IoT.

Index

Examples

Constants

View Source
const (
	// AutoRegistrationStatusEnable is a AutoRegistrationStatus enum value
	AutoRegistrationStatusEnable = "ENABLE"

	// AutoRegistrationStatusDisable is a AutoRegistrationStatus enum value
	AutoRegistrationStatusDisable = "DISABLE"
)
View Source
const (
	// CACertificateStatusActive is a CACertificateStatus enum value
	CACertificateStatusActive = "ACTIVE"

	// CACertificateStatusInactive is a CACertificateStatus enum value
	CACertificateStatusInactive = "INACTIVE"
)
View Source
const (
	// CannedAccessControlListPrivate is a CannedAccessControlList enum value
	CannedAccessControlListPrivate = "private"

	// CannedAccessControlListPublicRead is a CannedAccessControlList enum value
	CannedAccessControlListPublicRead = "public-read"

	// CannedAccessControlListPublicReadWrite is a CannedAccessControlList enum value
	CannedAccessControlListPublicReadWrite = "public-read-write"

	// CannedAccessControlListAwsExecRead is a CannedAccessControlList enum value
	CannedAccessControlListAwsExecRead = "aws-exec-read"

	// CannedAccessControlListAuthenticatedRead is a CannedAccessControlList enum value
	CannedAccessControlListAuthenticatedRead = "authenticated-read"

	// CannedAccessControlListBucketOwnerRead is a CannedAccessControlList enum value
	CannedAccessControlListBucketOwnerRead = "bucket-owner-read"

	// CannedAccessControlListBucketOwnerFullControl is a CannedAccessControlList enum value
	CannedAccessControlListBucketOwnerFullControl = "bucket-owner-full-control"

	// CannedAccessControlListLogDeliveryWrite is a CannedAccessControlList enum value
	CannedAccessControlListLogDeliveryWrite = "log-delivery-write"
)
View Source
const (
	// CertificateStatusActive is a CertificateStatus enum value
	CertificateStatusActive = "ACTIVE"

	// CertificateStatusInactive is a CertificateStatus enum value
	CertificateStatusInactive = "INACTIVE"

	// CertificateStatusRevoked is a CertificateStatus enum value
	CertificateStatusRevoked = "REVOKED"

	// CertificateStatusPendingTransfer is a CertificateStatus enum value
	CertificateStatusPendingTransfer = "PENDING_TRANSFER"

	// CertificateStatusRegisterInactive is a CertificateStatus enum value
	CertificateStatusRegisterInactive = "REGISTER_INACTIVE"

	// CertificateStatusPendingActivation is a CertificateStatus enum value
	CertificateStatusPendingActivation = "PENDING_ACTIVATION"
)
View Source
const (
	// DynamoKeyTypeString is a DynamoKeyType enum value
	DynamoKeyTypeString = "STRING"

	// DynamoKeyTypeNumber is a DynamoKeyType enum value
	DynamoKeyTypeNumber = "NUMBER"
)
View Source
const (
	// LogLevelDebug is a LogLevel enum value
	LogLevelDebug = "DEBUG"

	// LogLevelInfo is a LogLevel enum value
	LogLevelInfo = "INFO"

	// LogLevelError is a LogLevel enum value
	LogLevelError = "ERROR"

	// LogLevelWarn is a LogLevel enum value
	LogLevelWarn = "WARN"

	// LogLevelDisabled is a LogLevel enum value
	LogLevelDisabled = "DISABLED"
)
View Source
const (
	// MessageFormatRaw is a MessageFormat enum value
	MessageFormatRaw = "RAW"

	// MessageFormatJson is a MessageFormat enum value
	MessageFormatJson = "JSON"
)
View Source
const (

	// ErrCodeCertificateConflictException for service response error code
	// "CertificateConflictException".
	//
	// Unable to verify the CA certificate used to sign the device certificate you
	// are attempting to register. This is happens when you have registered more
	// than one CA certificate that has the same subject field and public key.
	ErrCodeCertificateConflictException = "CertificateConflictException"

	// ErrCodeCertificateStateException for service response error code
	// "CertificateStateException".
	//
	// The certificate operation is not allowed.
	ErrCodeCertificateStateException = "CertificateStateException"

	// ErrCodeCertificateValidationException for service response error code
	// "CertificateValidationException".
	//
	// The certificate is invalid.
	ErrCodeCertificateValidationException = "CertificateValidationException"

	// ErrCodeDeleteConflictException for service response error code
	// "DeleteConflictException".
	//
	// You can't delete the resource because it is attached to one or more resources.
	ErrCodeDeleteConflictException = "DeleteConflictException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// An unexpected error has occurred.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// An unexpected error has occurred.
	ErrCodeInternalFailureException = "InternalFailureException"

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

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The number of attached entities exceeds the limit.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMalformedPolicyException for service response error code
	// "MalformedPolicyException".
	//
	// The policy documentation is not valid.
	ErrCodeMalformedPolicyException = "MalformedPolicyException"

	// ErrCodeRegistrationCodeValidationException for service response error code
	// "RegistrationCodeValidationException".
	//
	// The registration code is invalid.
	ErrCodeRegistrationCodeValidationException = "RegistrationCodeValidationException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

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

	// ErrCodeSqlParseException for service response error code
	// "SqlParseException".
	//
	// The Rule-SQL expression can't be parsed correctly.
	ErrCodeSqlParseException = "SqlParseException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The rate exceeds the limit.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTransferAlreadyCompletedException for service response error code
	// "TransferAlreadyCompletedException".
	//
	// You can't revert the certificate transfer because the transfer is already
	// complete.
	ErrCodeTransferAlreadyCompletedException = "TransferAlreadyCompletedException"

	// ErrCodeTransferConflictException for service response error code
	// "TransferConflictException".
	//
	// You can't transfer the certificate because authorization policies are still
	// attached.
	ErrCodeTransferConflictException = "TransferConflictException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// You are not authorized to perform this operation.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeVersionConflictException for service response error code
	// "VersionConflictException".
	//
	// An exception thrown when the version of a thing passed to a command is different
	// than the version specified with the --version parameter.
	ErrCodeVersionConflictException = "VersionConflictException"

	// ErrCodeVersionsLimitExceededException for service response error code
	// "VersionsLimitExceededException".
	//
	// The number of policy versions exceeds the limit.
	ErrCodeVersionsLimitExceededException = "VersionsLimitExceededException"
)
View Source
const (
	ServiceName = "iot"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptCertificateTransferInput

type AcceptCertificateTransferInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*AcceptCertificateTransferInput) SetSetAsActive added in v1.5.0

SetSetAsActive sets the SetAsActive field's value.

func (AcceptCertificateTransferInput) String

String returns the string representation

func (*AcceptCertificateTransferInput) Validate added in v1.1.21

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 to a DynamoDB table. This is a new version of the DynamoDB action.
	// It allows you to write each attribute in an MQTT message payload into a separate
	// DynamoDB column.
	DynamoDBv2 *DynamoDBv2Action `locationName:"dynamoDBv2" 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) SetCloudwatchAlarm added in v1.5.0

func (s *Action) SetCloudwatchAlarm(v *CloudwatchAlarmAction) *Action

SetCloudwatchAlarm sets the CloudwatchAlarm field's value.

func (*Action) SetCloudwatchMetric added in v1.5.0

func (s *Action) SetCloudwatchMetric(v *CloudwatchMetricAction) *Action

SetCloudwatchMetric sets the CloudwatchMetric field's value.

func (*Action) SetDynamoDB added in v1.5.0

func (s *Action) SetDynamoDB(v *DynamoDBAction) *Action

SetDynamoDB sets the DynamoDB field's value.

func (*Action) SetDynamoDBv2 added in v1.5.0

func (s *Action) SetDynamoDBv2(v *DynamoDBv2Action) *Action

SetDynamoDBv2 sets the DynamoDBv2 field's value.

func (*Action) SetElasticsearch added in v1.5.0

func (s *Action) SetElasticsearch(v *ElasticsearchAction) *Action

SetElasticsearch sets the Elasticsearch field's value.

func (*Action) SetFirehose added in v1.5.0

func (s *Action) SetFirehose(v *FirehoseAction) *Action

SetFirehose sets the Firehose field's value.

func (*Action) SetKinesis added in v1.5.0

func (s *Action) SetKinesis(v *KinesisAction) *Action

SetKinesis sets the Kinesis field's value.

func (*Action) SetLambda added in v1.5.0

func (s *Action) SetLambda(v *LambdaAction) *Action

SetLambda sets the Lambda field's value.

func (*Action) SetRepublish added in v1.5.0

func (s *Action) SetRepublish(v *RepublishAction) *Action

SetRepublish sets the Republish field's value.

func (*Action) SetS3 added in v1.5.0

func (s *Action) SetS3(v *S3Action) *Action

SetS3 sets the S3 field's value.

func (*Action) SetSns added in v1.5.0

func (s *Action) SetSns(v *SnsAction) *Action

SetSns sets the Sns field's value.

func (*Action) SetSqs added in v1.5.0

func (s *Action) SetSqs(v *SqsAction) *Action

SetSqs sets the Sqs field's value.

func (Action) String

func (s Action) String() string

String returns the string representation

func (*Action) Validate added in v1.1.21

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 is a required field
	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 is a required field
	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) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*AttachPrincipalPolicyInput) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (AttachPrincipalPolicyInput) String

String returns the string representation

func (*AttachPrincipalPolicyInput) Validate added in v1.1.21

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, such as a certificate or other credential.
	//
	// Principal is a required field
	Principal *string `location:"header" locationName:"x-amzn-principal" type:"string" required:"true"`

	// The name of the thing.
	//
	// ThingName is a required field
	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) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (*AttachThingPrincipalInput) SetThingName added in v1.5.0

SetThingName sets the ThingName field's value.

func (AttachThingPrincipalInput) String

func (s AttachThingPrincipalInput) String() string

String returns the string representation

func (*AttachThingPrincipalInput) Validate added in v1.1.21

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"`

	// Specifies whether the list of attributes provided in the AttributePayload
	// is merged with the attributes stored in the registry, instead of overwriting
	// them.
	//
	// To remove an attribute, call UpdateThing with an empty attribute value.
	//
	// The merge attribute is only valid when calling UpdateThing.
	Merge *bool `locationName:"merge" type:"boolean"`
	// contains filtered or unexported fields
}

The attribute payload.

func (AttributePayload) GoString

func (s AttributePayload) GoString() string

GoString returns the string representation

func (*AttributePayload) SetAttributes added in v1.5.0

func (s *AttributePayload) SetAttributes(v map[string]*string) *AttributePayload

SetAttributes sets the Attributes field's value.

func (*AttributePayload) SetMerge added in v1.5.0

func (s *AttributePayload) SetMerge(v bool) *AttributePayload

SetMerge sets the Merge field's value.

func (AttributePayload) String

func (s AttributePayload) String() string

String returns the string representation

type CACertificate added in v1.1.18

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 added in v1.1.18

func (s CACertificate) GoString() string

GoString returns the string representation

func (*CACertificate) SetCertificateArn added in v1.5.0

func (s *CACertificate) SetCertificateArn(v string) *CACertificate

SetCertificateArn sets the CertificateArn field's value.

func (*CACertificate) SetCertificateId added in v1.5.0

func (s *CACertificate) SetCertificateId(v string) *CACertificate

SetCertificateId sets the CertificateId field's value.

func (*CACertificate) SetCreationDate added in v1.5.0

func (s *CACertificate) SetCreationDate(v time.Time) *CACertificate

SetCreationDate sets the CreationDate field's value.

func (*CACertificate) SetStatus added in v1.5.0

func (s *CACertificate) SetStatus(v string) *CACertificate

SetStatus sets the Status field's value.

func (CACertificate) String added in v1.1.18

func (s CACertificate) String() string

String returns the string representation

type CACertificateDescription added in v1.1.18

type CACertificateDescription struct {

	// Whether the CA certificate configured for auto registration of device certificates.
	// Valid values are "ENABLE" and "DISABLE"
	AutoRegistrationStatus *string `locationName:"autoRegistrationStatus" type:"string" enum:"AutoRegistrationStatus"`

	// 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 added in v1.1.18

func (s CACertificateDescription) GoString() string

GoString returns the string representation

func (*CACertificateDescription) SetAutoRegistrationStatus added in v1.5.0

func (s *CACertificateDescription) SetAutoRegistrationStatus(v string) *CACertificateDescription

SetAutoRegistrationStatus sets the AutoRegistrationStatus field's value.

func (*CACertificateDescription) SetCertificateArn added in v1.5.0

func (s *CACertificateDescription) SetCertificateArn(v string) *CACertificateDescription

SetCertificateArn sets the CertificateArn field's value.

func (*CACertificateDescription) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*CACertificateDescription) SetCertificatePem added in v1.5.0

func (s *CACertificateDescription) SetCertificatePem(v string) *CACertificateDescription

SetCertificatePem sets the CertificatePem field's value.

func (*CACertificateDescription) SetCreationDate added in v1.5.0

SetCreationDate sets the CreationDate field's value.

func (*CACertificateDescription) SetOwnedBy added in v1.5.0

SetOwnedBy sets the OwnedBy field's value.

func (*CACertificateDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (CACertificateDescription) String added in v1.1.18

func (s CACertificateDescription) String() string

String returns the string representation

type CancelCertificateTransferInput

type CancelCertificateTransferInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (CancelCertificateTransferInput) String

String returns the string representation

func (*CancelCertificateTransferInput) Validate added in v1.1.21

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) SetCertificateArn added in v1.5.0

func (s *Certificate) SetCertificateArn(v string) *Certificate

SetCertificateArn sets the CertificateArn field's value.

func (*Certificate) SetCertificateId added in v1.5.0

func (s *Certificate) SetCertificateId(v string) *Certificate

SetCertificateId sets the CertificateId field's value.

func (*Certificate) SetCreationDate added in v1.5.0

func (s *Certificate) SetCreationDate(v time.Time) *Certificate

SetCreationDate sets the CreationDate field's value.

func (*Certificate) SetStatus added in v1.5.0

func (s *Certificate) SetStatus(v string) *Certificate

SetStatus sets the Status field's value.

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) SetCaCertificateId added in v1.5.0

func (s *CertificateDescription) SetCaCertificateId(v string) *CertificateDescription

SetCaCertificateId sets the CaCertificateId field's value.

func (*CertificateDescription) SetCertificateArn added in v1.5.0

func (s *CertificateDescription) SetCertificateArn(v string) *CertificateDescription

SetCertificateArn sets the CertificateArn field's value.

func (*CertificateDescription) SetCertificateId added in v1.5.0

func (s *CertificateDescription) SetCertificateId(v string) *CertificateDescription

SetCertificateId sets the CertificateId field's value.

func (*CertificateDescription) SetCertificatePem added in v1.5.0

func (s *CertificateDescription) SetCertificatePem(v string) *CertificateDescription

SetCertificatePem sets the CertificatePem field's value.

func (*CertificateDescription) SetCreationDate added in v1.5.0

func (s *CertificateDescription) SetCreationDate(v time.Time) *CertificateDescription

SetCreationDate sets the CreationDate field's value.

func (*CertificateDescription) SetLastModifiedDate added in v1.5.0

func (s *CertificateDescription) SetLastModifiedDate(v time.Time) *CertificateDescription

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CertificateDescription) SetOwnedBy added in v1.5.0

SetOwnedBy sets the OwnedBy field's value.

func (*CertificateDescription) SetPreviousOwnedBy added in v1.5.0

func (s *CertificateDescription) SetPreviousOwnedBy(v string) *CertificateDescription

SetPreviousOwnedBy sets the PreviousOwnedBy field's value.

func (*CertificateDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*CertificateDescription) SetTransferData added in v1.5.0

SetTransferData sets the TransferData field's value.

func (CertificateDescription) String

func (s CertificateDescription) String() string

String returns the string representation

type CloudwatchAlarmAction added in v1.1.12

type CloudwatchAlarmAction struct {

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

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

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

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

Describes an action that updates a CloudWatch alarm.

func (CloudwatchAlarmAction) GoString added in v1.1.12

func (s CloudwatchAlarmAction) GoString() string

GoString returns the string representation

func (*CloudwatchAlarmAction) SetAlarmName added in v1.5.0

SetAlarmName sets the AlarmName field's value.

func (*CloudwatchAlarmAction) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (*CloudwatchAlarmAction) SetStateReason added in v1.5.0

func (s *CloudwatchAlarmAction) SetStateReason(v string) *CloudwatchAlarmAction

SetStateReason sets the StateReason field's value.

func (*CloudwatchAlarmAction) SetStateValue added in v1.5.0

func (s *CloudwatchAlarmAction) SetStateValue(v string) *CloudwatchAlarmAction

SetStateValue sets the StateValue field's value.

func (CloudwatchAlarmAction) String added in v1.1.12

func (s CloudwatchAlarmAction) String() string

String returns the string representation

func (*CloudwatchAlarmAction) Validate added in v1.1.21

func (s *CloudwatchAlarmAction) Validate() error

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

type CloudwatchMetricAction added in v1.1.12

type CloudwatchMetricAction struct {

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

	// The CloudWatch metric namespace name.
	//
	// MetricNamespace is a required field
	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 is a required field
	MetricUnit *string `locationName:"metricUnit" type:"string" required:"true"`

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

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

Describes an action that captures a CloudWatch metric.

func (CloudwatchMetricAction) GoString added in v1.1.12

func (s CloudwatchMetricAction) GoString() string

GoString returns the string representation

func (*CloudwatchMetricAction) SetMetricName added in v1.5.0

SetMetricName sets the MetricName field's value.

func (*CloudwatchMetricAction) SetMetricNamespace added in v1.5.0

func (s *CloudwatchMetricAction) SetMetricNamespace(v string) *CloudwatchMetricAction

SetMetricNamespace sets the MetricNamespace field's value.

func (*CloudwatchMetricAction) SetMetricTimestamp added in v1.5.0

func (s *CloudwatchMetricAction) SetMetricTimestamp(v string) *CloudwatchMetricAction

SetMetricTimestamp sets the MetricTimestamp field's value.

func (*CloudwatchMetricAction) SetMetricUnit added in v1.5.0

SetMetricUnit sets the MetricUnit field's value.

func (*CloudwatchMetricAction) SetMetricValue added in v1.5.0

SetMetricValue sets the MetricValue field's value.

func (*CloudwatchMetricAction) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (CloudwatchMetricAction) String added in v1.1.12

func (s CloudwatchMetricAction) String() string

String returns the string representation

func (*CloudwatchMetricAction) Validate added in v1.1.21

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 is a required field
	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) SetCertificateSigningRequest added in v1.5.0

func (s *CreateCertificateFromCsrInput) SetCertificateSigningRequest(v string) *CreateCertificateFromCsrInput

SetCertificateSigningRequest sets the CertificateSigningRequest field's value.

func (*CreateCertificateFromCsrInput) SetSetAsActive added in v1.5.0

SetSetAsActive sets the SetAsActive field's value.

func (CreateCertificateFromCsrInput) String

String returns the string representation

func (*CreateCertificateFromCsrInput) Validate added in v1.1.21

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) SetCertificateArn added in v1.5.0

SetCertificateArn sets the CertificateArn field's value.

func (*CreateCertificateFromCsrOutput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*CreateCertificateFromCsrOutput) SetCertificatePem added in v1.5.0

SetCertificatePem sets the CertificatePem field's value.

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) SetSetAsActive added in v1.5.0

SetSetAsActive sets the SetAsActive field's value.

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) SetCertificateArn added in v1.5.0

SetCertificateArn sets the CertificateArn field's value.

func (*CreateKeysAndCertificateOutput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*CreateKeysAndCertificateOutput) SetCertificatePem added in v1.5.0

SetCertificatePem sets the CertificatePem field's value.

func (*CreateKeysAndCertificateOutput) SetKeyPair added in v1.5.0

SetKeyPair sets the KeyPair field's value.

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 is a required field
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`

	// The policy name.
	//
	// PolicyName is a required field
	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) SetPolicyDocument added in v1.5.0

func (s *CreatePolicyInput) SetPolicyDocument(v string) *CreatePolicyInput

SetPolicyDocument sets the PolicyDocument field's value.

func (*CreatePolicyInput) SetPolicyName added in v1.5.0

func (s *CreatePolicyInput) SetPolicyName(v string) *CreatePolicyInput

SetPolicyName sets the PolicyName field's value.

func (CreatePolicyInput) String

func (s CreatePolicyInput) String() string

String returns the string representation

func (*CreatePolicyInput) Validate added in v1.1.21

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) SetPolicyArn added in v1.5.0

func (s *CreatePolicyOutput) SetPolicyArn(v string) *CreatePolicyOutput

SetPolicyArn sets the PolicyArn field's value.

func (*CreatePolicyOutput) SetPolicyDocument added in v1.5.0

func (s *CreatePolicyOutput) SetPolicyDocument(v string) *CreatePolicyOutput

SetPolicyDocument sets the PolicyDocument field's value.

func (*CreatePolicyOutput) SetPolicyName added in v1.5.0

func (s *CreatePolicyOutput) SetPolicyName(v string) *CreatePolicyOutput

SetPolicyName sets the PolicyName field's value.

func (*CreatePolicyOutput) SetPolicyVersionId added in v1.5.0

func (s *CreatePolicyOutput) SetPolicyVersionId(v string) *CreatePolicyOutput

SetPolicyVersionId sets the PolicyVersionId field's value.

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 is a required field
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`

	// The policy name.
	//
	// PolicyName is a required field
	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) SetPolicyDocument added in v1.5.0

func (s *CreatePolicyVersionInput) SetPolicyDocument(v string) *CreatePolicyVersionInput

SetPolicyDocument sets the PolicyDocument field's value.

func (*CreatePolicyVersionInput) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*CreatePolicyVersionInput) SetSetAsDefault added in v1.5.0

SetSetAsDefault sets the SetAsDefault field's value.

func (CreatePolicyVersionInput) String

func (s CreatePolicyVersionInput) String() string

String returns the string representation

func (*CreatePolicyVersionInput) Validate added in v1.1.21

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) SetIsDefaultVersion added in v1.5.0

func (s *CreatePolicyVersionOutput) SetIsDefaultVersion(v bool) *CreatePolicyVersionOutput

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*CreatePolicyVersionOutput) SetPolicyArn added in v1.5.0

SetPolicyArn sets the PolicyArn field's value.

func (*CreatePolicyVersionOutput) SetPolicyDocument added in v1.5.0

SetPolicyDocument sets the PolicyDocument field's value.

func (*CreatePolicyVersionOutput) SetPolicyVersionId added in v1.5.0

SetPolicyVersionId sets the PolicyVersionId field's value.

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 three name/value pairs in
	// a JSON document. For example:
	//
	// {\"attributes\":{\"string1\":\"string2\"}})
	AttributePayload *AttributePayload `locationName:"attributePayload" type:"structure"`

	// The name of the thing to create.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`

	// The name of the thing type associated with the new thing.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`
	// 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) SetAttributePayload added in v1.5.0

func (s *CreateThingInput) SetAttributePayload(v *AttributePayload) *CreateThingInput

SetAttributePayload sets the AttributePayload field's value.

func (*CreateThingInput) SetThingName added in v1.5.0

func (s *CreateThingInput) SetThingName(v string) *CreateThingInput

SetThingName sets the ThingName field's value.

func (*CreateThingInput) SetThingTypeName added in v1.5.0

func (s *CreateThingInput) SetThingTypeName(v string) *CreateThingInput

SetThingTypeName sets the ThingTypeName field's value.

func (CreateThingInput) String

func (s CreateThingInput) String() string

String returns the string representation

func (*CreateThingInput) Validate added in v1.1.21

func (s *CreateThingInput) Validate() error

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

type CreateThingOutput

type CreateThingOutput struct {

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

	// The name of the new 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) SetThingArn added in v1.5.0

func (s *CreateThingOutput) SetThingArn(v string) *CreateThingOutput

SetThingArn sets the ThingArn field's value.

func (*CreateThingOutput) SetThingName added in v1.5.0

func (s *CreateThingOutput) SetThingName(v string) *CreateThingOutput

SetThingName sets the ThingName field's value.

func (CreateThingOutput) String

func (s CreateThingOutput) String() string

String returns the string representation

type CreateThingTypeInput added in v1.2.8

type CreateThingTypeInput struct {

	// The name of the thing type.
	//
	// ThingTypeName is a required field
	ThingTypeName *string `location:"uri" locationName:"thingTypeName" min:"1" type:"string" required:"true"`

	// The ThingTypeProperties for the thing type to create. It contains information
	// about the new thing type including a description, and a list of searchable
	// thing attribute names.
	ThingTypeProperties *ThingTypeProperties `locationName:"thingTypeProperties" type:"structure"`
	// contains filtered or unexported fields
}

The input for the CreateThingType operation.

func (CreateThingTypeInput) GoString added in v1.2.8

func (s CreateThingTypeInput) GoString() string

GoString returns the string representation

func (*CreateThingTypeInput) SetThingTypeName added in v1.5.0

func (s *CreateThingTypeInput) SetThingTypeName(v string) *CreateThingTypeInput

SetThingTypeName sets the ThingTypeName field's value.

func (*CreateThingTypeInput) SetThingTypeProperties added in v1.5.0

func (s *CreateThingTypeInput) SetThingTypeProperties(v *ThingTypeProperties) *CreateThingTypeInput

SetThingTypeProperties sets the ThingTypeProperties field's value.

func (CreateThingTypeInput) String added in v1.2.8

func (s CreateThingTypeInput) String() string

String returns the string representation

func (*CreateThingTypeInput) Validate added in v1.2.8

func (s *CreateThingTypeInput) Validate() error

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

type CreateThingTypeOutput added in v1.2.8

type CreateThingTypeOutput struct {

	// The Amazon Resource Name (ARN) of the thing type.
	ThingTypeArn *string `locationName:"thingTypeArn" type:"string"`

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

The output of the CreateThingType operation.

func (CreateThingTypeOutput) GoString added in v1.2.8

func (s CreateThingTypeOutput) GoString() string

GoString returns the string representation

func (*CreateThingTypeOutput) SetThingTypeArn added in v1.5.0

func (s *CreateThingTypeOutput) SetThingTypeArn(v string) *CreateThingTypeOutput

SetThingTypeArn sets the ThingTypeArn field's value.

func (*CreateThingTypeOutput) SetThingTypeName added in v1.5.0

func (s *CreateThingTypeOutput) SetThingTypeName(v string) *CreateThingTypeOutput

SetThingTypeName sets the ThingTypeName field's value.

func (CreateThingTypeOutput) String added in v1.2.8

func (s CreateThingTypeOutput) String() string

String returns the string representation

type CreateTopicRuleInput

type CreateTopicRuleInput struct {

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

	// The rule payload.
	//
	// TopicRulePayload is a required field
	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) SetRuleName added in v1.5.0

SetRuleName sets the RuleName field's value.

func (*CreateTopicRuleInput) SetTopicRulePayload added in v1.5.0

func (s *CreateTopicRuleInput) SetTopicRulePayload(v *TopicRulePayload) *CreateTopicRuleInput

SetTopicRulePayload sets the TopicRulePayload field's value.

func (CreateTopicRuleInput) String

func (s CreateTopicRuleInput) String() string

String returns the string representation

func (*CreateTopicRuleInput) Validate added in v1.1.21

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 added in v1.1.18

type DeleteCACertificateInput struct {

	// The ID of the certificate to delete.
	//
	// CertificateId is a required field
	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 added in v1.1.18

func (s DeleteCACertificateInput) GoString() string

GoString returns the string representation

func (*DeleteCACertificateInput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (DeleteCACertificateInput) String added in v1.1.18

func (s DeleteCACertificateInput) String() string

String returns the string representation

func (*DeleteCACertificateInput) Validate added in v1.1.21

func (s *DeleteCACertificateInput) Validate() error

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

type DeleteCACertificateOutput added in v1.1.18

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

The output for the DeleteCACertificate operation.

func (DeleteCACertificateOutput) GoString added in v1.1.18

func (s DeleteCACertificateOutput) GoString() string

GoString returns the string representation

func (DeleteCACertificateOutput) String added in v1.1.18

func (s DeleteCACertificateOutput) String() string

String returns the string representation

type DeleteCertificateInput

type DeleteCertificateInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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) SetCertificateId added in v1.5.0

func (s *DeleteCertificateInput) SetCertificateId(v string) *DeleteCertificateInput

SetCertificateId sets the CertificateId field's value.

func (DeleteCertificateInput) String

func (s DeleteCertificateInput) String() string

String returns the string representation

func (*DeleteCertificateInput) Validate added in v1.1.21

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 is a required field
	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) SetPolicyName added in v1.5.0

func (s *DeletePolicyInput) SetPolicyName(v string) *DeletePolicyInput

SetPolicyName sets the PolicyName field's value.

func (DeletePolicyInput) String

func (s DeletePolicyInput) String() string

String returns the string representation

func (*DeletePolicyInput) Validate added in v1.1.21

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 is a required field
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The policy version ID.
	//
	// PolicyVersionId is a required field
	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) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*DeletePolicyVersionInput) SetPolicyVersionId added in v1.5.0

func (s *DeletePolicyVersionInput) SetPolicyVersionId(v string) *DeletePolicyVersionInput

SetPolicyVersionId sets the PolicyVersionId field's value.

func (DeletePolicyVersionInput) String

func (s DeletePolicyVersionInput) String() string

String returns the string representation

func (*DeletePolicyVersionInput) Validate added in v1.1.21

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 added in v1.1.18

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

The input for the DeleteRegistrationCode operation.

func (DeleteRegistrationCodeInput) GoString added in v1.1.18

func (s DeleteRegistrationCodeInput) GoString() string

GoString returns the string representation

func (DeleteRegistrationCodeInput) String added in v1.1.18

String returns the string representation

type DeleteRegistrationCodeOutput added in v1.1.18

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

The output for the DeleteRegistrationCode operation.

func (DeleteRegistrationCodeOutput) GoString added in v1.1.18

func (s DeleteRegistrationCodeOutput) GoString() string

GoString returns the string representation

func (DeleteRegistrationCodeOutput) String added in v1.1.18

String returns the string representation

type DeleteThingInput

type DeleteThingInput struct {

	// The expected version of the thing record in the registry. If the version
	// of the record in the registry does not match the expected version specified
	// in the request, the DeleteThing request is rejected with a VersionConflictException.
	ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"`

	// The name of the thing to delete.
	//
	// ThingName is a required field
	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) SetExpectedVersion added in v1.5.0

func (s *DeleteThingInput) SetExpectedVersion(v int64) *DeleteThingInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*DeleteThingInput) SetThingName added in v1.5.0

func (s *DeleteThingInput) SetThingName(v string) *DeleteThingInput

SetThingName sets the ThingName field's value.

func (DeleteThingInput) String

func (s DeleteThingInput) String() string

String returns the string representation

func (*DeleteThingInput) Validate added in v1.1.21

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 DeleteThingTypeInput added in v1.2.8

type DeleteThingTypeInput struct {

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

The input for the DeleteThingType operation.

func (DeleteThingTypeInput) GoString added in v1.2.8

func (s DeleteThingTypeInput) GoString() string

GoString returns the string representation

func (*DeleteThingTypeInput) SetThingTypeName added in v1.5.0

func (s *DeleteThingTypeInput) SetThingTypeName(v string) *DeleteThingTypeInput

SetThingTypeName sets the ThingTypeName field's value.

func (DeleteThingTypeInput) String added in v1.2.8

func (s DeleteThingTypeInput) String() string

String returns the string representation

func (*DeleteThingTypeInput) Validate added in v1.2.8

func (s *DeleteThingTypeInput) Validate() error

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

type DeleteThingTypeOutput added in v1.2.8

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

The output for the DeleteThingType operation.

func (DeleteThingTypeOutput) GoString added in v1.2.8

func (s DeleteThingTypeOutput) GoString() string

GoString returns the string representation

func (DeleteThingTypeOutput) String added in v1.2.8

func (s DeleteThingTypeOutput) String() string

String returns the string representation

type DeleteTopicRuleInput

type DeleteTopicRuleInput struct {

	// The name of the rule.
	//
	// RuleName is a required field
	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) SetRuleName added in v1.5.0

SetRuleName sets the RuleName field's value.

func (DeleteTopicRuleInput) String

func (s DeleteTopicRuleInput) String() string

String returns the string representation

func (*DeleteTopicRuleInput) Validate added in v1.1.21

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 DeprecateThingTypeInput added in v1.2.8

type DeprecateThingTypeInput struct {

	// The name of the thing type to deprecate.
	//
	// ThingTypeName is a required field
	ThingTypeName *string `location:"uri" locationName:"thingTypeName" min:"1" type:"string" required:"true"`

	// Whether to undeprecate a deprecated thing type. If true, the thing type will
	// not be deprecated anymore and you can associate it with things.
	UndoDeprecate *bool `locationName:"undoDeprecate" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the DeprecateThingType operation.

func (DeprecateThingTypeInput) GoString added in v1.2.8

func (s DeprecateThingTypeInput) GoString() string

GoString returns the string representation

func (*DeprecateThingTypeInput) SetThingTypeName added in v1.5.0

func (s *DeprecateThingTypeInput) SetThingTypeName(v string) *DeprecateThingTypeInput

SetThingTypeName sets the ThingTypeName field's value.

func (*DeprecateThingTypeInput) SetUndoDeprecate added in v1.5.0

func (s *DeprecateThingTypeInput) SetUndoDeprecate(v bool) *DeprecateThingTypeInput

SetUndoDeprecate sets the UndoDeprecate field's value.

func (DeprecateThingTypeInput) String added in v1.2.8

func (s DeprecateThingTypeInput) String() string

String returns the string representation

func (*DeprecateThingTypeInput) Validate added in v1.2.8

func (s *DeprecateThingTypeInput) Validate() error

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

type DeprecateThingTypeOutput added in v1.2.8

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

The output for the DeprecateThingType operation.

func (DeprecateThingTypeOutput) GoString added in v1.2.8

func (s DeprecateThingTypeOutput) GoString() string

GoString returns the string representation

func (DeprecateThingTypeOutput) String added in v1.2.8

func (s DeprecateThingTypeOutput) String() string

String returns the string representation

type DescribeCACertificateInput added in v1.1.18

type DescribeCACertificateInput struct {

	// The CA certificate identifier.
	//
	// CertificateId is a required field
	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 added in v1.1.18

func (s DescribeCACertificateInput) GoString() string

GoString returns the string representation

func (*DescribeCACertificateInput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (DescribeCACertificateInput) String added in v1.1.18

String returns the string representation

func (*DescribeCACertificateInput) Validate added in v1.1.21

func (s *DescribeCACertificateInput) Validate() error

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

type DescribeCACertificateOutput added in v1.1.18

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 added in v1.1.18

func (s DescribeCACertificateOutput) GoString() string

GoString returns the string representation

func (*DescribeCACertificateOutput) SetCertificateDescription added in v1.5.0

SetCertificateDescription sets the CertificateDescription field's value.

func (DescribeCACertificateOutput) String added in v1.1.18

String returns the string representation

type DescribeCertificateInput

type DescribeCertificateInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (DescribeCertificateInput) String

func (s DescribeCertificateInput) String() string

String returns the string representation

func (*DescribeCertificateInput) Validate added in v1.1.21

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) SetCertificateDescription added in v1.5.0

SetCertificateDescription sets the CertificateDescription field's value.

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) SetEndpointAddress added in v1.5.0

func (s *DescribeEndpointOutput) SetEndpointAddress(v string) *DescribeEndpointOutput

SetEndpointAddress sets the EndpointAddress field's value.

func (DescribeEndpointOutput) String

func (s DescribeEndpointOutput) String() string

String returns the string representation

type DescribeThingInput

type DescribeThingInput struct {

	// The name of the thing.
	//
	// ThingName is a required field
	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) SetThingName added in v1.5.0

func (s *DescribeThingInput) SetThingName(v string) *DescribeThingInput

SetThingName sets the ThingName field's value.

func (DescribeThingInput) String

func (s DescribeThingInput) String() string

String returns the string representation

func (*DescribeThingInput) Validate added in v1.1.21

func (s *DescribeThingInput) Validate() error

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

type DescribeThingOutput

type DescribeThingOutput struct {

	// The thing attributes.
	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"`

	// The thing type name.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`

	// The current version of the thing record in the registry.
	//
	// To avoid unintentional changes to the information in the registry, you can
	// pass the version information in the expectedVersion parameter of the UpdateThing
	// and DeleteThing calls.
	Version *int64 `locationName:"version" type:"long"`
	// 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) SetAttributes added in v1.5.0

func (s *DescribeThingOutput) SetAttributes(v map[string]*string) *DescribeThingOutput

SetAttributes sets the Attributes field's value.

func (*DescribeThingOutput) SetDefaultClientId added in v1.5.0

func (s *DescribeThingOutput) SetDefaultClientId(v string) *DescribeThingOutput

SetDefaultClientId sets the DefaultClientId field's value.

func (*DescribeThingOutput) SetThingName added in v1.5.0

func (s *DescribeThingOutput) SetThingName(v string) *DescribeThingOutput

SetThingName sets the ThingName field's value.

func (*DescribeThingOutput) SetThingTypeName added in v1.5.0

func (s *DescribeThingOutput) SetThingTypeName(v string) *DescribeThingOutput

SetThingTypeName sets the ThingTypeName field's value.

func (*DescribeThingOutput) SetVersion added in v1.5.0

func (s *DescribeThingOutput) SetVersion(v int64) *DescribeThingOutput

SetVersion sets the Version field's value.

func (DescribeThingOutput) String

func (s DescribeThingOutput) String() string

String returns the string representation

type DescribeThingTypeInput added in v1.2.8

type DescribeThingTypeInput struct {

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

The input for the DescribeThingType operation.

func (DescribeThingTypeInput) GoString added in v1.2.8

func (s DescribeThingTypeInput) GoString() string

GoString returns the string representation

func (*DescribeThingTypeInput) SetThingTypeName added in v1.5.0

func (s *DescribeThingTypeInput) SetThingTypeName(v string) *DescribeThingTypeInput

SetThingTypeName sets the ThingTypeName field's value.

func (DescribeThingTypeInput) String added in v1.2.8

func (s DescribeThingTypeInput) String() string

String returns the string representation

func (*DescribeThingTypeInput) Validate added in v1.2.8

func (s *DescribeThingTypeInput) Validate() error

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

type DescribeThingTypeOutput added in v1.2.8

type DescribeThingTypeOutput struct {

	// The ThingTypeMetadata contains additional information about the thing type
	// including: creation date and time, a value indicating whether the thing type
	// is deprecated, and a date and time when time was deprecated.
	ThingTypeMetadata *ThingTypeMetadata `locationName:"thingTypeMetadata" type:"structure"`

	// The name of the thing type.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`

	// The ThingTypeProperties contains information about the thing type including
	// description, and a list of searchable thing attribute names.
	ThingTypeProperties *ThingTypeProperties `locationName:"thingTypeProperties" type:"structure"`
	// contains filtered or unexported fields
}

The output for the DescribeThingType operation.

func (DescribeThingTypeOutput) GoString added in v1.2.8

func (s DescribeThingTypeOutput) GoString() string

GoString returns the string representation

func (*DescribeThingTypeOutput) SetThingTypeMetadata added in v1.5.0

SetThingTypeMetadata sets the ThingTypeMetadata field's value.

func (*DescribeThingTypeOutput) SetThingTypeName added in v1.5.0

func (s *DescribeThingTypeOutput) SetThingTypeName(v string) *DescribeThingTypeOutput

SetThingTypeName sets the ThingTypeName field's value.

func (*DescribeThingTypeOutput) SetThingTypeProperties added in v1.5.0

SetThingTypeProperties sets the ThingTypeProperties field's value.

func (DescribeThingTypeOutput) String added in v1.2.8

func (s DescribeThingTypeOutput) String() string

String returns the string representation

type DetachPrincipalPolicyInput

type DetachPrincipalPolicyInput struct {

	// The name of the policy to detach.
	//
	// PolicyName is a required field
	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 is a required field
	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) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*DetachPrincipalPolicyInput) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (DetachPrincipalPolicyInput) String

String returns the string representation

func (*DetachPrincipalPolicyInput) Validate added in v1.1.21

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 {

	// If the principal is a certificate, this value must be ARN of the certificate.
	// If the principal is an Amazon Cognito identity, this value must be the ID
	// of the Amazon Cognito identity.
	//
	// Principal is a required field
	Principal *string `location:"header" locationName:"x-amzn-principal" type:"string" required:"true"`

	// The name of the thing.
	//
	// ThingName is a required field
	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) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (*DetachThingPrincipalInput) SetThingName added in v1.5.0

SetThingName sets the ThingName field's value.

func (DetachThingPrincipalInput) String

func (s DetachThingPrincipalInput) String() string

String returns the string representation

func (*DetachThingPrincipalInput) Validate added in v1.1.21

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 added in v1.0.11

type DisableTopicRuleInput struct {

	// The name of the rule to disable.
	//
	// RuleName is a required field
	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 added in v1.0.11

func (s DisableTopicRuleInput) GoString() string

GoString returns the string representation

func (*DisableTopicRuleInput) SetRuleName added in v1.5.0

SetRuleName sets the RuleName field's value.

func (DisableTopicRuleInput) String added in v1.0.11

func (s DisableTopicRuleInput) String() string

String returns the string representation

func (*DisableTopicRuleInput) Validate added in v1.1.21

func (s *DisableTopicRuleInput) Validate() error

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

type DisableTopicRuleOutput added in v1.0.11

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

func (DisableTopicRuleOutput) GoString added in v1.0.11

func (s DisableTopicRuleOutput) GoString() string

GoString returns the string representation

func (DisableTopicRuleOutput) String added in v1.0.11

func (s DisableTopicRuleOutput) String() string

String returns the string representation

type DynamoDBAction

type DynamoDBAction struct {

	// The hash key name.
	//
	// HashKeyField is a required field
	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 is a required field
	HashKeyValue *string `locationName:"hashKeyValue" type:"string" required:"true"`

	// The type of operation to be performed. This follows the substitution template,
	// so it can be ${operation}, but the substitution must result in one of the
	// following: INSERT, UPDATE, or DELETE.
	Operation *string `locationName:"operation" type:"string"`

	// 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 is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the DynamoDB table.
	//
	// TableName is a required field
	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) SetHashKeyField added in v1.5.0

func (s *DynamoDBAction) SetHashKeyField(v string) *DynamoDBAction

SetHashKeyField sets the HashKeyField field's value.

func (*DynamoDBAction) SetHashKeyType added in v1.5.0

func (s *DynamoDBAction) SetHashKeyType(v string) *DynamoDBAction

SetHashKeyType sets the HashKeyType field's value.

func (*DynamoDBAction) SetHashKeyValue added in v1.5.0

func (s *DynamoDBAction) SetHashKeyValue(v string) *DynamoDBAction

SetHashKeyValue sets the HashKeyValue field's value.

func (*DynamoDBAction) SetOperation added in v1.5.0

func (s *DynamoDBAction) SetOperation(v string) *DynamoDBAction

SetOperation sets the Operation field's value.

func (*DynamoDBAction) SetPayloadField added in v1.5.0

func (s *DynamoDBAction) SetPayloadField(v string) *DynamoDBAction

SetPayloadField sets the PayloadField field's value.

func (*DynamoDBAction) SetRangeKeyField added in v1.5.0

func (s *DynamoDBAction) SetRangeKeyField(v string) *DynamoDBAction

SetRangeKeyField sets the RangeKeyField field's value.

func (*DynamoDBAction) SetRangeKeyType added in v1.5.0

func (s *DynamoDBAction) SetRangeKeyType(v string) *DynamoDBAction

SetRangeKeyType sets the RangeKeyType field's value.

func (*DynamoDBAction) SetRangeKeyValue added in v1.5.0

func (s *DynamoDBAction) SetRangeKeyValue(v string) *DynamoDBAction

SetRangeKeyValue sets the RangeKeyValue field's value.

func (*DynamoDBAction) SetRoleArn added in v1.5.0

func (s *DynamoDBAction) SetRoleArn(v string) *DynamoDBAction

SetRoleArn sets the RoleArn field's value.

func (*DynamoDBAction) SetTableName added in v1.5.0

func (s *DynamoDBAction) SetTableName(v string) *DynamoDBAction

SetTableName sets the TableName field's value.

func (DynamoDBAction) String

func (s DynamoDBAction) String() string

String returns the string representation

func (*DynamoDBAction) Validate added in v1.1.21

func (s *DynamoDBAction) Validate() error

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

type DynamoDBv2Action added in v1.4.19

type DynamoDBv2Action struct {

	// Specifies the DynamoDB table to which the message data will be written. For
	// example:
	//
	// { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName":
	// "my-table" } } }
	//
	// Each attribute in the message payload will be written to a separate column
	// in the DynamoDB database.
	PutItem *PutItemInput `locationName:"putItem" type:"structure"`

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

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

func (DynamoDBv2Action) GoString added in v1.4.19

func (s DynamoDBv2Action) GoString() string

GoString returns the string representation

func (*DynamoDBv2Action) SetPutItem added in v1.5.0

func (s *DynamoDBv2Action) SetPutItem(v *PutItemInput) *DynamoDBv2Action

SetPutItem sets the PutItem field's value.

func (*DynamoDBv2Action) SetRoleArn added in v1.5.0

func (s *DynamoDBv2Action) SetRoleArn(v string) *DynamoDBv2Action

SetRoleArn sets the RoleArn field's value.

func (DynamoDBv2Action) String added in v1.4.19

func (s DynamoDBv2Action) String() string

String returns the string representation

func (*DynamoDBv2Action) Validate added in v1.4.19

func (s *DynamoDBv2Action) Validate() error

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

type ElasticsearchAction added in v1.1.12

type ElasticsearchAction struct {

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

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

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

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

	// The type of document you are storing.
	//
	// Type is a required field
	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 added in v1.1.12

func (s ElasticsearchAction) GoString() string

GoString returns the string representation

func (*ElasticsearchAction) SetEndpoint added in v1.5.0

func (s *ElasticsearchAction) SetEndpoint(v string) *ElasticsearchAction

SetEndpoint sets the Endpoint field's value.

func (*ElasticsearchAction) SetId added in v1.5.0

SetId sets the Id field's value.

func (*ElasticsearchAction) SetIndex added in v1.5.0

SetIndex sets the Index field's value.

func (*ElasticsearchAction) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (*ElasticsearchAction) SetType added in v1.5.0

SetType sets the Type field's value.

func (ElasticsearchAction) String added in v1.1.12

func (s ElasticsearchAction) String() string

String returns the string representation

func (*ElasticsearchAction) Validate added in v1.1.21

func (s *ElasticsearchAction) Validate() error

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

type EnableTopicRuleInput added in v1.0.11

type EnableTopicRuleInput struct {

	// The name of the topic rule to enable.
	//
	// RuleName is a required field
	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 added in v1.0.11

func (s EnableTopicRuleInput) GoString() string

GoString returns the string representation

func (*EnableTopicRuleInput) SetRuleName added in v1.5.0

SetRuleName sets the RuleName field's value.

func (EnableTopicRuleInput) String added in v1.0.11

func (s EnableTopicRuleInput) String() string

String returns the string representation

func (*EnableTopicRuleInput) Validate added in v1.1.21

func (s *EnableTopicRuleInput) Validate() error

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

type EnableTopicRuleOutput added in v1.0.11

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

func (EnableTopicRuleOutput) GoString added in v1.0.11

func (s EnableTopicRuleOutput) GoString() string

GoString returns the string representation

func (EnableTopicRuleOutput) String added in v1.0.11

func (s EnableTopicRuleOutput) String() string

String returns the string representation

type FirehoseAction

type FirehoseAction struct {

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

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

	// A character separator that will be used to separate records written to the
	// Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows
	// newline), ',' (comma).
	Separator *string `locationName:"separator" type:"string"`
	// 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) SetDeliveryStreamName added in v1.5.0

func (s *FirehoseAction) SetDeliveryStreamName(v string) *FirehoseAction

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (*FirehoseAction) SetRoleArn added in v1.5.0

func (s *FirehoseAction) SetRoleArn(v string) *FirehoseAction

SetRoleArn sets the RoleArn field's value.

func (*FirehoseAction) SetSeparator added in v1.5.0

func (s *FirehoseAction) SetSeparator(v string) *FirehoseAction

SetSeparator sets the Separator field's value.

func (FirehoseAction) String

func (s FirehoseAction) String() string

String returns the string representation

func (*FirehoseAction) Validate added in v1.1.21

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) SetLogLevel added in v1.5.0

SetLogLevel sets the LogLevel field's value.

func (*GetLoggingOptionsOutput) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (GetLoggingOptionsOutput) String

func (s GetLoggingOptionsOutput) String() string

String returns the string representation

type GetPolicyInput

type GetPolicyInput struct {

	// The name of the policy.
	//
	// PolicyName is a required field
	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) SetPolicyName added in v1.5.0

func (s *GetPolicyInput) SetPolicyName(v string) *GetPolicyInput

SetPolicyName sets the PolicyName field's value.

func (GetPolicyInput) String

func (s GetPolicyInput) String() string

String returns the string representation

func (*GetPolicyInput) Validate added in v1.1.21

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) SetDefaultVersionId added in v1.5.0

func (s *GetPolicyOutput) SetDefaultVersionId(v string) *GetPolicyOutput

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*GetPolicyOutput) SetPolicyArn added in v1.5.0

func (s *GetPolicyOutput) SetPolicyArn(v string) *GetPolicyOutput

SetPolicyArn sets the PolicyArn field's value.

func (*GetPolicyOutput) SetPolicyDocument added in v1.5.0

func (s *GetPolicyOutput) SetPolicyDocument(v string) *GetPolicyOutput

SetPolicyDocument sets the PolicyDocument field's value.

func (*GetPolicyOutput) SetPolicyName added in v1.5.0

func (s *GetPolicyOutput) SetPolicyName(v string) *GetPolicyOutput

SetPolicyName sets the PolicyName field's value.

func (GetPolicyOutput) String

func (s GetPolicyOutput) String() string

String returns the string representation

type GetPolicyVersionInput

type GetPolicyVersionInput struct {

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

	// The policy version ID.
	//
	// PolicyVersionId is a required field
	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) SetPolicyName added in v1.5.0

func (s *GetPolicyVersionInput) SetPolicyName(v string) *GetPolicyVersionInput

SetPolicyName sets the PolicyName field's value.

func (*GetPolicyVersionInput) SetPolicyVersionId added in v1.5.0

func (s *GetPolicyVersionInput) SetPolicyVersionId(v string) *GetPolicyVersionInput

SetPolicyVersionId sets the PolicyVersionId field's value.

func (GetPolicyVersionInput) String

func (s GetPolicyVersionInput) String() string

String returns the string representation

func (*GetPolicyVersionInput) Validate added in v1.1.21

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) SetIsDefaultVersion added in v1.5.0

func (s *GetPolicyVersionOutput) SetIsDefaultVersion(v bool) *GetPolicyVersionOutput

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*GetPolicyVersionOutput) SetPolicyArn added in v1.5.0

SetPolicyArn sets the PolicyArn field's value.

func (*GetPolicyVersionOutput) SetPolicyDocument added in v1.5.0

func (s *GetPolicyVersionOutput) SetPolicyDocument(v string) *GetPolicyVersionOutput

SetPolicyDocument sets the PolicyDocument field's value.

func (*GetPolicyVersionOutput) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*GetPolicyVersionOutput) SetPolicyVersionId added in v1.5.0

func (s *GetPolicyVersionOutput) SetPolicyVersionId(v string) *GetPolicyVersionOutput

SetPolicyVersionId sets the PolicyVersionId field's value.

func (GetPolicyVersionOutput) String

func (s GetPolicyVersionOutput) String() string

String returns the string representation

type GetRegistrationCodeInput added in v1.1.18

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

The input to the GetRegistrationCode operation.

func (GetRegistrationCodeInput) GoString added in v1.1.18

func (s GetRegistrationCodeInput) GoString() string

GoString returns the string representation

func (GetRegistrationCodeInput) String added in v1.1.18

func (s GetRegistrationCodeInput) String() string

String returns the string representation

type GetRegistrationCodeOutput added in v1.1.18

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 added in v1.1.18

func (s GetRegistrationCodeOutput) GoString() string

GoString returns the string representation

func (*GetRegistrationCodeOutput) SetRegistrationCode added in v1.5.0

func (s *GetRegistrationCodeOutput) SetRegistrationCode(v string) *GetRegistrationCodeOutput

SetRegistrationCode sets the RegistrationCode field's value.

func (GetRegistrationCodeOutput) String added in v1.1.18

func (s GetRegistrationCodeOutput) String() string

String returns the string representation

type GetTopicRuleInput

type GetTopicRuleInput struct {

	// The name of the rule.
	//
	// RuleName is a required field
	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) SetRuleName added in v1.5.0

func (s *GetTopicRuleInput) SetRuleName(v string) *GetTopicRuleInput

SetRuleName sets the RuleName field's value.

func (GetTopicRuleInput) String

func (s GetTopicRuleInput) String() string

String returns the string representation

func (*GetTopicRuleInput) Validate added in v1.1.21

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) SetRule added in v1.5.0

SetRule sets the Rule field's value.

func (*GetTopicRuleOutput) SetRuleArn added in v1.5.0

func (s *GetTopicRuleOutput) SetRuleArn(v string) *GetTopicRuleOutput

SetRuleArn sets the RuleArn field's value.

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)

AcceptCertificateTransfer API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation AcceptCertificateTransfer for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeTransferAlreadyCompletedException "TransferAlreadyCompletedException" You can't revert the certificate transfer because the transfer is already complete.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) AcceptCertificateTransferRequest

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

AcceptCertificateTransferRequest generates a "aws/request.Request" representing the client's request for the AcceptCertificateTransfer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AcceptCertificateTransfer for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AcceptCertificateTransfer method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AcceptCertificateTransferRequest method.
req, resp := client.AcceptCertificateTransferRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) AcceptCertificateTransferWithContext added in v1.8.0

func (c *IoT) AcceptCertificateTransferWithContext(ctx aws.Context, input *AcceptCertificateTransferInput, opts ...request.Option) (*AcceptCertificateTransferOutput, error)

AcceptCertificateTransferWithContext is the same as AcceptCertificateTransfer with the addition of the ability to pass a context and additional request options.

See AcceptCertificateTransfer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) AttachPrincipalPolicy

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

AttachPrincipalPolicy API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation AttachPrincipalPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeLimitExceededException "LimitExceededException" The number of attached entities exceeds the limit.

Example
Output:

func (*IoT) AttachPrincipalPolicyRequest

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

AttachPrincipalPolicyRequest generates a "aws/request.Request" representing the client's request for the AttachPrincipalPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AttachPrincipalPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AttachPrincipalPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AttachPrincipalPolicyRequest method.
req, resp := client.AttachPrincipalPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) AttachPrincipalPolicyWithContext added in v1.8.0

func (c *IoT) AttachPrincipalPolicyWithContext(ctx aws.Context, input *AttachPrincipalPolicyInput, opts ...request.Option) (*AttachPrincipalPolicyOutput, error)

AttachPrincipalPolicyWithContext is the same as AttachPrincipalPolicy with the addition of the ability to pass a context and additional request options.

See AttachPrincipalPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) AttachThingPrincipal

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

AttachThingPrincipal API operation for AWS IoT.

Attaches the specified principal to the specified thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation AttachThingPrincipal for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) AttachThingPrincipalRequest

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

AttachThingPrincipalRequest generates a "aws/request.Request" representing the client's request for the AttachThingPrincipal operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AttachThingPrincipal for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AttachThingPrincipal method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AttachThingPrincipalRequest method.
req, resp := client.AttachThingPrincipalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) AttachThingPrincipalWithContext added in v1.8.0

func (c *IoT) AttachThingPrincipalWithContext(ctx aws.Context, input *AttachThingPrincipalInput, opts ...request.Option) (*AttachThingPrincipalOutput, error)

AttachThingPrincipalWithContext is the same as AttachThingPrincipal with the addition of the ability to pass a context and additional request options.

See AttachThingPrincipal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CancelCertificateTransfer

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

CancelCertificateTransfer API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CancelCertificateTransfer for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeTransferAlreadyCompletedException "TransferAlreadyCompletedException" You can't revert the certificate transfer because the transfer is already complete.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) CancelCertificateTransferRequest

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

CancelCertificateTransferRequest generates a "aws/request.Request" representing the client's request for the CancelCertificateTransfer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CancelCertificateTransfer for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CancelCertificateTransfer method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CancelCertificateTransferRequest method.
req, resp := client.CancelCertificateTransferRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CancelCertificateTransferWithContext added in v1.8.0

func (c *IoT) CancelCertificateTransferWithContext(ctx aws.Context, input *CancelCertificateTransferInput, opts ...request.Option) (*CancelCertificateTransferOutput, error)

CancelCertificateTransferWithContext is the same as CancelCertificateTransfer with the addition of the ability to pass a context and additional request options.

See CancelCertificateTransfer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreateCertificateFromCsr

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

CreateCertificateFromCsr API operation for AWS IoT.

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"

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreateCertificateFromCsr for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) CreateCertificateFromCsrRequest

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

CreateCertificateFromCsrRequest generates a "aws/request.Request" representing the client's request for the CreateCertificateFromCsr operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateCertificateFromCsr for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateCertificateFromCsr method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateCertificateFromCsrRequest method.
req, resp := client.CreateCertificateFromCsrRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreateCertificateFromCsrWithContext added in v1.8.0

func (c *IoT) CreateCertificateFromCsrWithContext(ctx aws.Context, input *CreateCertificateFromCsrInput, opts ...request.Option) (*CreateCertificateFromCsrOutput, error)

CreateCertificateFromCsrWithContext is the same as CreateCertificateFromCsr with the addition of the ability to pass a context and additional request options.

See CreateCertificateFromCsr for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreateKeysAndCertificate

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

CreateKeysAndCertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreateKeysAndCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) CreateKeysAndCertificateRequest

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

CreateKeysAndCertificateRequest generates a "aws/request.Request" representing the client's request for the CreateKeysAndCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateKeysAndCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateKeysAndCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateKeysAndCertificateRequest method.
req, resp := client.CreateKeysAndCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreateKeysAndCertificateWithContext added in v1.8.0

func (c *IoT) CreateKeysAndCertificateWithContext(ctx aws.Context, input *CreateKeysAndCertificateInput, opts ...request.Option) (*CreateKeysAndCertificateOutput, error)

CreateKeysAndCertificateWithContext is the same as CreateKeysAndCertificate with the addition of the ability to pass a context and additional request options.

See CreateKeysAndCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreatePolicy

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

CreatePolicy API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreatePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeMalformedPolicyException "MalformedPolicyException" The policy documentation is not valid.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) CreatePolicyRequest

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

CreatePolicyRequest generates a "aws/request.Request" representing the client's request for the CreatePolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreatePolicyRequest method.
req, resp := client.CreatePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreatePolicyVersion

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

CreatePolicyVersion API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreatePolicyVersion for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeMalformedPolicyException "MalformedPolicyException" The policy documentation is not valid.

  • ErrCodeVersionsLimitExceededException "VersionsLimitExceededException" The number of policy versions exceeds the limit.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) CreatePolicyVersionRequest

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

CreatePolicyVersionRequest generates a "aws/request.Request" representing the client's request for the CreatePolicyVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePolicyVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePolicyVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreatePolicyVersionRequest method.
req, resp := client.CreatePolicyVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreatePolicyVersionWithContext added in v1.8.0

func (c *IoT) CreatePolicyVersionWithContext(ctx aws.Context, input *CreatePolicyVersionInput, opts ...request.Option) (*CreatePolicyVersionOutput, error)

CreatePolicyVersionWithContext is the same as CreatePolicyVersion with the addition of the ability to pass a context and additional request options.

See CreatePolicyVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreatePolicyWithContext added in v1.8.0

func (c *IoT) CreatePolicyWithContext(ctx aws.Context, input *CreatePolicyInput, opts ...request.Option) (*CreatePolicyOutput, error)

CreatePolicyWithContext is the same as CreatePolicy with the addition of the ability to pass a context and additional request options.

See CreatePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreateThing

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

CreateThing API operation for AWS IoT.

Creates a thing record in the thing registry.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreateThing for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) CreateThingRequest

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

CreateThingRequest generates a "aws/request.Request" representing the client's request for the CreateThing operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateThing for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateThing method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateThingRequest method.
req, resp := client.CreateThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreateThingType added in v1.2.8

func (c *IoT) CreateThingType(input *CreateThingTypeInput) (*CreateThingTypeOutput, error)

CreateThingType API operation for AWS IoT.

Creates a new thing type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreateThingType for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

Example
Output:

func (*IoT) CreateThingTypeRequest added in v1.2.8

func (c *IoT) CreateThingTypeRequest(input *CreateThingTypeInput) (req *request.Request, output *CreateThingTypeOutput)

CreateThingTypeRequest generates a "aws/request.Request" representing the client's request for the CreateThingType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateThingType for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateThingType method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateThingTypeRequest method.
req, resp := client.CreateThingTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreateThingTypeWithContext added in v1.8.0

func (c *IoT) CreateThingTypeWithContext(ctx aws.Context, input *CreateThingTypeInput, opts ...request.Option) (*CreateThingTypeOutput, error)

CreateThingTypeWithContext is the same as CreateThingType with the addition of the ability to pass a context and additional request options.

See CreateThingType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreateThingWithContext added in v1.8.0

func (c *IoT) CreateThingWithContext(ctx aws.Context, input *CreateThingInput, opts ...request.Option) (*CreateThingOutput, error)

CreateThingWithContext is the same as CreateThing with the addition of the ability to pass a context and additional request options.

See CreateThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) CreateTopicRule

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

CreateTopicRule API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation CreateTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeSqlParseException "SqlParseException" The Rule-SQL expression can't be parsed correctly.

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

Example
Output:

func (*IoT) CreateTopicRuleRequest

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

CreateTopicRuleRequest generates a "aws/request.Request" representing the client's request for the CreateTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateTopicRuleRequest method.
req, resp := client.CreateTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) CreateTopicRuleWithContext added in v1.8.0

func (c *IoT) CreateTopicRuleWithContext(ctx aws.Context, input *CreateTopicRuleInput, opts ...request.Option) (*CreateTopicRuleOutput, error)

CreateTopicRuleWithContext is the same as CreateTopicRule with the addition of the ability to pass a context and additional request options.

See CreateTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteCACertificate added in v1.1.18

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

DeleteCACertificate API operation for AWS IoT.

Deletes a registered CA certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteCACertificate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeCertificateStateException "CertificateStateException" The certificate operation is not allowed.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) DeleteCACertificateRequest added in v1.1.18

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

DeleteCACertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteCACertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteCACertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteCACertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteCACertificateRequest method.
req, resp := client.DeleteCACertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteCACertificateWithContext added in v1.8.0

func (c *IoT) DeleteCACertificateWithContext(ctx aws.Context, input *DeleteCACertificateInput, opts ...request.Option) (*DeleteCACertificateOutput, error)

DeleteCACertificateWithContext is the same as DeleteCACertificate with the addition of the ability to pass a context and additional request options.

See DeleteCACertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteCertificate

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

DeleteCertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeCertificateStateException "CertificateStateException" The certificate operation is not allowed.

  • ErrCodeDeleteConflictException "DeleteConflictException" You can't delete the resource because it is attached to one or more resources.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) DeleteCertificateRequest

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

DeleteCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteCertificateRequest method.
req, resp := client.DeleteCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteCertificateWithContext added in v1.8.0

func (c *IoT) DeleteCertificateWithContext(ctx aws.Context, input *DeleteCertificateInput, opts ...request.Option) (*DeleteCertificateOutput, error)

DeleteCertificateWithContext is the same as DeleteCertificate with the addition of the ability to pass a context and additional request options.

See DeleteCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeletePolicy

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

DeletePolicy API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeletePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeDeleteConflictException "DeleteConflictException" You can't delete the resource because it is attached to one or more resources.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeletePolicyRequest

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

DeletePolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeletePolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeletePolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeletePolicyRequest method.
req, resp := client.DeletePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeletePolicyVersion

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

DeletePolicyVersion API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeletePolicyVersion for usage and error information.

Returned Error Codes:

  • ErrCodeDeleteConflictException "DeleteConflictException" You can't delete the resource because it is attached to one or more resources.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeletePolicyVersionRequest

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

DeletePolicyVersionRequest generates a "aws/request.Request" representing the client's request for the DeletePolicyVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeletePolicyVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeletePolicyVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeletePolicyVersionRequest method.
req, resp := client.DeletePolicyVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeletePolicyVersionWithContext added in v1.8.0

func (c *IoT) DeletePolicyVersionWithContext(ctx aws.Context, input *DeletePolicyVersionInput, opts ...request.Option) (*DeletePolicyVersionOutput, error)

DeletePolicyVersionWithContext is the same as DeletePolicyVersion with the addition of the ability to pass a context and additional request options.

See DeletePolicyVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeletePolicyWithContext added in v1.8.0

func (c *IoT) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error)

DeletePolicyWithContext is the same as DeletePolicy with the addition of the ability to pass a context and additional request options.

See DeletePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteRegistrationCode added in v1.1.18

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

DeleteRegistrationCode API operation for AWS IoT.

Deletes a CA certificate registration code.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteRegistrationCode for usage and error information.

Returned Error Codes:

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeleteRegistrationCodeRequest added in v1.1.18

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

DeleteRegistrationCodeRequest generates a "aws/request.Request" representing the client's request for the DeleteRegistrationCode operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteRegistrationCode for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteRegistrationCode method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteRegistrationCodeRequest method.
req, resp := client.DeleteRegistrationCodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteRegistrationCodeWithContext added in v1.8.0

func (c *IoT) DeleteRegistrationCodeWithContext(ctx aws.Context, input *DeleteRegistrationCodeInput, opts ...request.Option) (*DeleteRegistrationCodeOutput, error)

DeleteRegistrationCodeWithContext is the same as DeleteRegistrationCode with the addition of the ability to pass a context and additional request options.

See DeleteRegistrationCode for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteThing

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

DeleteThing API operation for AWS IoT.

Deletes the specified thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteThing for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeVersionConflictException "VersionConflictException" An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeleteThingRequest

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

DeleteThingRequest generates a "aws/request.Request" representing the client's request for the DeleteThing operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteThing for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteThing method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteThingRequest method.
req, resp := client.DeleteThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteThingType added in v1.2.8

func (c *IoT) DeleteThingType(input *DeleteThingTypeInput) (*DeleteThingTypeOutput, error)

DeleteThingType API operation for AWS IoT.

Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteThingType for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeleteThingTypeRequest added in v1.2.8

func (c *IoT) DeleteThingTypeRequest(input *DeleteThingTypeInput) (req *request.Request, output *DeleteThingTypeOutput)

DeleteThingTypeRequest generates a "aws/request.Request" representing the client's request for the DeleteThingType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteThingType for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteThingType method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteThingTypeRequest method.
req, resp := client.DeleteThingTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteThingTypeWithContext added in v1.8.0

func (c *IoT) DeleteThingTypeWithContext(ctx aws.Context, input *DeleteThingTypeInput, opts ...request.Option) (*DeleteThingTypeOutput, error)

DeleteThingTypeWithContext is the same as DeleteThingType with the addition of the ability to pass a context and additional request options.

See DeleteThingType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteThingWithContext added in v1.8.0

func (c *IoT) DeleteThingWithContext(ctx aws.Context, input *DeleteThingInput, opts ...request.Option) (*DeleteThingOutput, error)

DeleteThingWithContext is the same as DeleteThing with the addition of the ability to pass a context and additional request options.

See DeleteThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeleteTopicRule

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

DeleteTopicRule API operation for AWS IoT.

Deletes the specified rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeleteTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

Example
Output:

func (*IoT) DeleteTopicRuleRequest

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

DeleteTopicRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteTopicRuleRequest method.
req, resp := client.DeleteTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeleteTopicRuleWithContext added in v1.8.0

func (c *IoT) DeleteTopicRuleWithContext(ctx aws.Context, input *DeleteTopicRuleInput, opts ...request.Option) (*DeleteTopicRuleOutput, error)

DeleteTopicRuleWithContext is the same as DeleteTopicRule with the addition of the ability to pass a context and additional request options.

See DeleteTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DeprecateThingType added in v1.2.8

func (c *IoT) DeprecateThingType(input *DeprecateThingTypeInput) (*DeprecateThingTypeOutput, error)

DeprecateThingType API operation for AWS IoT.

Deprecates a thing type. You can not associate new things with deprecated thing type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DeprecateThingType for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DeprecateThingTypeRequest added in v1.2.8

func (c *IoT) DeprecateThingTypeRequest(input *DeprecateThingTypeInput) (req *request.Request, output *DeprecateThingTypeOutput)

DeprecateThingTypeRequest generates a "aws/request.Request" representing the client's request for the DeprecateThingType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeprecateThingType for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeprecateThingType method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeprecateThingTypeRequest method.
req, resp := client.DeprecateThingTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DeprecateThingTypeWithContext added in v1.8.0

func (c *IoT) DeprecateThingTypeWithContext(ctx aws.Context, input *DeprecateThingTypeInput, opts ...request.Option) (*DeprecateThingTypeOutput, error)

DeprecateThingTypeWithContext is the same as DeprecateThingType with the addition of the ability to pass a context and additional request options.

See DeprecateThingType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DescribeCACertificate added in v1.1.18

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

DescribeCACertificate API operation for AWS IoT.

Describes a registered CA certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DescribeCACertificate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) DescribeCACertificateRequest added in v1.1.18

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

DescribeCACertificateRequest generates a "aws/request.Request" representing the client's request for the DescribeCACertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeCACertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeCACertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeCACertificateRequest method.
req, resp := client.DescribeCACertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DescribeCACertificateWithContext added in v1.8.0

func (c *IoT) DescribeCACertificateWithContext(ctx aws.Context, input *DescribeCACertificateInput, opts ...request.Option) (*DescribeCACertificateOutput, error)

DescribeCACertificateWithContext is the same as DescribeCACertificate with the addition of the ability to pass a context and additional request options.

See DescribeCACertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DescribeCertificate

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

DescribeCertificate API operation for AWS IoT.

Gets information about the specified certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DescribeCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) DescribeCertificateRequest

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

DescribeCertificateRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeCertificateRequest method.
req, resp := client.DescribeCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DescribeCertificateWithContext added in v1.8.0

func (c *IoT) DescribeCertificateWithContext(ctx aws.Context, input *DescribeCertificateInput, opts ...request.Option) (*DescribeCertificateOutput, error)

DescribeCertificateWithContext is the same as DescribeCertificate with the addition of the ability to pass a context and additional request options.

See DescribeCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DescribeEndpoint

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

DescribeEndpoint API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DescribeEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

Example
Output:

func (*IoT) DescribeEndpointRequest

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

DescribeEndpointRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoint operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeEndpoint for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeEndpoint method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeEndpointRequest method.
req, resp := client.DescribeEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DescribeEndpointWithContext added in v1.8.0

func (c *IoT) DescribeEndpointWithContext(ctx aws.Context, input *DescribeEndpointInput, opts ...request.Option) (*DescribeEndpointOutput, error)

DescribeEndpointWithContext is the same as DescribeEndpoint with the addition of the ability to pass a context and additional request options.

See DescribeEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DescribeThing

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

DescribeThing API operation for AWS IoT.

Gets information about the specified thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DescribeThing for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DescribeThingRequest

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

DescribeThingRequest generates a "aws/request.Request" representing the client's request for the DescribeThing operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeThing for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeThing method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeThingRequest method.
req, resp := client.DescribeThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DescribeThingType added in v1.2.8

func (c *IoT) DescribeThingType(input *DescribeThingTypeInput) (*DescribeThingTypeOutput, error)

DescribeThingType API operation for AWS IoT.

Gets information about the specified thing type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DescribeThingType for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DescribeThingTypeRequest added in v1.2.8

func (c *IoT) DescribeThingTypeRequest(input *DescribeThingTypeInput) (req *request.Request, output *DescribeThingTypeOutput)

DescribeThingTypeRequest generates a "aws/request.Request" representing the client's request for the DescribeThingType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeThingType for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeThingType method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeThingTypeRequest method.
req, resp := client.DescribeThingTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DescribeThingTypeWithContext added in v1.8.0

func (c *IoT) DescribeThingTypeWithContext(ctx aws.Context, input *DescribeThingTypeInput, opts ...request.Option) (*DescribeThingTypeOutput, error)

DescribeThingTypeWithContext is the same as DescribeThingType with the addition of the ability to pass a context and additional request options.

See DescribeThingType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DescribeThingWithContext added in v1.8.0

func (c *IoT) DescribeThingWithContext(ctx aws.Context, input *DescribeThingInput, opts ...request.Option) (*DescribeThingOutput, error)

DescribeThingWithContext is the same as DescribeThing with the addition of the ability to pass a context and additional request options.

See DescribeThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DetachPrincipalPolicy

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

DetachPrincipalPolicy API operation for AWS IoT.

Removes the specified policy from the specified certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DetachPrincipalPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DetachPrincipalPolicyRequest

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

DetachPrincipalPolicyRequest generates a "aws/request.Request" representing the client's request for the DetachPrincipalPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DetachPrincipalPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DetachPrincipalPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DetachPrincipalPolicyRequest method.
req, resp := client.DetachPrincipalPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DetachPrincipalPolicyWithContext added in v1.8.0

func (c *IoT) DetachPrincipalPolicyWithContext(ctx aws.Context, input *DetachPrincipalPolicyInput, opts ...request.Option) (*DetachPrincipalPolicyOutput, error)

DetachPrincipalPolicyWithContext is the same as DetachPrincipalPolicy with the addition of the ability to pass a context and additional request options.

See DetachPrincipalPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DetachThingPrincipal

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

DetachThingPrincipal API operation for AWS IoT.

Detaches the specified principal from the specified thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DetachThingPrincipal for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) DetachThingPrincipalRequest

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

DetachThingPrincipalRequest generates a "aws/request.Request" representing the client's request for the DetachThingPrincipal operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DetachThingPrincipal for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DetachThingPrincipal method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DetachThingPrincipalRequest method.
req, resp := client.DetachThingPrincipalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DetachThingPrincipalWithContext added in v1.8.0

func (c *IoT) DetachThingPrincipalWithContext(ctx aws.Context, input *DetachThingPrincipalInput, opts ...request.Option) (*DetachThingPrincipalOutput, error)

DetachThingPrincipalWithContext is the same as DetachThingPrincipal with the addition of the ability to pass a context and additional request options.

See DetachThingPrincipal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) DisableTopicRule added in v1.0.11

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

DisableTopicRule API operation for AWS IoT.

Disables the specified rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation DisableTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

Example
Output:

func (*IoT) DisableTopicRuleRequest added in v1.0.11

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

DisableTopicRuleRequest generates a "aws/request.Request" representing the client's request for the DisableTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DisableTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisableTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DisableTopicRuleRequest method.
req, resp := client.DisableTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) DisableTopicRuleWithContext added in v1.8.0

func (c *IoT) DisableTopicRuleWithContext(ctx aws.Context, input *DisableTopicRuleInput, opts ...request.Option) (*DisableTopicRuleOutput, error)

DisableTopicRuleWithContext is the same as DisableTopicRule with the addition of the ability to pass a context and additional request options.

See DisableTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) EnableTopicRule added in v1.0.11

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

EnableTopicRule API operation for AWS IoT.

Enables the specified rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation EnableTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

Example
Output:

func (*IoT) EnableTopicRuleRequest added in v1.0.11

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

EnableTopicRuleRequest generates a "aws/request.Request" representing the client's request for the EnableTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See EnableTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EnableTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the EnableTopicRuleRequest method.
req, resp := client.EnableTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) EnableTopicRuleWithContext added in v1.8.0

func (c *IoT) EnableTopicRuleWithContext(ctx aws.Context, input *EnableTopicRuleInput, opts ...request.Option) (*EnableTopicRuleOutput, error)

EnableTopicRuleWithContext is the same as EnableTopicRule with the addition of the ability to pass a context and additional request options.

See EnableTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) GetLoggingOptions

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

GetLoggingOptions API operation for AWS IoT.

Gets the logging options.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation GetLoggingOptions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

Example
Output:

func (*IoT) GetLoggingOptionsRequest

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

GetLoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the GetLoggingOptions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetLoggingOptions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetLoggingOptions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetLoggingOptionsRequest method.
req, resp := client.GetLoggingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) GetLoggingOptionsWithContext added in v1.8.0

func (c *IoT) GetLoggingOptionsWithContext(ctx aws.Context, input *GetLoggingOptionsInput, opts ...request.Option) (*GetLoggingOptionsOutput, error)

GetLoggingOptionsWithContext is the same as GetLoggingOptions with the addition of the ability to pass a context and additional request options.

See GetLoggingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) GetPolicy

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

GetPolicy API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation GetPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) GetPolicyRequest

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

GetPolicyRequest generates a "aws/request.Request" representing the client's request for the GetPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetPolicyRequest method.
req, resp := client.GetPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) GetPolicyVersion

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

GetPolicyVersion API operation for AWS IoT.

Gets information about the specified policy version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation GetPolicyVersion for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) GetPolicyVersionRequest

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

GetPolicyVersionRequest generates a "aws/request.Request" representing the client's request for the GetPolicyVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetPolicyVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetPolicyVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetPolicyVersionRequest method.
req, resp := client.GetPolicyVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) GetPolicyVersionWithContext added in v1.8.0

func (c *IoT) GetPolicyVersionWithContext(ctx aws.Context, input *GetPolicyVersionInput, opts ...request.Option) (*GetPolicyVersionOutput, error)

GetPolicyVersionWithContext is the same as GetPolicyVersion with the addition of the ability to pass a context and additional request options.

See GetPolicyVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) GetPolicyWithContext added in v1.8.0

func (c *IoT) GetPolicyWithContext(ctx aws.Context, input *GetPolicyInput, opts ...request.Option) (*GetPolicyOutput, error)

GetPolicyWithContext is the same as GetPolicy with the addition of the ability to pass a context and additional request options.

See GetPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) GetRegistrationCode added in v1.1.18

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

GetRegistrationCode API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation GetRegistrationCode for usage and error information.

Returned Error Codes:

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

Example
Output:

func (*IoT) GetRegistrationCodeRequest added in v1.1.18

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

GetRegistrationCodeRequest generates a "aws/request.Request" representing the client's request for the GetRegistrationCode operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetRegistrationCode for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRegistrationCode method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetRegistrationCodeRequest method.
req, resp := client.GetRegistrationCodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) GetRegistrationCodeWithContext added in v1.8.0

func (c *IoT) GetRegistrationCodeWithContext(ctx aws.Context, input *GetRegistrationCodeInput, opts ...request.Option) (*GetRegistrationCodeOutput, error)

GetRegistrationCodeWithContext is the same as GetRegistrationCode with the addition of the ability to pass a context and additional request options.

See GetRegistrationCode for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) GetTopicRule

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

GetTopicRule API operation for AWS IoT.

Gets information about the specified rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation GetTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

Example
Output:

func (*IoT) GetTopicRuleRequest

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

GetTopicRuleRequest generates a "aws/request.Request" representing the client's request for the GetTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetTopicRuleRequest method.
req, resp := client.GetTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) GetTopicRuleWithContext added in v1.8.0

func (c *IoT) GetTopicRuleWithContext(ctx aws.Context, input *GetTopicRuleInput, opts ...request.Option) (*GetTopicRuleOutput, error)

GetTopicRuleWithContext is the same as GetTopicRule with the addition of the ability to pass a context and additional request options.

See GetTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListCACertificates added in v1.1.18

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

ListCACertificates API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListCACertificates for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListCACertificatesRequest added in v1.1.18

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

ListCACertificatesRequest generates a "aws/request.Request" representing the client's request for the ListCACertificates operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListCACertificates for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListCACertificates method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListCACertificatesRequest method.
req, resp := client.ListCACertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListCACertificatesWithContext added in v1.8.0

func (c *IoT) ListCACertificatesWithContext(ctx aws.Context, input *ListCACertificatesInput, opts ...request.Option) (*ListCACertificatesOutput, error)

ListCACertificatesWithContext is the same as ListCACertificates with the addition of the ability to pass a context and additional request options.

See ListCACertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListCertificates

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

ListCertificates API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListCertificatesByCA added in v1.1.18

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

ListCertificatesByCA API operation for AWS IoT.

List the device certificates signed by the specified CA certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListCertificatesByCA for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListCertificatesByCARequest added in v1.1.18

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

ListCertificatesByCARequest generates a "aws/request.Request" representing the client's request for the ListCertificatesByCA operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListCertificatesByCA for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListCertificatesByCA method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListCertificatesByCARequest method.
req, resp := client.ListCertificatesByCARequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListCertificatesByCAWithContext added in v1.8.0

func (c *IoT) ListCertificatesByCAWithContext(ctx aws.Context, input *ListCertificatesByCAInput, opts ...request.Option) (*ListCertificatesByCAOutput, error)

ListCertificatesByCAWithContext is the same as ListCertificatesByCA with the addition of the ability to pass a context and additional request options.

See ListCertificatesByCA for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListCertificatesRequest

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

ListCertificatesRequest generates a "aws/request.Request" representing the client's request for the ListCertificates operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListCertificates for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListCertificates method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListCertificatesRequest method.
req, resp := client.ListCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListCertificatesWithContext added in v1.8.0

func (c *IoT) ListCertificatesWithContext(ctx aws.Context, input *ListCertificatesInput, opts ...request.Option) (*ListCertificatesOutput, error)

ListCertificatesWithContext is the same as ListCertificates with the addition of the ability to pass a context and additional request options.

See ListCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListOutgoingCertificates added in v1.3.0

func (c *IoT) ListOutgoingCertificates(input *ListOutgoingCertificatesInput) (*ListOutgoingCertificatesOutput, error)

ListOutgoingCertificates API operation for AWS IoT.

Lists certificates that are being transfered but not yet accepted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListOutgoingCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListOutgoingCertificatesRequest added in v1.3.0

func (c *IoT) ListOutgoingCertificatesRequest(input *ListOutgoingCertificatesInput) (req *request.Request, output *ListOutgoingCertificatesOutput)

ListOutgoingCertificatesRequest generates a "aws/request.Request" representing the client's request for the ListOutgoingCertificates operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListOutgoingCertificates for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListOutgoingCertificates method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListOutgoingCertificatesRequest method.
req, resp := client.ListOutgoingCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListOutgoingCertificatesWithContext added in v1.8.0

func (c *IoT) ListOutgoingCertificatesWithContext(ctx aws.Context, input *ListOutgoingCertificatesInput, opts ...request.Option) (*ListOutgoingCertificatesOutput, error)

ListOutgoingCertificatesWithContext is the same as ListOutgoingCertificates with the addition of the ability to pass a context and additional request options.

See ListOutgoingCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListPolicies

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

ListPolicies API operation for AWS IoT.

Lists your policies.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListPoliciesRequest

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

ListPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListPolicies operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPolicies for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPolicies method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListPoliciesRequest method.
req, resp := client.ListPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListPoliciesWithContext added in v1.8.0

func (c *IoT) ListPoliciesWithContext(ctx aws.Context, input *ListPoliciesInput, opts ...request.Option) (*ListPoliciesOutput, error)

ListPoliciesWithContext is the same as ListPolicies with the addition of the ability to pass a context and additional request options.

See ListPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListPolicyPrincipals added in v1.1.33

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

ListPolicyPrincipals API operation for AWS IoT.

Lists the principals associated with the specified policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListPolicyPrincipals for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListPolicyPrincipalsRequest added in v1.1.33

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

ListPolicyPrincipalsRequest generates a "aws/request.Request" representing the client's request for the ListPolicyPrincipals operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPolicyPrincipals for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPolicyPrincipals method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListPolicyPrincipalsRequest method.
req, resp := client.ListPolicyPrincipalsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListPolicyPrincipalsWithContext added in v1.8.0

func (c *IoT) ListPolicyPrincipalsWithContext(ctx aws.Context, input *ListPolicyPrincipalsInput, opts ...request.Option) (*ListPolicyPrincipalsOutput, error)

ListPolicyPrincipalsWithContext is the same as ListPolicyPrincipals with the addition of the ability to pass a context and additional request options.

See ListPolicyPrincipals for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListPolicyVersions

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

ListPolicyVersions API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListPolicyVersions for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListPolicyVersionsRequest

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

ListPolicyVersionsRequest generates a "aws/request.Request" representing the client's request for the ListPolicyVersions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPolicyVersions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPolicyVersions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListPolicyVersionsRequest method.
req, resp := client.ListPolicyVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListPolicyVersionsWithContext added in v1.8.0

func (c *IoT) ListPolicyVersionsWithContext(ctx aws.Context, input *ListPolicyVersionsInput, opts ...request.Option) (*ListPolicyVersionsOutput, error)

ListPolicyVersionsWithContext is the same as ListPolicyVersions with the addition of the ability to pass a context and additional request options.

See ListPolicyVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListPrincipalPolicies

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

ListPrincipalPolicies API operation for AWS IoT.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListPrincipalPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListPrincipalPoliciesRequest

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

ListPrincipalPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListPrincipalPolicies operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPrincipalPolicies for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPrincipalPolicies method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListPrincipalPoliciesRequest method.
req, resp := client.ListPrincipalPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListPrincipalPoliciesWithContext added in v1.8.0

func (c *IoT) ListPrincipalPoliciesWithContext(ctx aws.Context, input *ListPrincipalPoliciesInput, opts ...request.Option) (*ListPrincipalPoliciesOutput, error)

ListPrincipalPoliciesWithContext is the same as ListPrincipalPolicies with the addition of the ability to pass a context and additional request options.

See ListPrincipalPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListPrincipalThings

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

ListPrincipalThings API operation for AWS IoT.

Lists the things associated with the specified principal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListPrincipalThings for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) ListPrincipalThingsRequest

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

ListPrincipalThingsRequest generates a "aws/request.Request" representing the client's request for the ListPrincipalThings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPrincipalThings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPrincipalThings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListPrincipalThingsRequest method.
req, resp := client.ListPrincipalThingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListPrincipalThingsWithContext added in v1.8.0

func (c *IoT) ListPrincipalThingsWithContext(ctx aws.Context, input *ListPrincipalThingsInput, opts ...request.Option) (*ListPrincipalThingsOutput, error)

ListPrincipalThingsWithContext is the same as ListPrincipalThings with the addition of the ability to pass a context and additional request options.

See ListPrincipalThings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListThingPrincipals

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

ListThingPrincipals API operation for AWS IoT.

Lists the principals associated with the specified thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListThingPrincipals for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) ListThingPrincipalsRequest

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

ListThingPrincipalsRequest generates a "aws/request.Request" representing the client's request for the ListThingPrincipals operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListThingPrincipals for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListThingPrincipals method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListThingPrincipalsRequest method.
req, resp := client.ListThingPrincipalsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListThingPrincipalsWithContext added in v1.8.0

func (c *IoT) ListThingPrincipalsWithContext(ctx aws.Context, input *ListThingPrincipalsInput, opts ...request.Option) (*ListThingPrincipalsOutput, error)

ListThingPrincipalsWithContext is the same as ListThingPrincipals with the addition of the ability to pass a context and additional request options.

See ListThingPrincipals for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListThingTypes added in v1.2.8

func (c *IoT) ListThingTypes(input *ListThingTypesInput) (*ListThingTypesOutput, error)

ListThingTypes API operation for AWS IoT.

Lists the existing thing types.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListThingTypes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListThingTypesRequest added in v1.2.8

func (c *IoT) ListThingTypesRequest(input *ListThingTypesInput) (req *request.Request, output *ListThingTypesOutput)

ListThingTypesRequest generates a "aws/request.Request" representing the client's request for the ListThingTypes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListThingTypes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListThingTypes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListThingTypesRequest method.
req, resp := client.ListThingTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListThingTypesWithContext added in v1.8.0

func (c *IoT) ListThingTypesWithContext(ctx aws.Context, input *ListThingTypesInput, opts ...request.Option) (*ListThingTypesOutput, error)

ListThingTypesWithContext is the same as ListThingTypes with the addition of the ability to pass a context and additional request options.

See ListThingTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListThings

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

ListThings API operation for AWS IoT.

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListThings for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) ListThingsRequest

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

ListThingsRequest generates a "aws/request.Request" representing the client's request for the ListThings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListThings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListThings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListThingsRequest method.
req, resp := client.ListThingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListThingsWithContext added in v1.8.0

func (c *IoT) ListThingsWithContext(ctx aws.Context, input *ListThingsInput, opts ...request.Option) (*ListThingsOutput, error)

ListThingsWithContext is the same as ListThings with the addition of the ability to pass a context and additional request options.

See ListThings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ListTopicRules

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

ListTopicRules API operation for AWS IoT.

Lists the rules for the specific topic.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ListTopicRules for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

Example
Output:

func (*IoT) ListTopicRulesRequest

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

ListTopicRulesRequest generates a "aws/request.Request" representing the client's request for the ListTopicRules operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListTopicRules for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTopicRules method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListTopicRulesRequest method.
req, resp := client.ListTopicRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListTopicRulesWithContext added in v1.8.0

func (c *IoT) ListTopicRulesWithContext(ctx aws.Context, input *ListTopicRulesInput, opts ...request.Option) (*ListTopicRulesOutput, error)

ListTopicRulesWithContext is the same as ListTopicRules with the addition of the ability to pass a context and additional request options.

See ListTopicRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) RegisterCACertificate added in v1.1.18

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

RegisterCACertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation RegisterCACertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeRegistrationCodeValidationException "RegistrationCodeValidationException" The registration code is invalid.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeLimitExceededException "LimitExceededException" The number of attached entities exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) RegisterCACertificateRequest added in v1.1.18

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

RegisterCACertificateRequest generates a "aws/request.Request" representing the client's request for the RegisterCACertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RegisterCACertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RegisterCACertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the RegisterCACertificateRequest method.
req, resp := client.RegisterCACertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) RegisterCACertificateWithContext added in v1.8.0

func (c *IoT) RegisterCACertificateWithContext(ctx aws.Context, input *RegisterCACertificateInput, opts ...request.Option) (*RegisterCACertificateOutput, error)

RegisterCACertificateWithContext is the same as RegisterCACertificate with the addition of the ability to pass a context and additional request options.

See RegisterCACertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) RegisterCertificate added in v1.1.18

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

RegisterCertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation RegisterCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

  • ErrCodeCertificateStateException "CertificateStateException" The certificate operation is not allowed.

  • ErrCodeCertificateConflictException "CertificateConflictException" Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) RegisterCertificateRequest added in v1.1.18

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

RegisterCertificateRequest generates a "aws/request.Request" representing the client's request for the RegisterCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RegisterCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RegisterCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the RegisterCertificateRequest method.
req, resp := client.RegisterCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) RegisterCertificateWithContext added in v1.8.0

func (c *IoT) RegisterCertificateWithContext(ctx aws.Context, input *RegisterCertificateInput, opts ...request.Option) (*RegisterCertificateOutput, error)

RegisterCertificateWithContext is the same as RegisterCertificate with the addition of the ability to pass a context and additional request options.

See RegisterCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) RejectCertificateTransfer

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

RejectCertificateTransfer API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation RejectCertificateTransfer for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeTransferAlreadyCompletedException "TransferAlreadyCompletedException" You can't revert the certificate transfer because the transfer is already complete.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) RejectCertificateTransferRequest

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

RejectCertificateTransferRequest generates a "aws/request.Request" representing the client's request for the RejectCertificateTransfer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RejectCertificateTransfer for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RejectCertificateTransfer method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the RejectCertificateTransferRequest method.
req, resp := client.RejectCertificateTransferRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) RejectCertificateTransferWithContext added in v1.8.0

func (c *IoT) RejectCertificateTransferWithContext(ctx aws.Context, input *RejectCertificateTransferInput, opts ...request.Option) (*RejectCertificateTransferOutput, error)

RejectCertificateTransferWithContext is the same as RejectCertificateTransfer with the addition of the ability to pass a context and additional request options.

See RejectCertificateTransfer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) ReplaceTopicRule

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

ReplaceTopicRule API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation ReplaceTopicRule for usage and error information.

Returned Error Codes:

  • ErrCodeSqlParseException "SqlParseException" The Rule-SQL expression can't be parsed correctly.

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

Example
Output:

func (*IoT) ReplaceTopicRuleRequest

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

ReplaceTopicRuleRequest generates a "aws/request.Request" representing the client's request for the ReplaceTopicRule operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ReplaceTopicRule for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ReplaceTopicRule method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ReplaceTopicRuleRequest method.
req, resp := client.ReplaceTopicRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ReplaceTopicRuleWithContext added in v1.8.0

func (c *IoT) ReplaceTopicRuleWithContext(ctx aws.Context, input *ReplaceTopicRuleInput, opts ...request.Option) (*ReplaceTopicRuleOutput, error)

ReplaceTopicRuleWithContext is the same as ReplaceTopicRule with the addition of the ability to pass a context and additional request options.

See ReplaceTopicRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) SetDefaultPolicyVersion

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

SetDefaultPolicyVersion API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation SetDefaultPolicyVersion for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) SetDefaultPolicyVersionRequest

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

SetDefaultPolicyVersionRequest generates a "aws/request.Request" representing the client's request for the SetDefaultPolicyVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetDefaultPolicyVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetDefaultPolicyVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SetDefaultPolicyVersionRequest method.
req, resp := client.SetDefaultPolicyVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) SetDefaultPolicyVersionWithContext added in v1.8.0

func (c *IoT) SetDefaultPolicyVersionWithContext(ctx aws.Context, input *SetDefaultPolicyVersionInput, opts ...request.Option) (*SetDefaultPolicyVersionOutput, error)

SetDefaultPolicyVersionWithContext is the same as SetDefaultPolicyVersion with the addition of the ability to pass a context and additional request options.

See SetDefaultPolicyVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) SetLoggingOptions

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

SetLoggingOptions API operation for AWS IoT.

Sets the logging options.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation SetLoggingOptions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

Example
Output:

func (*IoT) SetLoggingOptionsRequest

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

SetLoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the SetLoggingOptions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetLoggingOptions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetLoggingOptions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SetLoggingOptionsRequest method.
req, resp := client.SetLoggingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) SetLoggingOptionsWithContext added in v1.8.0

func (c *IoT) SetLoggingOptionsWithContext(ctx aws.Context, input *SetLoggingOptionsInput, opts ...request.Option) (*SetLoggingOptionsOutput, error)

SetLoggingOptionsWithContext is the same as SetLoggingOptions with the addition of the ability to pass a context and additional request options.

See SetLoggingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) TransferCertificate

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

TransferCertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation TransferCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeCertificateStateException "CertificateStateException" The certificate operation is not allowed.

  • ErrCodeTransferConflictException "TransferConflictException" You can't transfer the certificate because authorization policies are still attached.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) TransferCertificateRequest

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

TransferCertificateRequest generates a "aws/request.Request" representing the client's request for the TransferCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See TransferCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TransferCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the TransferCertificateRequest method.
req, resp := client.TransferCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) TransferCertificateWithContext added in v1.8.0

func (c *IoT) TransferCertificateWithContext(ctx aws.Context, input *TransferCertificateInput, opts ...request.Option) (*TransferCertificateOutput, error)

TransferCertificateWithContext is the same as TransferCertificate with the addition of the ability to pass a context and additional request options.

See TransferCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) UpdateCACertificate added in v1.1.18

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

UpdateCACertificate API operation for AWS IoT.

Updates a registered CA certificate.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation UpdateCACertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) UpdateCACertificateRequest added in v1.1.18

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

UpdateCACertificateRequest generates a "aws/request.Request" representing the client's request for the UpdateCACertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateCACertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateCACertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateCACertificateRequest method.
req, resp := client.UpdateCACertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateCACertificateWithContext added in v1.8.0

func (c *IoT) UpdateCACertificateWithContext(ctx aws.Context, input *UpdateCACertificateInput, opts ...request.Option) (*UpdateCACertificateOutput, error)

UpdateCACertificateWithContext is the same as UpdateCACertificate with the addition of the ability to pass a context and additional request options.

See UpdateCACertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) UpdateCertificate

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

UpdateCertificate API operation for AWS IoT.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation UpdateCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeCertificateStateException "CertificateStateException" The certificate operation is not allowed.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

Example
Output:

func (*IoT) UpdateCertificateRequest

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

UpdateCertificateRequest generates a "aws/request.Request" representing the client's request for the UpdateCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateCertificate for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateCertificate method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateCertificateRequest method.
req, resp := client.UpdateCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateCertificateWithContext added in v1.8.0

func (c *IoT) UpdateCertificateWithContext(ctx aws.Context, input *UpdateCertificateInput, opts ...request.Option) (*UpdateCertificateOutput, error)

UpdateCertificateWithContext is the same as UpdateCertificate with the addition of the ability to pass a context and additional request options.

See UpdateCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoT) UpdateThing

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

UpdateThing API operation for AWS IoT.

Updates the data for a thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT's API operation UpdateThing for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeVersionConflictException "VersionConflictException" An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeUnauthorizedException "UnauthorizedException" You are not authorized to perform this operation.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

Example
Output:

func (*IoT) UpdateThingRequest

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

UpdateThingRequest generates a "aws/request.Request" representing the client's request for the UpdateThing operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateThing for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateThing method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateThingRequest method.
req, resp := client.UpdateThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateThingWithContext added in v1.8.0

func (c *IoT) UpdateThingWithContext(ctx aws.Context, input *UpdateThingInput, opts ...request.Option) (*UpdateThingOutput, error)

UpdateThingWithContext is the same as UpdateThing with the addition of the ability to pass a context and additional request options.

See UpdateThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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) SetPrivateKey added in v1.5.0

func (s *KeyPair) SetPrivateKey(v string) *KeyPair

SetPrivateKey sets the PrivateKey field's value.

func (*KeyPair) SetPublicKey added in v1.5.0

func (s *KeyPair) SetPublicKey(v string) *KeyPair

SetPublicKey sets the PublicKey field's value.

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 is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the Amazon Kinesis stream.
	//
	// StreamName is a required field
	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) SetPartitionKey added in v1.5.0

func (s *KinesisAction) SetPartitionKey(v string) *KinesisAction

SetPartitionKey sets the PartitionKey field's value.

func (*KinesisAction) SetRoleArn added in v1.5.0

func (s *KinesisAction) SetRoleArn(v string) *KinesisAction

SetRoleArn sets the RoleArn field's value.

func (*KinesisAction) SetStreamName added in v1.5.0

func (s *KinesisAction) SetStreamName(v string) *KinesisAction

SetStreamName sets the StreamName field's value.

func (KinesisAction) String

func (s KinesisAction) String() string

String returns the string representation

func (*KinesisAction) Validate added in v1.1.21

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 is a required field
	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) SetFunctionArn added in v1.5.0

func (s *LambdaAction) SetFunctionArn(v string) *LambdaAction

SetFunctionArn sets the FunctionArn field's value.

func (LambdaAction) String

func (s LambdaAction) String() string

String returns the string representation

func (*LambdaAction) Validate added in v1.1.21

func (s *LambdaAction) Validate() error

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

type ListCACertificatesInput added in v1.1.18

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 added in v1.1.18

func (s ListCACertificatesInput) GoString() string

GoString returns the string representation

func (*ListCACertificatesInput) SetAscendingOrder added in v1.5.0

func (s *ListCACertificatesInput) SetAscendingOrder(v bool) *ListCACertificatesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListCACertificatesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListCACertificatesInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (ListCACertificatesInput) String added in v1.1.18

func (s ListCACertificatesInput) String() string

String returns the string representation

func (*ListCACertificatesInput) Validate added in v1.1.21

func (s *ListCACertificatesInput) Validate() error

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

type ListCACertificatesOutput added in v1.1.18

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 added in v1.1.18

func (s ListCACertificatesOutput) GoString() string

GoString returns the string representation

func (*ListCACertificatesOutput) SetCertificates added in v1.5.0

SetCertificates sets the Certificates field's value.

func (*ListCACertificatesOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (ListCACertificatesOutput) String added in v1.1.18

func (s ListCACertificatesOutput) String() string

String returns the string representation

type ListCertificatesByCAInput added in v1.1.18

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 is a required field
	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 added in v1.1.18

func (s ListCertificatesByCAInput) GoString() string

GoString returns the string representation

func (*ListCertificatesByCAInput) SetAscendingOrder added in v1.5.0

func (s *ListCertificatesByCAInput) SetAscendingOrder(v bool) *ListCertificatesByCAInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListCertificatesByCAInput) SetCaCertificateId added in v1.5.0

SetCaCertificateId sets the CaCertificateId field's value.

func (*ListCertificatesByCAInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListCertificatesByCAInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (ListCertificatesByCAInput) String added in v1.1.18

func (s ListCertificatesByCAInput) String() string

String returns the string representation

func (*ListCertificatesByCAInput) Validate added in v1.1.21

func (s *ListCertificatesByCAInput) Validate() error

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

type ListCertificatesByCAOutput added in v1.1.18

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 added in v1.1.18

func (s ListCertificatesByCAOutput) GoString() string

GoString returns the string representation

func (*ListCertificatesByCAOutput) SetCertificates added in v1.5.0

SetCertificates sets the Certificates field's value.

func (*ListCertificatesByCAOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (ListCertificatesByCAOutput) String added in v1.1.18

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) SetAscendingOrder added in v1.5.0

func (s *ListCertificatesInput) SetAscendingOrder(v bool) *ListCertificatesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListCertificatesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListCertificatesInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (ListCertificatesInput) String

func (s ListCertificatesInput) String() string

String returns the string representation

func (*ListCertificatesInput) Validate added in v1.1.21

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) SetCertificates added in v1.5.0

func (s *ListCertificatesOutput) SetCertificates(v []*Certificate) *ListCertificatesOutput

SetCertificates sets the Certificates field's value.

func (*ListCertificatesOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (ListCertificatesOutput) String

func (s ListCertificatesOutput) String() string

String returns the string representation

type ListOutgoingCertificatesInput added in v1.3.0

type ListOutgoingCertificatesInput 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 to the ListOutgoingCertificates operation.

func (ListOutgoingCertificatesInput) GoString added in v1.3.0

GoString returns the string representation

func (*ListOutgoingCertificatesInput) SetAscendingOrder added in v1.5.0

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListOutgoingCertificatesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListOutgoingCertificatesInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (ListOutgoingCertificatesInput) String added in v1.3.0

String returns the string representation

func (*ListOutgoingCertificatesInput) Validate added in v1.3.0

func (s *ListOutgoingCertificatesInput) Validate() error

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

type ListOutgoingCertificatesOutput added in v1.3.0

type ListOutgoingCertificatesOutput struct {

	// The marker for the next set of results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The certificates that are being transfered but not yet accepted.
	OutgoingCertificates []*OutgoingCertificate `locationName:"outgoingCertificates" type:"list"`
	// contains filtered or unexported fields
}

The output from the ListOutgoingCertificates operation.

func (ListOutgoingCertificatesOutput) GoString added in v1.3.0

GoString returns the string representation

func (*ListOutgoingCertificatesOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (*ListOutgoingCertificatesOutput) SetOutgoingCertificates added in v1.5.0

SetOutgoingCertificates sets the OutgoingCertificates field's value.

func (ListOutgoingCertificatesOutput) String added in v1.3.0

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) SetAscendingOrder added in v1.5.0

func (s *ListPoliciesInput) SetAscendingOrder(v bool) *ListPoliciesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListPoliciesInput) SetMarker added in v1.5.0

func (s *ListPoliciesInput) SetMarker(v string) *ListPoliciesInput

SetMarker sets the Marker field's value.

func (*ListPoliciesInput) SetPageSize added in v1.5.0

func (s *ListPoliciesInput) SetPageSize(v int64) *ListPoliciesInput

SetPageSize sets the PageSize field's value.

func (ListPoliciesInput) String

func (s ListPoliciesInput) String() string

String returns the string representation

func (*ListPoliciesInput) Validate added in v1.1.21

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) SetNextMarker added in v1.5.0

func (s *ListPoliciesOutput) SetNextMarker(v string) *ListPoliciesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListPoliciesOutput) SetPolicies added in v1.5.0

func (s *ListPoliciesOutput) SetPolicies(v []*Policy) *ListPoliciesOutput

SetPolicies sets the Policies field's value.

func (ListPoliciesOutput) String

func (s ListPoliciesOutput) String() string

String returns the string representation

type ListPolicyPrincipalsInput added in v1.1.33

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 is a required field
	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 added in v1.1.33

func (s ListPolicyPrincipalsInput) GoString() string

GoString returns the string representation

func (*ListPolicyPrincipalsInput) SetAscendingOrder added in v1.5.0

func (s *ListPolicyPrincipalsInput) SetAscendingOrder(v bool) *ListPolicyPrincipalsInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListPolicyPrincipalsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListPolicyPrincipalsInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (*ListPolicyPrincipalsInput) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (ListPolicyPrincipalsInput) String added in v1.1.33

func (s ListPolicyPrincipalsInput) String() string

String returns the string representation

func (*ListPolicyPrincipalsInput) Validate added in v1.1.33

func (s *ListPolicyPrincipalsInput) Validate() error

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

type ListPolicyPrincipalsOutput added in v1.1.33

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 added in v1.1.33

func (s ListPolicyPrincipalsOutput) GoString() string

GoString returns the string representation

func (*ListPolicyPrincipalsOutput) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (*ListPolicyPrincipalsOutput) SetPrincipals added in v1.5.0

SetPrincipals sets the Principals field's value.

func (ListPolicyPrincipalsOutput) String added in v1.1.33

String returns the string representation

type ListPolicyVersionsInput

type ListPolicyVersionsInput struct {

	// The policy name.
	//
	// PolicyName is a required field
	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) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (ListPolicyVersionsInput) String

func (s ListPolicyVersionsInput) String() string

String returns the string representation

func (*ListPolicyVersionsInput) Validate added in v1.1.21

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) SetPolicyVersions added in v1.5.0

SetPolicyVersions sets the PolicyVersions field's value.

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 is a required field
	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) SetAscendingOrder added in v1.5.0

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListPrincipalPoliciesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*ListPrincipalPoliciesInput) SetPageSize added in v1.5.0

SetPageSize sets the PageSize field's value.

func (*ListPrincipalPoliciesInput) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (ListPrincipalPoliciesInput) String

String returns the string representation

func (*ListPrincipalPoliciesInput) Validate added in v1.1.21

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) SetNextMarker added in v1.5.0

SetNextMarker sets the NextMarker field's value.

func (*ListPrincipalPoliciesOutput) SetPolicies added in v1.5.0

SetPolicies sets the Policies field's value.

func (ListPrincipalPoliciesOutput) String

String returns the string representation

type ListPrincipalThingsInput

type ListPrincipalThingsInput struct {

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

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The principal.
	//
	// Principal is a required field
	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) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*ListPrincipalThingsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*ListPrincipalThingsInput) SetPrincipal added in v1.5.0

SetPrincipal sets the Principal field's value.

func (ListPrincipalThingsInput) String

func (s ListPrincipalThingsInput) String() string

String returns the string representation

func (*ListPrincipalThingsInput) Validate added in v1.1.21

func (s *ListPrincipalThingsInput) Validate() error

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

type ListPrincipalThingsOutput

type ListPrincipalThingsOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	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) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*ListPrincipalThingsOutput) SetThings added in v1.5.0

SetThings sets the Things field's value.

func (ListPrincipalThingsOutput) String

func (s ListPrincipalThingsOutput) String() string

String returns the string representation

type ListThingPrincipalsInput

type ListThingPrincipalsInput struct {

	// The name of the thing.
	//
	// ThingName is a required field
	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) SetThingName added in v1.5.0

SetThingName sets the ThingName field's value.

func (ListThingPrincipalsInput) String

func (s ListThingPrincipalsInput) String() string

String returns the string representation

func (*ListThingPrincipalsInput) Validate added in v1.1.21

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 associated with the thing.
	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) SetPrincipals added in v1.5.0

SetPrincipals sets the Principals field's value.

func (ListThingPrincipalsOutput) String

func (s ListThingPrincipalsOutput) String() string

String returns the string representation

type ListThingTypesInput added in v1.2.8

type ListThingTypesInput struct {

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

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The name of the thing type.
	ThingTypeName *string `location:"querystring" locationName:"thingTypeName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the ListThingTypes operation.

func (ListThingTypesInput) GoString added in v1.2.8

func (s ListThingTypesInput) GoString() string

GoString returns the string representation

func (*ListThingTypesInput) SetMaxResults added in v1.5.0

func (s *ListThingTypesInput) SetMaxResults(v int64) *ListThingTypesInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingTypesInput) SetNextToken added in v1.5.0

func (s *ListThingTypesInput) SetNextToken(v string) *ListThingTypesInput

SetNextToken sets the NextToken field's value.

func (*ListThingTypesInput) SetThingTypeName added in v1.5.0

func (s *ListThingTypesInput) SetThingTypeName(v string) *ListThingTypesInput

SetThingTypeName sets the ThingTypeName field's value.

func (ListThingTypesInput) String added in v1.2.8

func (s ListThingTypesInput) String() string

String returns the string representation

func (*ListThingTypesInput) Validate added in v1.2.8

func (s *ListThingTypesInput) Validate() error

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

type ListThingTypesOutput added in v1.2.8

type ListThingTypesOutput struct {

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

	// The thing types.
	ThingTypes []*ThingTypeDefinition `locationName:"thingTypes" type:"list"`
	// contains filtered or unexported fields
}

The output for the ListThingTypes operation.

func (ListThingTypesOutput) GoString added in v1.2.8

func (s ListThingTypesOutput) GoString() string

GoString returns the string representation

func (*ListThingTypesOutput) SetNextToken added in v1.5.0

func (s *ListThingTypesOutput) SetNextToken(v string) *ListThingTypesOutput

SetNextToken sets the NextToken field's value.

func (*ListThingTypesOutput) SetThingTypes added in v1.5.0

SetThingTypes sets the ThingTypes field's value.

func (ListThingTypesOutput) String added in v1.2.8

func (s ListThingTypesOutput) String() string

String returns the string representation

type ListThingsInput

type ListThingsInput struct {

	// The attribute name used to search for things.
	AttributeName *string `location:"querystring" locationName:"attributeName" type:"string"`

	// The attribute value used to search for things.
	AttributeValue *string `location:"querystring" locationName:"attributeValue" type:"string"`

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

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The name of the thing type used to search for things.
	ThingTypeName *string `location:"querystring" locationName:"thingTypeName" min:"1" 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) SetAttributeName added in v1.5.0

func (s *ListThingsInput) SetAttributeName(v string) *ListThingsInput

SetAttributeName sets the AttributeName field's value.

func (*ListThingsInput) SetAttributeValue added in v1.5.0

func (s *ListThingsInput) SetAttributeValue(v string) *ListThingsInput

SetAttributeValue sets the AttributeValue field's value.

func (*ListThingsInput) SetMaxResults added in v1.5.0

func (s *ListThingsInput) SetMaxResults(v int64) *ListThingsInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingsInput) SetNextToken added in v1.5.0

func (s *ListThingsInput) SetNextToken(v string) *ListThingsInput

SetNextToken sets the NextToken field's value.

func (*ListThingsInput) SetThingTypeName added in v1.5.0

func (s *ListThingsInput) SetThingTypeName(v string) *ListThingsInput

SetThingTypeName sets the ThingTypeName field's value.

func (ListThingsInput) String

func (s ListThingsInput) String() string

String returns the string representation

func (*ListThingsInput) Validate added in v1.1.21

func (s *ListThingsInput) Validate() error

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

type ListThingsOutput

type ListThingsOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	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) SetNextToken added in v1.5.0

func (s *ListThingsOutput) SetNextToken(v string) *ListThingsOutput

SetNextToken sets the NextToken field's value.

func (*ListThingsOutput) SetThings added in v1.5.0

func (s *ListThingsOutput) SetThings(v []*ThingAttribute) *ListThingsOutput

SetThings sets the Things field's value.

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) SetMaxResults added in v1.5.0

func (s *ListTopicRulesInput) SetMaxResults(v int64) *ListTopicRulesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTopicRulesInput) SetNextToken added in v1.5.0

func (s *ListTopicRulesInput) SetNextToken(v string) *ListTopicRulesInput

SetNextToken sets the NextToken field's value.

func (*ListTopicRulesInput) SetRuleDisabled added in v1.5.0

func (s *ListTopicRulesInput) SetRuleDisabled(v bool) *ListTopicRulesInput

SetRuleDisabled sets the RuleDisabled field's value.

func (*ListTopicRulesInput) SetTopic added in v1.5.0

SetTopic sets the Topic field's value.

func (ListTopicRulesInput) String

func (s ListTopicRulesInput) String() string

String returns the string representation

func (*ListTopicRulesInput) Validate added in v1.1.21

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) SetNextToken added in v1.5.0

func (s *ListTopicRulesOutput) SetNextToken(v string) *ListTopicRulesOutput

SetNextToken sets the NextToken field's value.

func (*ListTopicRulesOutput) SetRules added in v1.5.0

SetRules sets the Rules field's value.

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 is a required field
	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) SetLogLevel added in v1.5.0

SetLogLevel sets the LogLevel field's value.

func (*LoggingOptionsPayload) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (LoggingOptionsPayload) String

func (s LoggingOptionsPayload) String() string

String returns the string representation

func (*LoggingOptionsPayload) Validate added in v1.1.21

func (s *LoggingOptionsPayload) Validate() error

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

type OutgoingCertificate added in v1.3.0

type OutgoingCertificate struct {

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

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

	// The certificate creation date.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

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

	// The transfer message.
	TransferMessage *string `locationName:"transferMessage" type:"string"`

	// The AWS account to which the transfer was made.
	TransferredTo *string `locationName:"transferredTo" type:"string"`
	// contains filtered or unexported fields
}

A certificate that has been transfered but not yet accepted.

func (OutgoingCertificate) GoString added in v1.3.0

func (s OutgoingCertificate) GoString() string

GoString returns the string representation

func (*OutgoingCertificate) SetCertificateArn added in v1.5.0

func (s *OutgoingCertificate) SetCertificateArn(v string) *OutgoingCertificate

SetCertificateArn sets the CertificateArn field's value.

func (*OutgoingCertificate) SetCertificateId added in v1.5.0

func (s *OutgoingCertificate) SetCertificateId(v string) *OutgoingCertificate

SetCertificateId sets the CertificateId field's value.

func (*OutgoingCertificate) SetCreationDate added in v1.5.0

func (s *OutgoingCertificate) SetCreationDate(v time.Time) *OutgoingCertificate

SetCreationDate sets the CreationDate field's value.

func (*OutgoingCertificate) SetTransferDate added in v1.5.0

func (s *OutgoingCertificate) SetTransferDate(v time.Time) *OutgoingCertificate

SetTransferDate sets the TransferDate field's value.

func (*OutgoingCertificate) SetTransferMessage added in v1.5.0

func (s *OutgoingCertificate) SetTransferMessage(v string) *OutgoingCertificate

SetTransferMessage sets the TransferMessage field's value.

func (*OutgoingCertificate) SetTransferredTo added in v1.5.0

func (s *OutgoingCertificate) SetTransferredTo(v string) *OutgoingCertificate

SetTransferredTo sets the TransferredTo field's value.

func (OutgoingCertificate) String added in v1.3.0

func (s OutgoingCertificate) String() string

String returns the string representation

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) SetPolicyArn added in v1.5.0

func (s *Policy) SetPolicyArn(v string) *Policy

SetPolicyArn sets the PolicyArn field's value.

func (*Policy) SetPolicyName added in v1.5.0

func (s *Policy) SetPolicyName(v string) *Policy

SetPolicyName sets the PolicyName field's value.

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) SetCreateDate added in v1.5.0

func (s *PolicyVersion) SetCreateDate(v time.Time) *PolicyVersion

SetCreateDate sets the CreateDate field's value.

func (*PolicyVersion) SetIsDefaultVersion added in v1.5.0

func (s *PolicyVersion) SetIsDefaultVersion(v bool) *PolicyVersion

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*PolicyVersion) SetVersionId added in v1.5.0

func (s *PolicyVersion) SetVersionId(v string) *PolicyVersion

SetVersionId sets the VersionId field's value.

func (PolicyVersion) String

func (s PolicyVersion) String() string

String returns the string representation

type PutItemInput added in v1.4.19

type PutItemInput struct {

	// The table where the message data will be written
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

func (PutItemInput) GoString added in v1.4.19

func (s PutItemInput) GoString() string

GoString returns the string representation

func (*PutItemInput) SetTableName added in v1.5.0

func (s *PutItemInput) SetTableName(v string) *PutItemInput

SetTableName sets the TableName field's value.

func (PutItemInput) String added in v1.4.19

func (s PutItemInput) String() string

String returns the string representation

func (*PutItemInput) Validate added in v1.4.19

func (s *PutItemInput) Validate() error

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

type RegisterCACertificateInput added in v1.1.18

type RegisterCACertificateInput struct {

	// Allows this CA certificate to be used for auto registration of device certificates.
	AllowAutoRegistration *bool `location:"querystring" locationName:"allowAutoRegistration" type:"boolean"`

	// The CA certificate.
	//
	// CaCertificate is a required field
	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 is a required field
	VerificationCertificate *string `locationName:"verificationCertificate" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input to the RegisterCACertificate operation.

func (RegisterCACertificateInput) GoString added in v1.1.18

func (s RegisterCACertificateInput) GoString() string

GoString returns the string representation

func (*RegisterCACertificateInput) SetAllowAutoRegistration added in v1.5.0

func (s *RegisterCACertificateInput) SetAllowAutoRegistration(v bool) *RegisterCACertificateInput

SetAllowAutoRegistration sets the AllowAutoRegistration field's value.

func (*RegisterCACertificateInput) SetCaCertificate added in v1.5.0

SetCaCertificate sets the CaCertificate field's value.

func (*RegisterCACertificateInput) SetSetAsActive added in v1.5.0

SetSetAsActive sets the SetAsActive field's value.

func (*RegisterCACertificateInput) SetVerificationCertificate added in v1.5.0

func (s *RegisterCACertificateInput) SetVerificationCertificate(v string) *RegisterCACertificateInput

SetVerificationCertificate sets the VerificationCertificate field's value.

func (RegisterCACertificateInput) String added in v1.1.18

String returns the string representation

func (*RegisterCACertificateInput) Validate added in v1.1.21

func (s *RegisterCACertificateInput) Validate() error

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

type RegisterCACertificateOutput added in v1.1.18

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 added in v1.1.18

func (s RegisterCACertificateOutput) GoString() string

GoString returns the string representation

func (*RegisterCACertificateOutput) SetCertificateArn added in v1.5.0

SetCertificateArn sets the CertificateArn field's value.

func (*RegisterCACertificateOutput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (RegisterCACertificateOutput) String added in v1.1.18

String returns the string representation

type RegisterCertificateInput added in v1.1.18

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 is a required field
	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" deprecated:"true" type:"boolean"`

	Status *string `locationName:"status" type:"string" enum:"CertificateStatus"`
	// contains filtered or unexported fields
}

The input to the RegisterCertificate operation.

func (RegisterCertificateInput) GoString added in v1.1.18

func (s RegisterCertificateInput) GoString() string

GoString returns the string representation

func (*RegisterCertificateInput) SetCaCertificatePem added in v1.5.0

func (s *RegisterCertificateInput) SetCaCertificatePem(v string) *RegisterCertificateInput

SetCaCertificatePem sets the CaCertificatePem field's value.

func (*RegisterCertificateInput) SetCertificatePem added in v1.5.0

func (s *RegisterCertificateInput) SetCertificatePem(v string) *RegisterCertificateInput

SetCertificatePem sets the CertificatePem field's value.

func (*RegisterCertificateInput) SetSetAsActive added in v1.5.0

SetSetAsActive sets the SetAsActive field's value.

func (*RegisterCertificateInput) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (RegisterCertificateInput) String added in v1.1.18

func (s RegisterCertificateInput) String() string

String returns the string representation

func (*RegisterCertificateInput) Validate added in v1.1.21

func (s *RegisterCertificateInput) Validate() error

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

type RegisterCertificateOutput added in v1.1.18

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 added in v1.1.18

func (s RegisterCertificateOutput) GoString() string

GoString returns the string representation

func (*RegisterCertificateOutput) SetCertificateArn added in v1.5.0

SetCertificateArn sets the CertificateArn field's value.

func (*RegisterCertificateOutput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (RegisterCertificateOutput) String added in v1.1.18

func (s RegisterCertificateOutput) String() string

String returns the string representation

type RejectCertificateTransferInput

type RejectCertificateTransferInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*RejectCertificateTransferInput) SetRejectReason added in v1.5.0

SetRejectReason sets the RejectReason field's value.

func (RejectCertificateTransferInput) String

String returns the string representation

func (*RejectCertificateTransferInput) Validate added in v1.1.21

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 is a required field
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`

	// The rule payload.
	//
	// TopicRulePayload is a required field
	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) SetRuleName added in v1.5.0

SetRuleName sets the RuleName field's value.

func (*ReplaceTopicRuleInput) SetTopicRulePayload added in v1.5.0

func (s *ReplaceTopicRuleInput) SetTopicRulePayload(v *TopicRulePayload) *ReplaceTopicRuleInput

SetTopicRulePayload sets the TopicRulePayload field's value.

func (ReplaceTopicRuleInput) String

func (s ReplaceTopicRuleInput) String() string

String returns the string representation

func (*ReplaceTopicRuleInput) Validate added in v1.1.21

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 is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the MQTT topic.
	//
	// Topic is a required field
	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) SetRoleArn added in v1.5.0

func (s *RepublishAction) SetRoleArn(v string) *RepublishAction

SetRoleArn sets the RoleArn field's value.

func (*RepublishAction) SetTopic added in v1.5.0

func (s *RepublishAction) SetTopic(v string) *RepublishAction

SetTopic sets the Topic field's value.

func (RepublishAction) String

func (s RepublishAction) String() string

String returns the string representation

func (*RepublishAction) Validate added in v1.1.21

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 is a required field
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The Amazon S3 canned ACL that controls access to the object identified by
	// the object key. For more information, see S3 canned ACLs (http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl).
	CannedAcl *string `locationName:"cannedAcl" type:"string" enum:"CannedAccessControlList"`

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

	// The ARN of the IAM role that grants access.
	//
	// RoleArn is a required field
	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) SetBucketName added in v1.5.0

func (s *S3Action) SetBucketName(v string) *S3Action

SetBucketName sets the BucketName field's value.

func (*S3Action) SetCannedAcl added in v1.5.0

func (s *S3Action) SetCannedAcl(v string) *S3Action

SetCannedAcl sets the CannedAcl field's value.

func (*S3Action) SetKey added in v1.5.0

func (s *S3Action) SetKey(v string) *S3Action

SetKey sets the Key field's value.

func (*S3Action) SetRoleArn added in v1.5.0

func (s *S3Action) SetRoleArn(v string) *S3Action

SetRoleArn sets the RoleArn field's value.

func (S3Action) String

func (s S3Action) String() string

String returns the string representation

func (*S3Action) Validate added in v1.1.21

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 is a required field
	PolicyName *string `location:"uri" locationName:"policyName" min:"1" type:"string" required:"true"`

	// The policy version ID.
	//
	// PolicyVersionId is a required field
	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) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*SetDefaultPolicyVersionInput) SetPolicyVersionId added in v1.5.0

SetPolicyVersionId sets the PolicyVersionId field's value.

func (SetDefaultPolicyVersionInput) String

String returns the string representation

func (*SetDefaultPolicyVersionInput) Validate added in v1.1.21

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 is a required field
	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) SetLoggingOptionsPayload added in v1.5.0

func (s *SetLoggingOptionsInput) SetLoggingOptionsPayload(v *LoggingOptionsPayload) *SetLoggingOptionsInput

SetLoggingOptionsPayload sets the LoggingOptionsPayload field's value.

func (SetLoggingOptionsInput) String

func (s SetLoggingOptionsInput) String() string

String returns the string representation

func (*SetLoggingOptionsInput) Validate added in v1.1.21

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. (http://docs.aws.amazon.com/sns/latest/dg/json-formats.html)
	MessageFormat *string `locationName:"messageFormat" type:"string" enum:"MessageFormat"`

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

	// The ARN of the SNS topic.
	//
	// TargetArn is a required field
	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) SetMessageFormat added in v1.5.0

func (s *SnsAction) SetMessageFormat(v string) *SnsAction

SetMessageFormat sets the MessageFormat field's value.

func (*SnsAction) SetRoleArn added in v1.5.0

func (s *SnsAction) SetRoleArn(v string) *SnsAction

SetRoleArn sets the RoleArn field's value.

func (*SnsAction) SetTargetArn added in v1.5.0

func (s *SnsAction) SetTargetArn(v string) *SnsAction

SetTargetArn sets the TargetArn field's value.

func (SnsAction) String

func (s SnsAction) String() string

String returns the string representation

func (*SnsAction) Validate added in v1.1.21

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 is a required field
	QueueUrl *string `locationName:"queueUrl" type:"string" required:"true"`

	// The ARN of the IAM role that grants access.
	//
	// RoleArn is a required field
	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) SetQueueUrl added in v1.5.0

func (s *SqsAction) SetQueueUrl(v string) *SqsAction

SetQueueUrl sets the QueueUrl field's value.

func (*SqsAction) SetRoleArn added in v1.5.0

func (s *SqsAction) SetRoleArn(v string) *SqsAction

SetRoleArn sets the RoleArn field's value.

func (*SqsAction) SetUseBase64 added in v1.5.0

func (s *SqsAction) SetUseBase64(v bool) *SqsAction

SetUseBase64 sets the UseBase64 field's value.

func (SqsAction) String

func (s SqsAction) String() string

String returns the string representation

func (*SqsAction) Validate added in v1.1.21

func (s *SqsAction) Validate() error

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

type ThingAttribute

type ThingAttribute struct {

	// A list of thing attributes which are name-value pairs.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// The name of the thing.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`

	// The name of the thing type, if the thing has been associated with a type.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`

	// The version of the thing record in the registry.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

func (ThingAttribute) GoString

func (s ThingAttribute) GoString() string

GoString returns the string representation

func (*ThingAttribute) SetAttributes added in v1.5.0

func (s *ThingAttribute) SetAttributes(v map[string]*string) *ThingAttribute

SetAttributes sets the Attributes field's value.

func (*ThingAttribute) SetThingName added in v1.5.0

func (s *ThingAttribute) SetThingName(v string) *ThingAttribute

SetThingName sets the ThingName field's value.

func (*ThingAttribute) SetThingTypeName added in v1.5.0

func (s *ThingAttribute) SetThingTypeName(v string) *ThingAttribute

SetThingTypeName sets the ThingTypeName field's value.

func (*ThingAttribute) SetVersion added in v1.5.0

func (s *ThingAttribute) SetVersion(v int64) *ThingAttribute

SetVersion sets the Version field's value.

func (ThingAttribute) String

func (s ThingAttribute) String() string

String returns the string representation

type ThingTypeDefinition added in v1.2.8

type ThingTypeDefinition struct {

	// The ThingTypeMetadata contains additional information about the thing type
	// including: creation date and time, a value indicating whether the thing type
	// is deprecated, and a date and time when time was deprecated.
	ThingTypeMetadata *ThingTypeMetadata `locationName:"thingTypeMetadata" type:"structure"`

	// The name of the thing type.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`

	// The ThingTypeProperties for the thing type.
	ThingTypeProperties *ThingTypeProperties `locationName:"thingTypeProperties" type:"structure"`
	// contains filtered or unexported fields
}

The definition of the thing type, including thing type name and description.

func (ThingTypeDefinition) GoString added in v1.2.8

func (s ThingTypeDefinition) GoString() string

GoString returns the string representation

func (*ThingTypeDefinition) SetThingTypeMetadata added in v1.5.0

func (s *ThingTypeDefinition) SetThingTypeMetadata(v *ThingTypeMetadata) *ThingTypeDefinition

SetThingTypeMetadata sets the ThingTypeMetadata field's value.

func (*ThingTypeDefinition) SetThingTypeName added in v1.5.0

func (s *ThingTypeDefinition) SetThingTypeName(v string) *ThingTypeDefinition

SetThingTypeName sets the ThingTypeName field's value.

func (*ThingTypeDefinition) SetThingTypeProperties added in v1.5.0

func (s *ThingTypeDefinition) SetThingTypeProperties(v *ThingTypeProperties) *ThingTypeDefinition

SetThingTypeProperties sets the ThingTypeProperties field's value.

func (ThingTypeDefinition) String added in v1.2.8

func (s ThingTypeDefinition) String() string

String returns the string representation

type ThingTypeMetadata added in v1.2.8

type ThingTypeMetadata struct {

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

	// Whether the thing type is deprecated. If true, no new things could be associated
	// with this type.
	Deprecated *bool `locationName:"deprecated" type:"boolean"`

	// The date and time when the thing type was deprecated.
	DeprecationDate *time.Time `locationName:"deprecationDate" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.

func (ThingTypeMetadata) GoString added in v1.2.8

func (s ThingTypeMetadata) GoString() string

GoString returns the string representation

func (*ThingTypeMetadata) SetCreationDate added in v1.5.0

func (s *ThingTypeMetadata) SetCreationDate(v time.Time) *ThingTypeMetadata

SetCreationDate sets the CreationDate field's value.

func (*ThingTypeMetadata) SetDeprecated added in v1.5.0

func (s *ThingTypeMetadata) SetDeprecated(v bool) *ThingTypeMetadata

SetDeprecated sets the Deprecated field's value.

func (*ThingTypeMetadata) SetDeprecationDate added in v1.5.0

func (s *ThingTypeMetadata) SetDeprecationDate(v time.Time) *ThingTypeMetadata

SetDeprecationDate sets the DeprecationDate field's value.

func (ThingTypeMetadata) String added in v1.2.8

func (s ThingTypeMetadata) String() string

String returns the string representation

type ThingTypeProperties added in v1.2.8

type ThingTypeProperties struct {

	// A list of searchable thing attribute names.
	SearchableAttributes []*string `locationName:"searchableAttributes" type:"list"`

	// The description of the thing type.
	ThingTypeDescription *string `locationName:"thingTypeDescription" type:"string"`
	// contains filtered or unexported fields
}

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

func (ThingTypeProperties) GoString added in v1.2.8

func (s ThingTypeProperties) GoString() string

GoString returns the string representation

func (*ThingTypeProperties) SetSearchableAttributes added in v1.5.0

func (s *ThingTypeProperties) SetSearchableAttributes(v []*string) *ThingTypeProperties

SetSearchableAttributes sets the SearchableAttributes field's value.

func (*ThingTypeProperties) SetThingTypeDescription added in v1.5.0

func (s *ThingTypeProperties) SetThingTypeDescription(v string) *ThingTypeProperties

SetThingTypeDescription sets the ThingTypeDescription field's value.

func (ThingTypeProperties) String added in v1.2.8

func (s ThingTypeProperties) 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) SetActions added in v1.5.0

func (s *TopicRule) SetActions(v []*Action) *TopicRule

SetActions sets the Actions field's value.

func (*TopicRule) SetAwsIotSqlVersion added in v1.5.0

func (s *TopicRule) SetAwsIotSqlVersion(v string) *TopicRule

SetAwsIotSqlVersion sets the AwsIotSqlVersion field's value.

func (*TopicRule) SetCreatedAt added in v1.5.0

func (s *TopicRule) SetCreatedAt(v time.Time) *TopicRule

SetCreatedAt sets the CreatedAt field's value.

func (*TopicRule) SetDescription added in v1.5.0

func (s *TopicRule) SetDescription(v string) *TopicRule

SetDescription sets the Description field's value.

func (*TopicRule) SetRuleDisabled added in v1.5.0

func (s *TopicRule) SetRuleDisabled(v bool) *TopicRule

SetRuleDisabled sets the RuleDisabled field's value.

func (*TopicRule) SetRuleName added in v1.5.0

func (s *TopicRule) SetRuleName(v string) *TopicRule

SetRuleName sets the RuleName field's value.

func (*TopicRule) SetSql added in v1.5.0

func (s *TopicRule) SetSql(v string) *TopicRule

SetSql sets the Sql field's value.

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) SetCreatedAt added in v1.5.0

func (s *TopicRuleListItem) SetCreatedAt(v time.Time) *TopicRuleListItem

SetCreatedAt sets the CreatedAt field's value.

func (*TopicRuleListItem) SetRuleArn added in v1.5.0

func (s *TopicRuleListItem) SetRuleArn(v string) *TopicRuleListItem

SetRuleArn sets the RuleArn field's value.

func (*TopicRuleListItem) SetRuleDisabled added in v1.5.0

func (s *TopicRuleListItem) SetRuleDisabled(v bool) *TopicRuleListItem

SetRuleDisabled sets the RuleDisabled field's value.

func (*TopicRuleListItem) SetRuleName added in v1.5.0

func (s *TopicRuleListItem) SetRuleName(v string) *TopicRuleListItem

SetRuleName sets the RuleName field's value.

func (*TopicRuleListItem) SetTopicPattern added in v1.5.0

func (s *TopicRuleListItem) SetTopicPattern(v string) *TopicRuleListItem

SetTopicPattern sets the TopicPattern field's value.

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 is a required field
	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 is a required field
	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) SetActions added in v1.5.0

func (s *TopicRulePayload) SetActions(v []*Action) *TopicRulePayload

SetActions sets the Actions field's value.

func (*TopicRulePayload) SetAwsIotSqlVersion added in v1.5.0

func (s *TopicRulePayload) SetAwsIotSqlVersion(v string) *TopicRulePayload

SetAwsIotSqlVersion sets the AwsIotSqlVersion field's value.

func (*TopicRulePayload) SetDescription added in v1.5.0

func (s *TopicRulePayload) SetDescription(v string) *TopicRulePayload

SetDescription sets the Description field's value.

func (*TopicRulePayload) SetRuleDisabled added in v1.5.0

func (s *TopicRulePayload) SetRuleDisabled(v bool) *TopicRulePayload

SetRuleDisabled sets the RuleDisabled field's value.

func (*TopicRulePayload) SetSql added in v1.5.0

SetSql sets the Sql field's value.

func (TopicRulePayload) String

func (s TopicRulePayload) String() string

String returns the string representation

func (*TopicRulePayload) Validate added in v1.1.21

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 is a required field
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// The AWS account.
	//
	// TargetAwsAccount is a required field
	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) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*TransferCertificateInput) SetTargetAwsAccount added in v1.5.0

func (s *TransferCertificateInput) SetTargetAwsAccount(v string) *TransferCertificateInput

SetTargetAwsAccount sets the TargetAwsAccount field's value.

func (*TransferCertificateInput) SetTransferMessage added in v1.5.0

func (s *TransferCertificateInput) SetTransferMessage(v string) *TransferCertificateInput

SetTransferMessage sets the TransferMessage field's value.

func (TransferCertificateInput) String

func (s TransferCertificateInput) String() string

String returns the string representation

func (*TransferCertificateInput) Validate added in v1.1.21

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) SetTransferredCertificateArn added in v1.5.0

func (s *TransferCertificateOutput) SetTransferredCertificateArn(v string) *TransferCertificateOutput

SetTransferredCertificateArn sets the TransferredCertificateArn field's value.

func (TransferCertificateOutput) String

func (s TransferCertificateOutput) String() string

String returns the string representation

type TransferData added in v1.1.18

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 added in v1.1.18

func (s TransferData) GoString() string

GoString returns the string representation

func (*TransferData) SetAcceptDate added in v1.5.0

func (s *TransferData) SetAcceptDate(v time.Time) *TransferData

SetAcceptDate sets the AcceptDate field's value.

func (*TransferData) SetRejectDate added in v1.5.0

func (s *TransferData) SetRejectDate(v time.Time) *TransferData

SetRejectDate sets the RejectDate field's value.

func (*TransferData) SetRejectReason added in v1.5.0

func (s *TransferData) SetRejectReason(v string) *TransferData

SetRejectReason sets the RejectReason field's value.

func (*TransferData) SetTransferDate added in v1.5.0

func (s *TransferData) SetTransferDate(v time.Time) *TransferData

SetTransferDate sets the TransferDate field's value.

func (*TransferData) SetTransferMessage added in v1.5.0

func (s *TransferData) SetTransferMessage(v string) *TransferData

SetTransferMessage sets the TransferMessage field's value.

func (TransferData) String added in v1.1.18

func (s TransferData) String() string

String returns the string representation

type UpdateCACertificateInput added in v1.1.18

type UpdateCACertificateInput struct {

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

	// The new value for the auto registration status. Valid values are: "ENABLE"
	// or "DISABLE".
	NewAutoRegistrationStatus *string `location:"querystring" locationName:"newAutoRegistrationStatus" type:"string" enum:"AutoRegistrationStatus"`

	// 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" enum:"CACertificateStatus"`
	// contains filtered or unexported fields
}

The input to the UpdateCACertificate operation.

func (UpdateCACertificateInput) GoString added in v1.1.18

func (s UpdateCACertificateInput) GoString() string

GoString returns the string representation

func (*UpdateCACertificateInput) SetCertificateId added in v1.5.0

SetCertificateId sets the CertificateId field's value.

func (*UpdateCACertificateInput) SetNewAutoRegistrationStatus added in v1.5.0

func (s *UpdateCACertificateInput) SetNewAutoRegistrationStatus(v string) *UpdateCACertificateInput

SetNewAutoRegistrationStatus sets the NewAutoRegistrationStatus field's value.

func (*UpdateCACertificateInput) SetNewStatus added in v1.5.0

SetNewStatus sets the NewStatus field's value.

func (UpdateCACertificateInput) String added in v1.1.18

func (s UpdateCACertificateInput) String() string

String returns the string representation

func (*UpdateCACertificateInput) Validate added in v1.1.21

func (s *UpdateCACertificateInput) Validate() error

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

type UpdateCACertificateOutput added in v1.1.18

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

func (UpdateCACertificateOutput) GoString added in v1.1.18

func (s UpdateCACertificateOutput) GoString() string

GoString returns the string representation

func (UpdateCACertificateOutput) String added in v1.1.18

func (s UpdateCACertificateOutput) String() string

String returns the string representation

type UpdateCertificateInput

type UpdateCertificateInput struct {

	// The ID of the certificate.
	//
	// CertificateId is a required field
	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 is a required field
	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) SetCertificateId added in v1.5.0

func (s *UpdateCertificateInput) SetCertificateId(v string) *UpdateCertificateInput

SetCertificateId sets the CertificateId field's value.

func (*UpdateCertificateInput) SetNewStatus added in v1.5.0

SetNewStatus sets the NewStatus field's value.

func (UpdateCertificateInput) String

func (s UpdateCertificateInput) String() string

String returns the string representation

func (*UpdateCertificateInput) Validate added in v1.1.21

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 {

	// A list of thing attributes, a JSON string containing name-value pairs. For
	// example:
	//
	// {\"attributes\":{\"name1\":\"value2\"}})
	//
	// This data is used to add new attributes or update existing attributes.
	AttributePayload *AttributePayload `locationName:"attributePayload" type:"structure"`

	// The expected version of the thing record in the registry. If the version
	// of the record in the registry does not match the expected version specified
	// in the request, the UpdateThing request is rejected with a VersionConflictException.
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// Remove a thing type association. If true, the assocation is removed.
	RemoveThingType *bool `locationName:"removeThingType" type:"boolean"`

	// The name of the thing to update.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`

	// The name of the thing type.
	ThingTypeName *string `locationName:"thingTypeName" min:"1" type:"string"`
	// 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) SetAttributePayload added in v1.5.0

func (s *UpdateThingInput) SetAttributePayload(v *AttributePayload) *UpdateThingInput

SetAttributePayload sets the AttributePayload field's value.

func (*UpdateThingInput) SetExpectedVersion added in v1.5.0

func (s *UpdateThingInput) SetExpectedVersion(v int64) *UpdateThingInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateThingInput) SetRemoveThingType added in v1.5.0

func (s *UpdateThingInput) SetRemoveThingType(v bool) *UpdateThingInput

SetRemoveThingType sets the RemoveThingType field's value.

func (*UpdateThingInput) SetThingName added in v1.5.0

func (s *UpdateThingInput) SetThingName(v string) *UpdateThingInput

SetThingName sets the ThingName field's value.

func (*UpdateThingInput) SetThingTypeName added in v1.5.0

func (s *UpdateThingInput) SetThingTypeName(v string) *UpdateThingInput

SetThingTypeName sets the ThingTypeName field's value.

func (UpdateThingInput) String

func (s UpdateThingInput) String() string

String returns the string representation

func (*UpdateThingInput) Validate added in v1.1.21

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 to enable mocking the AWS IoT service client for testing your code.
Package iotiface provides an interface to enable mocking the AWS IoT service client for testing your code.

Jump to

Keyboard shortcuts

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