iot

package
v1.14.13 Latest Latest
Warning

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

Go to latest
Published: Jun 22, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation ¶

Overview ¶

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

AWS IoT provides secure, bi-directional communication between Internet-connected devices (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 device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

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

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

Using the Client ¶

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

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

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

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

Index ¶

Constants ¶

View Source
const (
	// ActionTypePublish is a ActionType enum value
	ActionTypePublish = "PUBLISH"

	// ActionTypeSubscribe is a ActionType enum value
	ActionTypeSubscribe = "SUBSCRIBE"

	// ActionTypeReceive is a ActionType enum value
	ActionTypeReceive = "RECEIVE"

	// ActionTypeConnect is a ActionType enum value
	ActionTypeConnect = "CONNECT"
)
View Source
const (
	// AuthDecisionAllowed is a AuthDecision enum value
	AuthDecisionAllowed = "ALLOWED"

	// AuthDecisionExplicitDeny is a AuthDecision enum value
	AuthDecisionExplicitDeny = "EXPLICIT_DENY"

	// AuthDecisionImplicitDeny is a AuthDecision enum value
	AuthDecisionImplicitDeny = "IMPLICIT_DENY"
)
View Source
const (
	// AuthorizerStatusActive is a AuthorizerStatus enum value
	AuthorizerStatusActive = "ACTIVE"

	// AuthorizerStatusInactive is a AuthorizerStatus enum value
	AuthorizerStatusInactive = "INACTIVE"
)
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 (
	// EventTypeThing is a EventType enum value
	EventTypeThing = "THING"

	// EventTypeThingGroup is a EventType enum value
	EventTypeThingGroup = "THING_GROUP"

	// EventTypeThingType is a EventType enum value
	EventTypeThingType = "THING_TYPE"

	// EventTypeThingGroupMembership is a EventType enum value
	EventTypeThingGroupMembership = "THING_GROUP_MEMBERSHIP"

	// EventTypeThingGroupHierarchy is a EventType enum value
	EventTypeThingGroupHierarchy = "THING_GROUP_HIERARCHY"

	// EventTypeThingTypeAssociation is a EventType enum value
	EventTypeThingTypeAssociation = "THING_TYPE_ASSOCIATION"

	// EventTypeJob is a EventType enum value
	EventTypeJob = "JOB"

	// EventTypeJobExecution is a EventType enum value
	EventTypeJobExecution = "JOB_EXECUTION"
)
View Source
const (
	// IndexStatusActive is a IndexStatus enum value
	IndexStatusActive = "ACTIVE"

	// IndexStatusBuilding is a IndexStatus enum value
	IndexStatusBuilding = "BUILDING"

	// IndexStatusRebuilding is a IndexStatus enum value
	IndexStatusRebuilding = "REBUILDING"
)
View Source
const (
	// JobExecutionStatusQueued is a JobExecutionStatus enum value
	JobExecutionStatusQueued = "QUEUED"

	// JobExecutionStatusInProgress is a JobExecutionStatus enum value
	JobExecutionStatusInProgress = "IN_PROGRESS"

	// JobExecutionStatusSucceeded is a JobExecutionStatus enum value
	JobExecutionStatusSucceeded = "SUCCEEDED"

	// JobExecutionStatusFailed is a JobExecutionStatus enum value
	JobExecutionStatusFailed = "FAILED"

	// JobExecutionStatusRejected is a JobExecutionStatus enum value
	JobExecutionStatusRejected = "REJECTED"

	// JobExecutionStatusRemoved is a JobExecutionStatus enum value
	JobExecutionStatusRemoved = "REMOVED"

	// JobExecutionStatusCanceled is a JobExecutionStatus enum value
	JobExecutionStatusCanceled = "CANCELED"
)
View Source
const (
	// JobStatusInProgress is a JobStatus enum value
	JobStatusInProgress = "IN_PROGRESS"

	// JobStatusCanceled is a JobStatus enum value
	JobStatusCanceled = "CANCELED"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusDeletionInProgress is a JobStatus enum value
	JobStatusDeletionInProgress = "DELETION_IN_PROGRESS"
)
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 (
	// LogTargetTypeDefault is a LogTargetType enum value
	LogTargetTypeDefault = "DEFAULT"

	// LogTargetTypeThingGroup is a LogTargetType enum value
	LogTargetTypeThingGroup = "THING_GROUP"
)
View Source
const (
	// MessageFormatRaw is a MessageFormat enum value
	MessageFormatRaw = "RAW"

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

	// OTAUpdateStatusCreateInProgress is a OTAUpdateStatus enum value
	OTAUpdateStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// OTAUpdateStatusCreateComplete is a OTAUpdateStatus enum value
	OTAUpdateStatusCreateComplete = "CREATE_COMPLETE"

	// OTAUpdateStatusCreateFailed is a OTAUpdateStatus enum value
	OTAUpdateStatusCreateFailed = "CREATE_FAILED"
)
View Source
const (
	// ReportTypeErrors is a ReportType enum value
	ReportTypeErrors = "ERRORS"

	// ReportTypeResults is a ReportType enum value
	ReportTypeResults = "RESULTS"
)
View Source
const (
	// StatusInProgress is a Status enum value
	StatusInProgress = "InProgress"

	// StatusCompleted is a Status enum value
	StatusCompleted = "Completed"

	// StatusFailed is a Status enum value
	StatusFailed = "Failed"

	// StatusCancelled is a Status enum value
	StatusCancelled = "Cancelled"

	// StatusCancelling is a Status enum value
	StatusCancelling = "Cancelling"
)
View Source
const (
	// TargetSelectionContinuous is a TargetSelection enum value
	TargetSelectionContinuous = "CONTINUOUS"

	// TargetSelectionSnapshot is a TargetSelection enum value
	TargetSelectionSnapshot = "SNAPSHOT"
)
View Source
const (
	// ThingIndexingModeOff is a ThingIndexingMode enum value
	ThingIndexingModeOff = "OFF"

	// ThingIndexingModeRegistry is a ThingIndexingMode enum value
	ThingIndexingModeRegistry = "REGISTRY"

	// ThingIndexingModeRegistryAndShadow is a ThingIndexingMode enum value
	ThingIndexingModeRegistryAndShadow = "REGISTRY_AND_SHADOW"
)
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"

	// ErrCodeConflictingResourceUpdateException for service response error code
	// "ConflictingResourceUpdateException".
	//
	// A conflicting resource update exception. This exception is thrown when two
	// pending updates cause a conflict.
	ErrCodeConflictingResourceUpdateException = "ConflictingResourceUpdateException"

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

	// ErrCodeIndexNotReadyException for service response error code
	// "IndexNotReadyException".
	//
	// The index is not ready.
	ErrCodeIndexNotReadyException = "IndexNotReadyException"

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

	// ErrCodeInvalidQueryException for service response error code
	// "InvalidQueryException".
	//
	// The query is invalid.
	ErrCodeInvalidQueryException = "InvalidQueryException"

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

	// ErrCodeInvalidResponseException for service response error code
	// "InvalidResponseException".
	//
	// The response is invalid.
	ErrCodeInvalidResponseException = "InvalidResponseException"

	// ErrCodeInvalidStateTransitionException for service response error code
	// "InvalidStateTransitionException".
	//
	// An attempt was made to change to an invalid state, for example by deleting
	// a job or a job execution which is "IN_PROGRESS" without setting the force
	// parameter.
	ErrCodeInvalidStateTransitionException = "InvalidStateTransitionException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

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

	// ErrCodeNotConfiguredException for service response error code
	// "NotConfiguredException".
	//
	// The resource is not configured.
	ErrCodeNotConfiguredException = "NotConfiguredException"

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

	// ErrCodeResourceRegistrationFailureException for service response error code
	// "ResourceRegistrationFailureException".
	//
	// The resource registration failed.
	ErrCodeResourceRegistrationFailureException = "ResourceRegistrationFailureException"

	// 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 an entity specified with the expectedVersion
	// parameter does not match the latest version in the system.
	ErrCodeVersionConflictException = "VersionConflictException"

	// ErrCodeVersionsLimitExceededException for service response error code
	// "VersionsLimitExceededException".
	//
	// The number of policy versions exceeds the limit.
	ErrCodeVersionsLimitExceededException = "VersionsLimitExceededException"
)
View Source
const (
	ServiceName = "iot"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "IoT"       // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AcceptCertificateTransferInput ¶

type AcceptCertificateTransferInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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"`

	// Sends message data to an AWS IoT Analytics channel.
	IotAnalytics *IotAnalyticsAction `locationName:"iotAnalytics" 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"`

	// Send a message to a Salesforce IoT Cloud Input Stream.
	Salesforce *SalesforceAction `locationName:"salesforce" 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) SetIotAnalytics ¶ added in v1.13.35

func (s *Action) SetIotAnalytics(v *IotAnalyticsAction) *Action

SetIotAnalytics sets the IotAnalytics 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) SetSalesforce ¶ added in v1.8.35

func (s *Action) SetSalesforce(v *SalesforceAction) *Action

SetSalesforce sets the Salesforce 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 AddThingToThingGroupInput ¶ added in v1.12.36

type AddThingToThingGroupInput struct {

	// The ARN of the thing to add to a group.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The ARN of the group to which you are adding a thing.
	ThingGroupArn *string `locationName:"thingGroupArn" type:"string"`

	// The name of the group to which you are adding a thing.
	ThingGroupName *string `locationName:"thingGroupName" min:"1" type:"string"`

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

func (AddThingToThingGroupInput) GoString ¶ added in v1.12.36

func (s AddThingToThingGroupInput) GoString() string

GoString returns the string representation

func (*AddThingToThingGroupInput) SetThingArn ¶ added in v1.12.36

SetThingArn sets the ThingArn field's value.

func (*AddThingToThingGroupInput) SetThingGroupArn ¶ added in v1.12.36

SetThingGroupArn sets the ThingGroupArn field's value.

func (*AddThingToThingGroupInput) SetThingGroupName ¶ added in v1.12.36

SetThingGroupName sets the ThingGroupName field's value.

func (*AddThingToThingGroupInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (AddThingToThingGroupInput) String ¶ added in v1.12.36

func (s AddThingToThingGroupInput) String() string

String returns the string representation

func (*AddThingToThingGroupInput) Validate ¶ added in v1.12.36

func (s *AddThingToThingGroupInput) Validate() error

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

type AddThingToThingGroupOutput ¶ added in v1.12.36

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

func (AddThingToThingGroupOutput) GoString ¶ added in v1.12.36

func (s AddThingToThingGroupOutput) GoString() string

GoString returns the string representation

func (AddThingToThingGroupOutput) String ¶ added in v1.12.36

String returns the string representation

type Allowed ¶ added in v1.12.36

type Allowed struct {

	// A list of policies that allowed the authentication.
	Policies []*Policy `locationName:"policies" type:"list"`
	// contains filtered or unexported fields
}

Contains information that allowed the authorization.

func (Allowed) GoString ¶ added in v1.12.36

func (s Allowed) GoString() string

GoString returns the string representation

func (*Allowed) SetPolicies ¶ added in v1.12.36

func (s *Allowed) SetPolicies(v []*Policy) *Allowed

SetPolicies sets the Policies field's value.

func (Allowed) String ¶ added in v1.12.36

func (s Allowed) String() string

String returns the string representation

type AssociateTargetsWithJobInput ¶ added in v1.12.36

type AssociateTargetsWithJobInput struct {

	// An optional comment string describing why the job was associated with the
	// targets.
	Comment *string `locationName:"comment" type:"string"`

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// A list of thing group ARNs that define the targets of the job.
	//
	// Targets is a required field
	Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateTargetsWithJobInput) GoString ¶ added in v1.12.36

func (s AssociateTargetsWithJobInput) GoString() string

GoString returns the string representation

func (*AssociateTargetsWithJobInput) SetComment ¶ added in v1.12.36

SetComment sets the Comment field's value.

func (*AssociateTargetsWithJobInput) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (*AssociateTargetsWithJobInput) SetTargets ¶ added in v1.12.36

SetTargets sets the Targets field's value.

func (AssociateTargetsWithJobInput) String ¶ added in v1.12.36

String returns the string representation

func (*AssociateTargetsWithJobInput) Validate ¶ added in v1.12.36

func (s *AssociateTargetsWithJobInput) Validate() error

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

type AssociateTargetsWithJobOutput ¶ added in v1.12.36

type AssociateTargetsWithJobOutput struct {

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// An ARN identifying the job.
	JobArn *string `locationName:"jobArn" type:"string"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateTargetsWithJobOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*AssociateTargetsWithJobOutput) SetDescription ¶ added in v1.12.36

SetDescription sets the Description field's value.

func (*AssociateTargetsWithJobOutput) SetJobArn ¶ added in v1.12.36

SetJobArn sets the JobArn field's value.

func (*AssociateTargetsWithJobOutput) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (AssociateTargetsWithJobOutput) String ¶ added in v1.12.36

String returns the string representation

type AttachPolicyInput ¶ added in v1.12.36

type AttachPolicyInput struct {

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

	// The identity to which the policy is attached.
	//
	// Target is a required field
	Target *string `locationName:"target" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachPolicyInput) GoString ¶ added in v1.12.36

func (s AttachPolicyInput) GoString() string

GoString returns the string representation

func (*AttachPolicyInput) SetPolicyName ¶ added in v1.12.36

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

SetPolicyName sets the PolicyName field's value.

func (*AttachPolicyInput) SetTarget ¶ added in v1.12.36

func (s *AttachPolicyInput) SetTarget(v string) *AttachPolicyInput

SetTarget sets the Target field's value.

func (AttachPolicyInput) String ¶ added in v1.12.36

func (s AttachPolicyInput) String() string

String returns the string representation

func (*AttachPolicyInput) Validate ¶ added in v1.12.36

func (s *AttachPolicyInput) Validate() error

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

type AttachPolicyOutput ¶ added in v1.12.36

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

func (AttachPolicyOutput) GoString ¶ added in v1.12.36

func (s AttachPolicyOutput) GoString() string

GoString returns the string representation

func (AttachPolicyOutput) String ¶ added in v1.12.36

func (s AttachPolicyOutput) String() string

String returns the string representation

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 AuthInfo ¶ added in v1.12.36

type AuthInfo struct {

	// The type of action for which the principal is being authorized.
	ActionType *string `locationName:"actionType" type:"string" enum:"ActionType"`

	// The resources for which the principal is being authorized to perform the
	// specified action.
	Resources []*string `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

A collection of authorization information.

func (AuthInfo) GoString ¶ added in v1.12.36

func (s AuthInfo) GoString() string

GoString returns the string representation

func (*AuthInfo) SetActionType ¶ added in v1.12.36

func (s *AuthInfo) SetActionType(v string) *AuthInfo

SetActionType sets the ActionType field's value.

func (*AuthInfo) SetResources ¶ added in v1.12.36

func (s *AuthInfo) SetResources(v []*string) *AuthInfo

SetResources sets the Resources field's value.

func (AuthInfo) String ¶ added in v1.12.36

func (s AuthInfo) String() string

String returns the string representation

type AuthResult ¶ added in v1.12.36

type AuthResult struct {

	// The policies and statements that allowed the specified action.
	Allowed *Allowed `locationName:"allowed" type:"structure"`

	// The final authorization decision of this scenario. Multiple statements are
	// taken into account when determining the authorization decision. An explicit
	// deny statement can override multiple allow statements.
	AuthDecision *string `locationName:"authDecision" type:"string" enum:"AuthDecision"`

	// Authorization information.
	AuthInfo *AuthInfo `locationName:"authInfo" type:"structure"`

	// The policies and statements that denied the specified action.
	Denied *Denied `locationName:"denied" type:"structure"`

	// Contains any missing context values found while evaluating policy.
	MissingContextValues []*string `locationName:"missingContextValues" type:"list"`
	// contains filtered or unexported fields
}

The authorizer result.

func (AuthResult) GoString ¶ added in v1.12.36

func (s AuthResult) GoString() string

GoString returns the string representation

func (*AuthResult) SetAllowed ¶ added in v1.12.36

func (s *AuthResult) SetAllowed(v *Allowed) *AuthResult

SetAllowed sets the Allowed field's value.

func (*AuthResult) SetAuthDecision ¶ added in v1.12.36

func (s *AuthResult) SetAuthDecision(v string) *AuthResult

SetAuthDecision sets the AuthDecision field's value.

func (*AuthResult) SetAuthInfo ¶ added in v1.12.36

func (s *AuthResult) SetAuthInfo(v *AuthInfo) *AuthResult

SetAuthInfo sets the AuthInfo field's value.

func (*AuthResult) SetDenied ¶ added in v1.12.36

func (s *AuthResult) SetDenied(v *Denied) *AuthResult

SetDenied sets the Denied field's value.

func (*AuthResult) SetMissingContextValues ¶ added in v1.12.36

func (s *AuthResult) SetMissingContextValues(v []*string) *AuthResult

SetMissingContextValues sets the MissingContextValues field's value.

func (AuthResult) String ¶ added in v1.12.36

func (s AuthResult) String() string

String returns the string representation

type AuthorizerDescription ¶ added in v1.12.36

type AuthorizerDescription struct {

	// The authorizer ARN.
	AuthorizerArn *string `locationName:"authorizerArn" type:"string"`

	// The authorizer's Lambda function ARN.
	AuthorizerFunctionArn *string `locationName:"authorizerFunctionArn" type:"string"`

	// The authorizer name.
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string"`

	// The UNIX timestamp of when the authorizer was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The UNIX timestamp of when the authorizer was last updated.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`

	// The status of the authorizer.
	Status *string `locationName:"status" type:"string" enum:"AuthorizerStatus"`

	// The key used to extract the token from the HTTP headers.
	TokenKeyName *string `locationName:"tokenKeyName" min:"1" type:"string"`

	// The public keys used to validate the token signature returned by your custom
	// authentication service.
	TokenSigningPublicKeys map[string]*string `locationName:"tokenSigningPublicKeys" type:"map"`
	// contains filtered or unexported fields
}

The authorizer description.

func (AuthorizerDescription) GoString ¶ added in v1.12.36

func (s AuthorizerDescription) GoString() string

GoString returns the string representation

func (*AuthorizerDescription) SetAuthorizerArn ¶ added in v1.12.36

func (s *AuthorizerDescription) SetAuthorizerArn(v string) *AuthorizerDescription

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*AuthorizerDescription) SetAuthorizerFunctionArn ¶ added in v1.12.36

func (s *AuthorizerDescription) SetAuthorizerFunctionArn(v string) *AuthorizerDescription

SetAuthorizerFunctionArn sets the AuthorizerFunctionArn field's value.

func (*AuthorizerDescription) SetAuthorizerName ¶ added in v1.12.36

func (s *AuthorizerDescription) SetAuthorizerName(v string) *AuthorizerDescription

SetAuthorizerName sets the AuthorizerName field's value.

func (*AuthorizerDescription) SetCreationDate ¶ added in v1.12.36

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

SetCreationDate sets the CreationDate field's value.

func (*AuthorizerDescription) SetLastModifiedDate ¶ added in v1.12.36

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*AuthorizerDescription) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (*AuthorizerDescription) SetTokenKeyName ¶ added in v1.12.36

func (s *AuthorizerDescription) SetTokenKeyName(v string) *AuthorizerDescription

SetTokenKeyName sets the TokenKeyName field's value.

func (*AuthorizerDescription) SetTokenSigningPublicKeys ¶ added in v1.12.36

func (s *AuthorizerDescription) SetTokenSigningPublicKeys(v map[string]*string) *AuthorizerDescription

SetTokenSigningPublicKeys sets the TokenSigningPublicKeys field's value.

func (AuthorizerDescription) String ¶ added in v1.12.36

func (s AuthorizerDescription) String() string

String returns the string representation

type AuthorizerSummary ¶ added in v1.12.36

type AuthorizerSummary struct {

	// The authorizer ARN.
	AuthorizerArn *string `locationName:"authorizerArn" type:"string"`

	// The authorizer name.
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The authorizer summary.

func (AuthorizerSummary) GoString ¶ added in v1.12.36

func (s AuthorizerSummary) GoString() string

GoString returns the string representation

func (*AuthorizerSummary) SetAuthorizerArn ¶ added in v1.12.36

func (s *AuthorizerSummary) SetAuthorizerArn(v string) *AuthorizerSummary

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*AuthorizerSummary) SetAuthorizerName ¶ added in v1.12.36

func (s *AuthorizerSummary) SetAuthorizerName(v string) *AuthorizerSummary

SetAuthorizerName sets the AuthorizerName field's value.

func (AuthorizerSummary) String ¶ added in v1.12.36

func (s AuthorizerSummary) 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 customer version of the CA certificate.
	CustomerVersion *int64 `locationName:"customerVersion" min:"1" type:"integer"`

	// The generation ID of the CA certificate.
	GenerationId *string `locationName:"generationId" type:"string"`

	// The date the CA certificate was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" 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) SetCustomerVersion ¶ added in v1.13.12

func (s *CACertificateDescription) SetCustomerVersion(v int64) *CACertificateDescription

SetCustomerVersion sets the CustomerVersion field's value.

func (*CACertificateDescription) SetGenerationId ¶ added in v1.13.12

SetGenerationId sets the GenerationId field's value.

func (*CACertificateDescription) SetLastModifiedDate ¶ added in v1.13.12

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

SetLastModifiedDate sets the LastModifiedDate 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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 CancelJobExecutionInput ¶ added in v1.13.60

type CancelJobExecutionInput struct {

	// (Optional) The expected current version of the job execution. Each time you
	// update the job execution, its version is incremented. If the version of the
	// job execution stored in Jobs does not match, the update is rejected with
	// a VersionMismatch error, and an ErrorResponse that contains the current job
	// execution status data is returned. (This makes it unnecessary to perform
	// a separate DescribeJobExecution request in order to obtain the job execution
	// status data.)
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// (Optional) If true the job execution will be canceled if it has status IN_PROGRESS
	// or QUEUED, otherwise the job execution will be canceled only if it has status
	// QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and
	// you do not set force to true, then an InvalidStateTransitionException will
	// be thrown. The default is false.
	//
	// Canceling a job execution which is "IN_PROGRESS", will cause the device to
	// be unable to update the job execution status. Use caution and ensure that
	// the device is able to recover to a valid state.
	Force *bool `location:"querystring" locationName:"force" type:"boolean"`

	// The ID of the job to be canceled.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// A collection of name/value pairs that describe the status of the job execution.
	// If not specified, the statusDetails are unchanged. You can specify at most
	// 10 name/value pairs.
	StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`

	// The name of the thing whose execution of the job will be canceled.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelJobExecutionInput) GoString ¶ added in v1.13.60

func (s CancelJobExecutionInput) GoString() string

GoString returns the string representation

func (*CancelJobExecutionInput) SetExpectedVersion ¶ added in v1.13.60

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*CancelJobExecutionInput) SetForce ¶ added in v1.13.60

SetForce sets the Force field's value.

func (*CancelJobExecutionInput) SetJobId ¶ added in v1.13.60

SetJobId sets the JobId field's value.

func (*CancelJobExecutionInput) SetStatusDetails ¶ added in v1.13.60

func (s *CancelJobExecutionInput) SetStatusDetails(v map[string]*string) *CancelJobExecutionInput

SetStatusDetails sets the StatusDetails field's value.

func (*CancelJobExecutionInput) SetThingName ¶ added in v1.13.60

SetThingName sets the ThingName field's value.

func (CancelJobExecutionInput) String ¶ added in v1.13.60

func (s CancelJobExecutionInput) String() string

String returns the string representation

func (*CancelJobExecutionInput) Validate ¶ added in v1.13.60

func (s *CancelJobExecutionInput) Validate() error

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

type CancelJobExecutionOutput ¶ added in v1.13.60

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

func (CancelJobExecutionOutput) GoString ¶ added in v1.13.60

func (s CancelJobExecutionOutput) GoString() string

GoString returns the string representation

func (CancelJobExecutionOutput) String ¶ added in v1.13.60

func (s CancelJobExecutionOutput) String() string

String returns the string representation

type CancelJobInput ¶ added in v1.12.36

type CancelJobInput struct {

	// An optional comment string describing why the job was canceled.
	Comment *string `locationName:"comment" type:"string"`

	// (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED"
	// are canceled, otherwise only job executions with status "QUEUED" are canceled.
	// The default is false.
	//
	// Canceling a job which is "IN_PROGRESS", will cause a device which is executing
	// the job to be unable to update the job execution status. Use caution and
	// ensure that each device executing a job which is canceled is able to recover
	// to a valid state.
	Force *bool `location:"querystring" locationName:"force" type:"boolean"`

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelJobInput) GoString ¶ added in v1.12.36

func (s CancelJobInput) GoString() string

GoString returns the string representation

func (*CancelJobInput) SetComment ¶ added in v1.12.36

func (s *CancelJobInput) SetComment(v string) *CancelJobInput

SetComment sets the Comment field's value.

func (*CancelJobInput) SetForce ¶ added in v1.13.60

func (s *CancelJobInput) SetForce(v bool) *CancelJobInput

SetForce sets the Force field's value.

func (*CancelJobInput) SetJobId ¶ added in v1.12.36

func (s *CancelJobInput) SetJobId(v string) *CancelJobInput

SetJobId sets the JobId field's value.

func (CancelJobInput) String ¶ added in v1.12.36

func (s CancelJobInput) String() string

String returns the string representation

func (*CancelJobInput) Validate ¶ added in v1.12.36

func (s *CancelJobInput) Validate() error

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

type CancelJobOutput ¶ added in v1.12.36

type CancelJobOutput struct {

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// The job ARN.
	JobArn *string `locationName:"jobArn" type:"string"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CancelJobOutput) GoString ¶ added in v1.12.36

func (s CancelJobOutput) GoString() string

GoString returns the string representation

func (*CancelJobOutput) SetDescription ¶ added in v1.12.36

func (s *CancelJobOutput) SetDescription(v string) *CancelJobOutput

SetDescription sets the Description field's value.

func (*CancelJobOutput) SetJobArn ¶ added in v1.12.36

func (s *CancelJobOutput) SetJobArn(v string) *CancelJobOutput

SetJobArn sets the JobArn field's value.

func (*CancelJobOutput) SetJobId ¶ added in v1.12.36

func (s *CancelJobOutput) SetJobId(v string) *CancelJobOutput

SetJobId sets the JobId field's value.

func (CancelJobOutput) String ¶ added in v1.12.36

func (s CancelJobOutput) String() 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	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 customer version of the certificate.
	CustomerVersion *int64 `locationName:"customerVersion" min:"1" type:"integer"`

	// The generation ID of the certificate.
	GenerationId *string `locationName:"generationId" type:"string"`

	// 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) SetCustomerVersion ¶ added in v1.13.12

func (s *CertificateDescription) SetCustomerVersion(v int64) *CertificateDescription

SetCustomerVersion sets the CustomerVersion field's value.

func (*CertificateDescription) SetGenerationId ¶ added in v1.13.12

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

SetGenerationId sets the GenerationId 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 ClearDefaultAuthorizerInput ¶ added in v1.12.36

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

func (ClearDefaultAuthorizerInput) GoString ¶ added in v1.12.36

func (s ClearDefaultAuthorizerInput) GoString() string

GoString returns the string representation

func (ClearDefaultAuthorizerInput) String ¶ added in v1.12.36

String returns the string representation

type ClearDefaultAuthorizerOutput ¶ added in v1.12.36

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

func (ClearDefaultAuthorizerOutput) GoString ¶ added in v1.12.36

func (s ClearDefaultAuthorizerOutput) GoString() string

GoString returns the string representation

func (ClearDefaultAuthorizerOutput) String ¶ added in v1.12.36

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 CodeSigning ¶ added in v1.12.51

type CodeSigning struct {

	// The ID of the AWSSignerJob which was created to sign the file.
	AwsSignerJobId *string `locationName:"awsSignerJobId" type:"string"`

	// A custom method for code signing a file.
	CustomCodeSigning *CustomCodeSigning `locationName:"customCodeSigning" type:"structure"`
	// contains filtered or unexported fields
}

Describes the method to use when code signing a file.

func (CodeSigning) GoString ¶ added in v1.12.51

func (s CodeSigning) GoString() string

GoString returns the string representation

func (*CodeSigning) SetAwsSignerJobId ¶ added in v1.12.51

func (s *CodeSigning) SetAwsSignerJobId(v string) *CodeSigning

SetAwsSignerJobId sets the AwsSignerJobId field's value.

func (*CodeSigning) SetCustomCodeSigning ¶ added in v1.12.51

func (s *CodeSigning) SetCustomCodeSigning(v *CustomCodeSigning) *CodeSigning

SetCustomCodeSigning sets the CustomCodeSigning field's value.

func (CodeSigning) String ¶ added in v1.12.51

func (s CodeSigning) String() string

String returns the string representation

func (*CodeSigning) Validate ¶ added in v1.12.51

func (s *CodeSigning) Validate() error

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

type CodeSigningCertificateChain ¶ added in v1.12.51

type CodeSigningCertificateChain struct {

	// The name of the certificate.
	CertificateName *string `locationName:"certificateName" type:"string"`

	// A base64 encoded binary representation of the code signing certificate chain.
	InlineDocument *string `locationName:"inlineDocument" type:"string"`

	// A stream of the certificate chain files.
	Stream *Stream `locationName:"stream" type:"structure"`
	// contains filtered or unexported fields
}

Describes the certificate chain being used when code signing a file.

func (CodeSigningCertificateChain) GoString ¶ added in v1.12.51

func (s CodeSigningCertificateChain) GoString() string

GoString returns the string representation

func (*CodeSigningCertificateChain) SetCertificateName ¶ added in v1.12.51

SetCertificateName sets the CertificateName field's value.

func (*CodeSigningCertificateChain) SetInlineDocument ¶ added in v1.12.51

SetInlineDocument sets the InlineDocument field's value.

func (*CodeSigningCertificateChain) SetStream ¶ added in v1.12.51

SetStream sets the Stream field's value.

func (CodeSigningCertificateChain) String ¶ added in v1.12.51

String returns the string representation

func (*CodeSigningCertificateChain) Validate ¶ added in v1.12.51

func (s *CodeSigningCertificateChain) Validate() error

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

type CodeSigningSignature ¶ added in v1.12.51

type CodeSigningSignature struct {

	// A base64 encoded binary representation of the code signing signature.
	//
	// InlineDocument is automatically base64 encoded/decoded by the SDK.
	InlineDocument []byte `locationName:"inlineDocument" type:"blob"`

	// A stream of the code signing signature.
	Stream *Stream `locationName:"stream" type:"structure"`
	// contains filtered or unexported fields
}

Describes the signature for a file.

func (CodeSigningSignature) GoString ¶ added in v1.12.51

func (s CodeSigningSignature) GoString() string

GoString returns the string representation

func (*CodeSigningSignature) SetInlineDocument ¶ added in v1.12.51

func (s *CodeSigningSignature) SetInlineDocument(v []byte) *CodeSigningSignature

SetInlineDocument sets the InlineDocument field's value.

func (*CodeSigningSignature) SetStream ¶ added in v1.12.51

SetStream sets the Stream field's value.

func (CodeSigningSignature) String ¶ added in v1.12.51

func (s CodeSigningSignature) String() string

String returns the string representation

func (*CodeSigningSignature) Validate ¶ added in v1.12.51

func (s *CodeSigningSignature) Validate() error

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

type Configuration ¶ added in v1.12.36

type Configuration struct {

	// True to enable the configuration.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Configuration.

func (Configuration) GoString ¶ added in v1.12.36

func (s Configuration) GoString() string

GoString returns the string representation

func (*Configuration) SetEnabled ¶ added in v1.12.36

func (s *Configuration) SetEnabled(v bool) *Configuration

SetEnabled sets the Enabled field's value.

func (Configuration) String ¶ added in v1.12.36

func (s Configuration) String() string

String returns the string representation

type CreateAuthorizerInput ¶ added in v1.12.36

type CreateAuthorizerInput struct {

	// The ARN of the authorizer's Lambda function.
	//
	// AuthorizerFunctionArn is a required field
	AuthorizerFunctionArn *string `locationName:"authorizerFunctionArn" type:"string" required:"true"`

	// The authorizer name.
	//
	// AuthorizerName is a required field
	AuthorizerName *string `location:"uri" locationName:"authorizerName" min:"1" type:"string" required:"true"`

	// The status of the create authorizer request.
	Status *string `locationName:"status" type:"string" enum:"AuthorizerStatus"`

	// The name of the token key used to extract the token from the HTTP headers.
	//
	// TokenKeyName is a required field
	TokenKeyName *string `locationName:"tokenKeyName" min:"1" type:"string" required:"true"`

	// The public keys used to verify the digital signature returned by your custom
	// authentication service.
	//
	// TokenSigningPublicKeys is a required field
	TokenSigningPublicKeys map[string]*string `locationName:"tokenSigningPublicKeys" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAuthorizerInput) GoString ¶ added in v1.12.36

func (s CreateAuthorizerInput) GoString() string

GoString returns the string representation

func (*CreateAuthorizerInput) SetAuthorizerFunctionArn ¶ added in v1.12.36

func (s *CreateAuthorizerInput) SetAuthorizerFunctionArn(v string) *CreateAuthorizerInput

SetAuthorizerFunctionArn sets the AuthorizerFunctionArn field's value.

func (*CreateAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

func (s *CreateAuthorizerInput) SetAuthorizerName(v string) *CreateAuthorizerInput

SetAuthorizerName sets the AuthorizerName field's value.

func (*CreateAuthorizerInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (*CreateAuthorizerInput) SetTokenKeyName ¶ added in v1.12.36

func (s *CreateAuthorizerInput) SetTokenKeyName(v string) *CreateAuthorizerInput

SetTokenKeyName sets the TokenKeyName field's value.

func (*CreateAuthorizerInput) SetTokenSigningPublicKeys ¶ added in v1.12.36

func (s *CreateAuthorizerInput) SetTokenSigningPublicKeys(v map[string]*string) *CreateAuthorizerInput

SetTokenSigningPublicKeys sets the TokenSigningPublicKeys field's value.

func (CreateAuthorizerInput) String ¶ added in v1.12.36

func (s CreateAuthorizerInput) String() string

String returns the string representation

func (*CreateAuthorizerInput) Validate ¶ added in v1.12.36

func (s *CreateAuthorizerInput) Validate() error

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

type CreateAuthorizerOutput ¶ added in v1.12.36

type CreateAuthorizerOutput struct {

	// The authorizer ARN.
	AuthorizerArn *string `locationName:"authorizerArn" type:"string"`

	// The authorizer's name.
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAuthorizerOutput) GoString ¶ added in v1.12.36

func (s CreateAuthorizerOutput) GoString() string

GoString returns the string representation

func (*CreateAuthorizerOutput) SetAuthorizerArn ¶ added in v1.12.36

func (s *CreateAuthorizerOutput) SetAuthorizerArn(v string) *CreateAuthorizerOutput

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*CreateAuthorizerOutput) SetAuthorizerName ¶ added in v1.12.36

func (s *CreateAuthorizerOutput) SetAuthorizerName(v string) *CreateAuthorizerOutput

SetAuthorizerName sets the AuthorizerName field's value.

func (CreateAuthorizerOutput) String ¶ added in v1.12.36

func (s CreateAuthorizerOutput) String() string

String returns the string representation

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 CreateJobInput ¶ added in v1.12.36

type CreateJobInput struct {

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// The job document.
	Document *string `locationName:"document" type:"string"`

	// Parameters for the job document.
	DocumentParameters map[string]*string `locationName:"documentParameters" type:"map"`

	// An S3 link to the job document.
	DocumentSource *string `locationName:"documentSource" min:"1" type:"string"`

	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *JobExecutionsRolloutConfig `locationName:"jobExecutionsRolloutConfig" type:"structure"`

	// A job identifier which must be unique for your AWS account. We recommend
	// using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// Configuration information for pre-signed S3 URLs.
	PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"`

	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected
	// in a target. For example, a job will run on a thing when the thing is added
	// to a target group, even after the job was completed by all things originally
	// in the group.
	TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// A list of things and thing groups to which the job should be sent.
	//
	// Targets is a required field
	Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJobInput) GoString ¶ added in v1.12.36

func (s CreateJobInput) GoString() string

GoString returns the string representation

func (*CreateJobInput) SetDescription ¶ added in v1.12.36

func (s *CreateJobInput) SetDescription(v string) *CreateJobInput

SetDescription sets the Description field's value.

func (*CreateJobInput) SetDocument ¶ added in v1.12.36

func (s *CreateJobInput) SetDocument(v string) *CreateJobInput

SetDocument sets the Document field's value.

func (*CreateJobInput) SetDocumentParameters ¶ added in v1.12.36

func (s *CreateJobInput) SetDocumentParameters(v map[string]*string) *CreateJobInput

SetDocumentParameters sets the DocumentParameters field's value.

func (*CreateJobInput) SetDocumentSource ¶ added in v1.12.36

func (s *CreateJobInput) SetDocumentSource(v string) *CreateJobInput

SetDocumentSource sets the DocumentSource field's value.

func (*CreateJobInput) SetJobExecutionsRolloutConfig ¶ added in v1.12.36

func (s *CreateJobInput) SetJobExecutionsRolloutConfig(v *JobExecutionsRolloutConfig) *CreateJobInput

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*CreateJobInput) SetJobId ¶ added in v1.12.36

func (s *CreateJobInput) SetJobId(v string) *CreateJobInput

SetJobId sets the JobId field's value.

func (*CreateJobInput) SetPresignedUrlConfig ¶ added in v1.12.36

func (s *CreateJobInput) SetPresignedUrlConfig(v *PresignedUrlConfig) *CreateJobInput

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

func (*CreateJobInput) SetTargetSelection ¶ added in v1.12.36

func (s *CreateJobInput) SetTargetSelection(v string) *CreateJobInput

SetTargetSelection sets the TargetSelection field's value.

func (*CreateJobInput) SetTargets ¶ added in v1.12.36

func (s *CreateJobInput) SetTargets(v []*string) *CreateJobInput

SetTargets sets the Targets field's value.

func (CreateJobInput) String ¶ added in v1.12.36

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate ¶ added in v1.12.36

func (s *CreateJobInput) Validate() error

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

type CreateJobOutput ¶ added in v1.12.36

type CreateJobOutput struct {

	// The job description.
	Description *string `locationName:"description" type:"string"`

	// The job ARN.
	JobArn *string `locationName:"jobArn" type:"string"`

	// The unique identifier you assigned to this job.
	JobId *string `locationName:"jobId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateJobOutput) GoString ¶ added in v1.12.36

func (s CreateJobOutput) GoString() string

GoString returns the string representation

func (*CreateJobOutput) SetDescription ¶ added in v1.12.36

func (s *CreateJobOutput) SetDescription(v string) *CreateJobOutput

SetDescription sets the Description field's value.

func (*CreateJobOutput) SetJobArn ¶ added in v1.12.36

func (s *CreateJobOutput) SetJobArn(v string) *CreateJobOutput

SetJobArn sets the JobArn field's value.

func (*CreateJobOutput) SetJobId ¶ added in v1.12.36

func (s *CreateJobOutput) SetJobId(v string) *CreateJobOutput

SetJobId sets the JobId field's value.

func (CreateJobOutput) String ¶ added in v1.12.36

func (s CreateJobOutput) String() 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 CreateOTAUpdateInput ¶ added in v1.12.51

type CreateOTAUpdateInput struct {

	// A list of additional OTA update parameters which are name-value pairs.
	AdditionalParameters map[string]*string `locationName:"additionalParameters" type:"map"`

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

	// The files to be streamed by the OTA update.
	//
	// Files is a required field
	Files []*OTAUpdateFile `locationName:"files" min:"1" type:"list" required:"true"`

	// The ID of the OTA update to be created.
	//
	// OtaUpdateId is a required field
	OtaUpdateId *string `location:"uri" locationName:"otaUpdateId" min:"1" type:"string" required:"true"`

	// The IAM role that allows access to the AWS IoT Jobs service.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// Specifies whether the update will continue to run (CONTINUOUS), or will be
	// complete after all the things specified as targets have completed the update
	// (SNAPSHOT). If continuous, the update may also be run on a thing when a change
	// is detected in a target. For example, an update will run on a thing when
	// the thing is added to a target group, even after the update was completed
	// by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
	TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// The targeted devices to receive OTA updates.
	//
	// Targets is a required field
	Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateOTAUpdateInput) GoString ¶ added in v1.12.51

func (s CreateOTAUpdateInput) GoString() string

GoString returns the string representation

func (*CreateOTAUpdateInput) SetAdditionalParameters ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) SetAdditionalParameters(v map[string]*string) *CreateOTAUpdateInput

SetAdditionalParameters sets the AdditionalParameters field's value.

func (*CreateOTAUpdateInput) SetDescription ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) SetDescription(v string) *CreateOTAUpdateInput

SetDescription sets the Description field's value.

func (*CreateOTAUpdateInput) SetFiles ¶ added in v1.12.51

SetFiles sets the Files field's value.

func (*CreateOTAUpdateInput) SetOtaUpdateId ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) SetOtaUpdateId(v string) *CreateOTAUpdateInput

SetOtaUpdateId sets the OtaUpdateId field's value.

func (*CreateOTAUpdateInput) SetRoleArn ¶ added in v1.12.51

SetRoleArn sets the RoleArn field's value.

func (*CreateOTAUpdateInput) SetTargetSelection ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) SetTargetSelection(v string) *CreateOTAUpdateInput

SetTargetSelection sets the TargetSelection field's value.

func (*CreateOTAUpdateInput) SetTargets ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) SetTargets(v []*string) *CreateOTAUpdateInput

SetTargets sets the Targets field's value.

func (CreateOTAUpdateInput) String ¶ added in v1.12.51

func (s CreateOTAUpdateInput) String() string

String returns the string representation

func (*CreateOTAUpdateInput) Validate ¶ added in v1.12.51

func (s *CreateOTAUpdateInput) Validate() error

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

type CreateOTAUpdateOutput ¶ added in v1.12.51

type CreateOTAUpdateOutput struct {

	// The AWS IoT job ARN associated with the OTA update.
	AwsIotJobArn *string `locationName:"awsIotJobArn" type:"string"`

	// The AWS IoT job ID associated with the OTA update.
	AwsIotJobId *string `locationName:"awsIotJobId" type:"string"`

	// The OTA update ARN.
	OtaUpdateArn *string `locationName:"otaUpdateArn" type:"string"`

	// The OTA update ID.
	OtaUpdateId *string `locationName:"otaUpdateId" min:"1" type:"string"`

	// The OTA update status.
	OtaUpdateStatus *string `locationName:"otaUpdateStatus" type:"string" enum:"OTAUpdateStatus"`
	// contains filtered or unexported fields
}

func (CreateOTAUpdateOutput) GoString ¶ added in v1.12.51

func (s CreateOTAUpdateOutput) GoString() string

GoString returns the string representation

func (*CreateOTAUpdateOutput) SetAwsIotJobArn ¶ added in v1.12.51

func (s *CreateOTAUpdateOutput) SetAwsIotJobArn(v string) *CreateOTAUpdateOutput

SetAwsIotJobArn sets the AwsIotJobArn field's value.

func (*CreateOTAUpdateOutput) SetAwsIotJobId ¶ added in v1.12.51

func (s *CreateOTAUpdateOutput) SetAwsIotJobId(v string) *CreateOTAUpdateOutput

SetAwsIotJobId sets the AwsIotJobId field's value.

func (*CreateOTAUpdateOutput) SetOtaUpdateArn ¶ added in v1.12.51

func (s *CreateOTAUpdateOutput) SetOtaUpdateArn(v string) *CreateOTAUpdateOutput

SetOtaUpdateArn sets the OtaUpdateArn field's value.

func (*CreateOTAUpdateOutput) SetOtaUpdateId ¶ added in v1.12.51

func (s *CreateOTAUpdateOutput) SetOtaUpdateId(v string) *CreateOTAUpdateOutput

SetOtaUpdateId sets the OtaUpdateId field's value.

func (*CreateOTAUpdateOutput) SetOtaUpdateStatus ¶ added in v1.12.51

func (s *CreateOTAUpdateOutput) SetOtaUpdateStatus(v string) *CreateOTAUpdateOutput

SetOtaUpdateStatus sets the OtaUpdateStatus field's value.

func (CreateOTAUpdateOutput) String ¶ added in v1.12.51

func (s CreateOTAUpdateOutput) String() 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 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"`

	// 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 CreateRoleAliasInput ¶ added in v1.12.36

type CreateRoleAliasInput struct {

	// How long (in seconds) the credentials will be valid.
	CredentialDurationSeconds *int64 `locationName:"credentialDurationSeconds" min:"900" type:"integer"`

	// The role alias that points to a role ARN. This allows you to change the role
	// without having to update the device.
	//
	// RoleAlias is a required field
	RoleAlias *string `location:"uri" locationName:"roleAlias" min:"1" type:"string" required:"true"`

	// The role ARN.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRoleAliasInput) GoString ¶ added in v1.12.36

func (s CreateRoleAliasInput) GoString() string

GoString returns the string representation

func (*CreateRoleAliasInput) SetCredentialDurationSeconds ¶ added in v1.12.36

func (s *CreateRoleAliasInput) SetCredentialDurationSeconds(v int64) *CreateRoleAliasInput

SetCredentialDurationSeconds sets the CredentialDurationSeconds field's value.

func (*CreateRoleAliasInput) SetRoleAlias ¶ added in v1.12.36

func (s *CreateRoleAliasInput) SetRoleAlias(v string) *CreateRoleAliasInput

SetRoleAlias sets the RoleAlias field's value.

func (*CreateRoleAliasInput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (CreateRoleAliasInput) String ¶ added in v1.12.36

func (s CreateRoleAliasInput) String() string

String returns the string representation

func (*CreateRoleAliasInput) Validate ¶ added in v1.12.36

func (s *CreateRoleAliasInput) Validate() error

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

type CreateRoleAliasOutput ¶ added in v1.12.36

type CreateRoleAliasOutput struct {

	// The role alias.
	RoleAlias *string `locationName:"roleAlias" min:"1" type:"string"`

	// The role alias ARN.
	RoleAliasArn *string `locationName:"roleAliasArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateRoleAliasOutput) GoString ¶ added in v1.12.36

func (s CreateRoleAliasOutput) GoString() string

GoString returns the string representation

func (*CreateRoleAliasOutput) SetRoleAlias ¶ added in v1.12.36

SetRoleAlias sets the RoleAlias field's value.

func (*CreateRoleAliasOutput) SetRoleAliasArn ¶ added in v1.12.36

func (s *CreateRoleAliasOutput) SetRoleAliasArn(v string) *CreateRoleAliasOutput

SetRoleAliasArn sets the RoleAliasArn field's value.

func (CreateRoleAliasOutput) String ¶ added in v1.12.36

func (s CreateRoleAliasOutput) String() string

String returns the string representation

type CreateStreamInput ¶ added in v1.12.51

type CreateStreamInput struct {

	// A description of the stream.
	Description *string `locationName:"description" type:"string"`

	// The files to stream.
	//
	// Files is a required field
	Files []*StreamFile `locationName:"files" min:"1" type:"list" required:"true"`

	// An IAM role that allows the IoT service principal assumes to access your
	// S3 files.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The stream ID.
	//
	// StreamId is a required field
	StreamId *string `location:"uri" locationName:"streamId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStreamInput) GoString ¶ added in v1.12.51

func (s CreateStreamInput) GoString() string

GoString returns the string representation

func (*CreateStreamInput) SetDescription ¶ added in v1.12.51

func (s *CreateStreamInput) SetDescription(v string) *CreateStreamInput

SetDescription sets the Description field's value.

func (*CreateStreamInput) SetFiles ¶ added in v1.12.51

func (s *CreateStreamInput) SetFiles(v []*StreamFile) *CreateStreamInput

SetFiles sets the Files field's value.

func (*CreateStreamInput) SetRoleArn ¶ added in v1.12.51

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

SetRoleArn sets the RoleArn field's value.

func (*CreateStreamInput) SetStreamId ¶ added in v1.12.51

func (s *CreateStreamInput) SetStreamId(v string) *CreateStreamInput

SetStreamId sets the StreamId field's value.

func (CreateStreamInput) String ¶ added in v1.12.51

func (s CreateStreamInput) String() string

String returns the string representation

func (*CreateStreamInput) Validate ¶ added in v1.12.51

func (s *CreateStreamInput) Validate() error

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

type CreateStreamOutput ¶ added in v1.12.51

type CreateStreamOutput struct {

	// A description of the stream.
	Description *string `locationName:"description" type:"string"`

	// The stream ARN.
	StreamArn *string `locationName:"streamArn" type:"string"`

	// The stream ID.
	StreamId *string `locationName:"streamId" min:"1" type:"string"`

	// The version of the stream.
	StreamVersion *int64 `locationName:"streamVersion" type:"integer"`
	// contains filtered or unexported fields
}

func (CreateStreamOutput) GoString ¶ added in v1.12.51

func (s CreateStreamOutput) GoString() string

GoString returns the string representation

func (*CreateStreamOutput) SetDescription ¶ added in v1.12.51

func (s *CreateStreamOutput) SetDescription(v string) *CreateStreamOutput

SetDescription sets the Description field's value.

func (*CreateStreamOutput) SetStreamArn ¶ added in v1.12.51

func (s *CreateStreamOutput) SetStreamArn(v string) *CreateStreamOutput

SetStreamArn sets the StreamArn field's value.

func (*CreateStreamOutput) SetStreamId ¶ added in v1.12.51

func (s *CreateStreamOutput) SetStreamId(v string) *CreateStreamOutput

SetStreamId sets the StreamId field's value.

func (*CreateStreamOutput) SetStreamVersion ¶ added in v1.12.51

func (s *CreateStreamOutput) SetStreamVersion(v int64) *CreateStreamOutput

SetStreamVersion sets the StreamVersion field's value.

func (CreateStreamOutput) String ¶ added in v1.12.51

func (s CreateStreamOutput) String() string

String returns the string representation

type CreateThingGroupInput ¶ added in v1.12.36

type CreateThingGroupInput struct {

	// The name of the parent thing group.
	ParentGroupName *string `locationName:"parentGroupName" min:"1" type:"string"`

	// The thing group name to create.
	//
	// ThingGroupName is a required field
	ThingGroupName *string `location:"uri" locationName:"thingGroupName" min:"1" type:"string" required:"true"`

	// The thing group properties.
	ThingGroupProperties *ThingGroupProperties `locationName:"thingGroupProperties" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateThingGroupInput) GoString ¶ added in v1.12.36

func (s CreateThingGroupInput) GoString() string

GoString returns the string representation

func (*CreateThingGroupInput) SetParentGroupName ¶ added in v1.12.36

func (s *CreateThingGroupInput) SetParentGroupName(v string) *CreateThingGroupInput

SetParentGroupName sets the ParentGroupName field's value.

func (*CreateThingGroupInput) SetThingGroupName ¶ added in v1.12.36

func (s *CreateThingGroupInput) SetThingGroupName(v string) *CreateThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (*CreateThingGroupInput) SetThingGroupProperties ¶ added in v1.12.36

func (s *CreateThingGroupInput) SetThingGroupProperties(v *ThingGroupProperties) *CreateThingGroupInput

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (CreateThingGroupInput) String ¶ added in v1.12.36

func (s CreateThingGroupInput) String() string

String returns the string representation

func (*CreateThingGroupInput) Validate ¶ added in v1.12.36

func (s *CreateThingGroupInput) Validate() error

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

type CreateThingGroupOutput ¶ added in v1.12.36

type CreateThingGroupOutput struct {

	// The thing group ARN.
	ThingGroupArn *string `locationName:"thingGroupArn" type:"string"`

	// The thing group ID.
	ThingGroupId *string `locationName:"thingGroupId" min:"1" type:"string"`

	// The thing group name.
	ThingGroupName *string `locationName:"thingGroupName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateThingGroupOutput) GoString ¶ added in v1.12.36

func (s CreateThingGroupOutput) GoString() string

GoString returns the string representation

func (*CreateThingGroupOutput) SetThingGroupArn ¶ added in v1.12.36

func (s *CreateThingGroupOutput) SetThingGroupArn(v string) *CreateThingGroupOutput

SetThingGroupArn sets the ThingGroupArn field's value.

func (*CreateThingGroupOutput) SetThingGroupId ¶ added in v1.12.36

func (s *CreateThingGroupOutput) SetThingGroupId(v string) *CreateThingGroupOutput

SetThingGroupId sets the ThingGroupId field's value.

func (*CreateThingGroupOutput) SetThingGroupName ¶ added in v1.12.36

func (s *CreateThingGroupOutput) SetThingGroupName(v string) *CreateThingGroupOutput

SetThingGroupName sets the ThingGroupName field's value.

func (CreateThingGroupOutput) String ¶ added in v1.12.36

func (s CreateThingGroupOutput) 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 thing ID.
	ThingId *string `locationName:"thingId" 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) SetThingId ¶ added in v1.12.36

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

SetThingId sets the ThingId 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 thing type ID.
	ThingTypeId *string `locationName:"thingTypeId" 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) SetThingTypeId ¶ added in v1.12.36

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

SetThingTypeId sets the ThingTypeId 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 CustomCodeSigning ¶ added in v1.12.51

type CustomCodeSigning struct {

	// The certificate chain.
	CertificateChain *CodeSigningCertificateChain `locationName:"certificateChain" type:"structure"`

	// The hash algorithm used to code sign the file.
	HashAlgorithm *string `locationName:"hashAlgorithm" type:"string"`

	// The signature for the file.
	Signature *CodeSigningSignature `locationName:"signature" type:"structure"`

	// The signature algorithm used to code sign the file.
	SignatureAlgorithm *string `locationName:"signatureAlgorithm" type:"string"`
	// contains filtered or unexported fields
}

Describes a custom method used to code sign a file.

func (CustomCodeSigning) GoString ¶ added in v1.12.51

func (s CustomCodeSigning) GoString() string

GoString returns the string representation

func (*CustomCodeSigning) SetCertificateChain ¶ added in v1.12.51

SetCertificateChain sets the CertificateChain field's value.

func (*CustomCodeSigning) SetHashAlgorithm ¶ added in v1.12.51

func (s *CustomCodeSigning) SetHashAlgorithm(v string) *CustomCodeSigning

SetHashAlgorithm sets the HashAlgorithm field's value.

func (*CustomCodeSigning) SetSignature ¶ added in v1.12.51

SetSignature sets the Signature field's value.

func (*CustomCodeSigning) SetSignatureAlgorithm ¶ added in v1.12.51

func (s *CustomCodeSigning) SetSignatureAlgorithm(v string) *CustomCodeSigning

SetSignatureAlgorithm sets the SignatureAlgorithm field's value.

func (CustomCodeSigning) String ¶ added in v1.12.51

func (s CustomCodeSigning) String() string

String returns the string representation

func (*CustomCodeSigning) Validate ¶ added in v1.12.51

func (s *CustomCodeSigning) Validate() error

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

type DeleteAuthorizerInput ¶ added in v1.12.36

type DeleteAuthorizerInput struct {

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

func (DeleteAuthorizerInput) GoString ¶ added in v1.12.36

func (s DeleteAuthorizerInput) GoString() string

GoString returns the string representation

func (*DeleteAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

func (s *DeleteAuthorizerInput) SetAuthorizerName(v string) *DeleteAuthorizerInput

SetAuthorizerName sets the AuthorizerName field's value.

func (DeleteAuthorizerInput) String ¶ added in v1.12.36

func (s DeleteAuthorizerInput) String() string

String returns the string representation

func (*DeleteAuthorizerInput) Validate ¶ added in v1.12.36

func (s *DeleteAuthorizerInput) Validate() error

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

type DeleteAuthorizerOutput ¶ added in v1.12.36

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

func (DeleteAuthorizerOutput) GoString ¶ added in v1.12.36

func (s DeleteAuthorizerOutput) GoString() string

GoString returns the string representation

func (DeleteAuthorizerOutput) String ¶ added in v1.12.36

func (s DeleteAuthorizerOutput) String() string

String returns the string representation

type DeleteCACertificateInput ¶ added in v1.1.18

type DeleteCACertificateInput struct {

	// The ID of the certificate to delete. (The last part of the certificate ARN
	// contains the certificate ID.)
	//
	// 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// CertificateId is a required field
	CertificateId *string `location:"uri" locationName:"certificateId" min:"64" type:"string" required:"true"`

	// Forces a certificate request to be deleted.
	ForceDelete *bool `location:"querystring" locationName:"forceDelete" type:"boolean"`
	// 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) SetForceDelete ¶ added in v1.12.36

func (s *DeleteCertificateInput) SetForceDelete(v bool) *DeleteCertificateInput

SetForceDelete sets the ForceDelete 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 DeleteJobExecutionInput ¶ added in v1.13.52

type DeleteJobExecutionInput struct {

	// The ID of the job execution to be deleted. The executionNumber refers to
	// the execution of a particular job on a particular device.
	//
	// Note that once a job execution is deleted, the executionNumber may be reused
	// by IoT, so be sure you get and use the correct value here.
	//
	// ExecutionNumber is a required field
	ExecutionNumber *int64 `location:"uri" locationName:"executionNumber" type:"long" required:"true"`

	// (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
	// Otherwise, you can only delete a job execution which is in a terminal state
	// ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception
	// will occur. The default is false.
	//
	// Deleting a job execution which is "IN_PROGRESS", will cause the device to
	// be unable to access job information or update the job execution status. Use
	// caution and ensure that the device is able to recover to a valid state.
	Force *bool `location:"querystring" locationName:"force" type:"boolean"`

	// The ID of the job whose execution on a particular device will be deleted.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// The name of the thing whose job execution will be deleted.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJobExecutionInput) GoString ¶ added in v1.13.52

func (s DeleteJobExecutionInput) GoString() string

GoString returns the string representation

func (*DeleteJobExecutionInput) SetExecutionNumber ¶ added in v1.13.52

func (s *DeleteJobExecutionInput) SetExecutionNumber(v int64) *DeleteJobExecutionInput

SetExecutionNumber sets the ExecutionNumber field's value.

func (*DeleteJobExecutionInput) SetForce ¶ added in v1.13.52

SetForce sets the Force field's value.

func (*DeleteJobExecutionInput) SetJobId ¶ added in v1.13.52

SetJobId sets the JobId field's value.

func (*DeleteJobExecutionInput) SetThingName ¶ added in v1.13.52

SetThingName sets the ThingName field's value.

func (DeleteJobExecutionInput) String ¶ added in v1.13.52

func (s DeleteJobExecutionInput) String() string

String returns the string representation

func (*DeleteJobExecutionInput) Validate ¶ added in v1.13.52

func (s *DeleteJobExecutionInput) Validate() error

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

type DeleteJobExecutionOutput ¶ added in v1.13.52

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

func (DeleteJobExecutionOutput) GoString ¶ added in v1.13.52

func (s DeleteJobExecutionOutput) GoString() string

GoString returns the string representation

func (DeleteJobExecutionOutput) String ¶ added in v1.13.52

func (s DeleteJobExecutionOutput) String() string

String returns the string representation

type DeleteJobInput ¶ added in v1.13.52

type DeleteJobInput struct {

	// (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise,
	// you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED")
	// or an exception will occur. The default is false.
	//
	// Deleting a job which is "IN_PROGRESS", will cause a device which is executing
	// the job to be unable to access job information or update the job execution
	// status. Use caution and ensure that each device executing a job which is
	// deleted is able to recover to a valid state.
	Force *bool `location:"querystring" locationName:"force" type:"boolean"`

	// The ID of the job to be deleted.
	//
	// After a job deletion is completed, you may reuse this jobId when you create
	// a new job. However, this is not recommended, and you must ensure that your
	// devices are not using the jobId to refer to the deleted job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJobInput) GoString ¶ added in v1.13.52

func (s DeleteJobInput) GoString() string

GoString returns the string representation

func (*DeleteJobInput) SetForce ¶ added in v1.13.52

func (s *DeleteJobInput) SetForce(v bool) *DeleteJobInput

SetForce sets the Force field's value.

func (*DeleteJobInput) SetJobId ¶ added in v1.13.52

func (s *DeleteJobInput) SetJobId(v string) *DeleteJobInput

SetJobId sets the JobId field's value.

func (DeleteJobInput) String ¶ added in v1.13.52

func (s DeleteJobInput) String() string

String returns the string representation

func (*DeleteJobInput) Validate ¶ added in v1.13.52

func (s *DeleteJobInput) Validate() error

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

type DeleteJobOutput ¶ added in v1.13.52

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

func (DeleteJobOutput) GoString ¶ added in v1.13.52

func (s DeleteJobOutput) GoString() string

GoString returns the string representation

func (DeleteJobOutput) String ¶ added in v1.13.52

func (s DeleteJobOutput) String() string

String returns the string representation

type DeleteOTAUpdateInput ¶ added in v1.12.51

type DeleteOTAUpdateInput struct {

	// The OTA update ID to delete.
	//
	// OtaUpdateId is a required field
	OtaUpdateId *string `location:"uri" locationName:"otaUpdateId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteOTAUpdateInput) GoString ¶ added in v1.12.51

func (s DeleteOTAUpdateInput) GoString() string

GoString returns the string representation

func (*DeleteOTAUpdateInput) SetOtaUpdateId ¶ added in v1.12.51

func (s *DeleteOTAUpdateInput) SetOtaUpdateId(v string) *DeleteOTAUpdateInput

SetOtaUpdateId sets the OtaUpdateId field's value.

func (DeleteOTAUpdateInput) String ¶ added in v1.12.51

func (s DeleteOTAUpdateInput) String() string

String returns the string representation

func (*DeleteOTAUpdateInput) Validate ¶ added in v1.12.51

func (s *DeleteOTAUpdateInput) Validate() error

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

type DeleteOTAUpdateOutput ¶ added in v1.12.51

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

func (DeleteOTAUpdateOutput) GoString ¶ added in v1.12.51

func (s DeleteOTAUpdateOutput) GoString() string

GoString returns the string representation

func (DeleteOTAUpdateOutput) String ¶ added in v1.12.51

func (s DeleteOTAUpdateOutput) 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 DeleteRoleAliasInput ¶ added in v1.12.36

type DeleteRoleAliasInput struct {

	// The role alias to delete.
	//
	// RoleAlias is a required field
	RoleAlias *string `location:"uri" locationName:"roleAlias" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRoleAliasInput) GoString ¶ added in v1.12.36

func (s DeleteRoleAliasInput) GoString() string

GoString returns the string representation

func (*DeleteRoleAliasInput) SetRoleAlias ¶ added in v1.12.36

func (s *DeleteRoleAliasInput) SetRoleAlias(v string) *DeleteRoleAliasInput

SetRoleAlias sets the RoleAlias field's value.

func (DeleteRoleAliasInput) String ¶ added in v1.12.36

func (s DeleteRoleAliasInput) String() string

String returns the string representation

func (*DeleteRoleAliasInput) Validate ¶ added in v1.12.36

func (s *DeleteRoleAliasInput) Validate() error

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

type DeleteRoleAliasOutput ¶ added in v1.12.36

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

func (DeleteRoleAliasOutput) GoString ¶ added in v1.12.36

func (s DeleteRoleAliasOutput) GoString() string

GoString returns the string representation

func (DeleteRoleAliasOutput) String ¶ added in v1.12.36

func (s DeleteRoleAliasOutput) String() string

String returns the string representation

type DeleteStreamInput ¶ added in v1.12.51

type DeleteStreamInput struct {

	// The stream ID.
	//
	// StreamId is a required field
	StreamId *string `location:"uri" locationName:"streamId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStreamInput) GoString ¶ added in v1.12.51

func (s DeleteStreamInput) GoString() string

GoString returns the string representation

func (*DeleteStreamInput) SetStreamId ¶ added in v1.12.51

func (s *DeleteStreamInput) SetStreamId(v string) *DeleteStreamInput

SetStreamId sets the StreamId field's value.

func (DeleteStreamInput) String ¶ added in v1.12.51

func (s DeleteStreamInput) String() string

String returns the string representation

func (*DeleteStreamInput) Validate ¶ added in v1.12.51

func (s *DeleteStreamInput) Validate() error

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

type DeleteStreamOutput ¶ added in v1.12.51

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

func (DeleteStreamOutput) GoString ¶ added in v1.12.51

func (s DeleteStreamOutput) GoString() string

GoString returns the string representation

func (DeleteStreamOutput) String ¶ added in v1.12.51

func (s DeleteStreamOutput) String() string

String returns the string representation

type DeleteThingGroupInput ¶ added in v1.12.36

type DeleteThingGroupInput struct {

	// The expected version of the thing group to delete.
	ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"`

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

func (DeleteThingGroupInput) GoString ¶ added in v1.12.36

func (s DeleteThingGroupInput) GoString() string

GoString returns the string representation

func (*DeleteThingGroupInput) SetExpectedVersion ¶ added in v1.12.36

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*DeleteThingGroupInput) SetThingGroupName ¶ added in v1.12.36

func (s *DeleteThingGroupInput) SetThingGroupName(v string) *DeleteThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (DeleteThingGroupInput) String ¶ added in v1.12.36

func (s DeleteThingGroupInput) String() string

String returns the string representation

func (*DeleteThingGroupInput) Validate ¶ added in v1.12.36

func (s *DeleteThingGroupInput) Validate() error

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

type DeleteThingGroupOutput ¶ added in v1.12.36

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

func (DeleteThingGroupOutput) GoString ¶ added in v1.12.36

func (s DeleteThingGroupOutput) GoString() string

GoString returns the string representation

func (DeleteThingGroupOutput) String ¶ added in v1.12.36

func (s DeleteThingGroupOutput) String() string

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 DeleteV2LoggingLevelInput ¶ added in v1.12.36

type DeleteV2LoggingLevelInput struct {

	// The name of the resource for which you are configuring logging.
	//
	// TargetName is a required field
	TargetName *string `location:"querystring" locationName:"targetName" type:"string" required:"true"`

	// The type of resource for which you are configuring logging. Must be THING_Group.
	//
	// TargetType is a required field
	TargetType *string `location:"querystring" locationName:"targetType" type:"string" required:"true" enum:"LogTargetType"`
	// contains filtered or unexported fields
}

func (DeleteV2LoggingLevelInput) GoString ¶ added in v1.12.36

func (s DeleteV2LoggingLevelInput) GoString() string

GoString returns the string representation

func (*DeleteV2LoggingLevelInput) SetTargetName ¶ added in v1.12.36

SetTargetName sets the TargetName field's value.

func (*DeleteV2LoggingLevelInput) SetTargetType ¶ added in v1.12.36

SetTargetType sets the TargetType field's value.

func (DeleteV2LoggingLevelInput) String ¶ added in v1.12.36

func (s DeleteV2LoggingLevelInput) String() string

String returns the string representation

func (*DeleteV2LoggingLevelInput) Validate ¶ added in v1.12.36

func (s *DeleteV2LoggingLevelInput) Validate() error

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

type DeleteV2LoggingLevelOutput ¶ added in v1.12.36

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

func (DeleteV2LoggingLevelOutput) GoString ¶ added in v1.12.36

func (s DeleteV2LoggingLevelOutput) GoString() string

GoString returns the string representation

func (DeleteV2LoggingLevelOutput) String ¶ added in v1.12.36

String returns the string representation

type Denied ¶ added in v1.12.36

type Denied struct {

	// Information that explicitly denies the authorization.
	ExplicitDeny *ExplicitDeny `locationName:"explicitDeny" type:"structure"`

	// Information that implicitly denies the authorization. When a policy doesn't
	// explicitly deny or allow an action on a resource it is considered an implicit
	// deny.
	ImplicitDeny *ImplicitDeny `locationName:"implicitDeny" type:"structure"`
	// contains filtered or unexported fields
}

Contains information that denied the authorization.

func (Denied) GoString ¶ added in v1.12.36

func (s Denied) GoString() string

GoString returns the string representation

func (*Denied) SetExplicitDeny ¶ added in v1.12.36

func (s *Denied) SetExplicitDeny(v *ExplicitDeny) *Denied

SetExplicitDeny sets the ExplicitDeny field's value.

func (*Denied) SetImplicitDeny ¶ added in v1.12.36

func (s *Denied) SetImplicitDeny(v *ImplicitDeny) *Denied

SetImplicitDeny sets the ImplicitDeny field's value.

func (Denied) String ¶ added in v1.12.36

func (s Denied) 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 DescribeAuthorizerInput ¶ added in v1.12.36

type DescribeAuthorizerInput struct {

	// The name of the authorizer to describe.
	//
	// AuthorizerName is a required field
	AuthorizerName *string `location:"uri" locationName:"authorizerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAuthorizerInput) GoString ¶ added in v1.12.36

func (s DescribeAuthorizerInput) GoString() string

GoString returns the string representation

func (*DescribeAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

func (s *DescribeAuthorizerInput) SetAuthorizerName(v string) *DescribeAuthorizerInput

SetAuthorizerName sets the AuthorizerName field's value.

func (DescribeAuthorizerInput) String ¶ added in v1.12.36

func (s DescribeAuthorizerInput) String() string

String returns the string representation

func (*DescribeAuthorizerInput) Validate ¶ added in v1.12.36

func (s *DescribeAuthorizerInput) Validate() error

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

type DescribeAuthorizerOutput ¶ added in v1.12.36

type DescribeAuthorizerOutput struct {

	// The authorizer description.
	AuthorizerDescription *AuthorizerDescription `locationName:"authorizerDescription" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAuthorizerOutput) GoString ¶ added in v1.12.36

func (s DescribeAuthorizerOutput) GoString() string

GoString returns the string representation

func (*DescribeAuthorizerOutput) SetAuthorizerDescription ¶ added in v1.12.36

SetAuthorizerDescription sets the AuthorizerDescription field's value.

func (DescribeAuthorizerOutput) String ¶ added in v1.12.36

func (s DescribeAuthorizerOutput) 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"`

	// Information about the registration configuration.
	RegistrationConfig *RegistrationConfig `locationName:"registrationConfig" 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) SetRegistrationConfig ¶ added in v1.12.36

SetRegistrationConfig sets the RegistrationConfig 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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 DescribeDefaultAuthorizerInput ¶ added in v1.12.36

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

func (DescribeDefaultAuthorizerInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (DescribeDefaultAuthorizerInput) String ¶ added in v1.12.36

String returns the string representation

type DescribeDefaultAuthorizerOutput ¶ added in v1.12.36

type DescribeDefaultAuthorizerOutput struct {

	// The default authorizer's description.
	AuthorizerDescription *AuthorizerDescription `locationName:"authorizerDescription" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDefaultAuthorizerOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*DescribeDefaultAuthorizerOutput) SetAuthorizerDescription ¶ added in v1.12.36

SetAuthorizerDescription sets the AuthorizerDescription field's value.

func (DescribeDefaultAuthorizerOutput) String ¶ added in v1.12.36

String returns the string representation

type DescribeEndpointInput ¶

type DescribeEndpointInput struct {

	// The endpoint type.
	EndpointType *string `location:"querystring" locationName:"endpointType" type:"string"`
	// 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) SetEndpointType ¶ added in v1.12.36

func (s *DescribeEndpointInput) SetEndpointType(v string) *DescribeEndpointInput

SetEndpointType sets the EndpointType field's value.

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 DescribeEventConfigurationsInput ¶ added in v1.12.36

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

func (DescribeEventConfigurationsInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (DescribeEventConfigurationsInput) String ¶ added in v1.12.36

String returns the string representation

type DescribeEventConfigurationsOutput ¶ added in v1.12.36

type DescribeEventConfigurationsOutput struct {

	// The creation date of the event configuration.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The event configurations.
	EventConfigurations map[string]*Configuration `locationName:"eventConfigurations" type:"map"`

	// The date the event configurations were last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

func (DescribeEventConfigurationsOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*DescribeEventConfigurationsOutput) SetCreationDate ¶ added in v1.12.36

SetCreationDate sets the CreationDate field's value.

func (*DescribeEventConfigurationsOutput) SetEventConfigurations ¶ added in v1.12.36

SetEventConfigurations sets the EventConfigurations field's value.

func (*DescribeEventConfigurationsOutput) SetLastModifiedDate ¶ added in v1.12.36

SetLastModifiedDate sets the LastModifiedDate field's value.

func (DescribeEventConfigurationsOutput) String ¶ added in v1.12.36

String returns the string representation

type DescribeIndexInput ¶ added in v1.12.36

type DescribeIndexInput struct {

	// The index name.
	//
	// IndexName is a required field
	IndexName *string `location:"uri" locationName:"indexName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeIndexInput) GoString ¶ added in v1.12.36

func (s DescribeIndexInput) GoString() string

GoString returns the string representation

func (*DescribeIndexInput) SetIndexName ¶ added in v1.12.36

func (s *DescribeIndexInput) SetIndexName(v string) *DescribeIndexInput

SetIndexName sets the IndexName field's value.

func (DescribeIndexInput) String ¶ added in v1.12.36

func (s DescribeIndexInput) String() string

String returns the string representation

func (*DescribeIndexInput) Validate ¶ added in v1.12.36

func (s *DescribeIndexInput) Validate() error

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

type DescribeIndexOutput ¶ added in v1.12.36

type DescribeIndexOutput struct {

	// The index name.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

	// The index status.
	IndexStatus *string `locationName:"indexStatus" type:"string" enum:"IndexStatus"`

	// Contains a value that specifies the type of indexing performed. Valid values
	// are:
	//
	// REGISTRY – Your thing index will contain only registry data.
	//
	// REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
	Schema *string `locationName:"schema" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeIndexOutput) GoString ¶ added in v1.12.36

func (s DescribeIndexOutput) GoString() string

GoString returns the string representation

func (*DescribeIndexOutput) SetIndexName ¶ added in v1.12.36

func (s *DescribeIndexOutput) SetIndexName(v string) *DescribeIndexOutput

SetIndexName sets the IndexName field's value.

func (*DescribeIndexOutput) SetIndexStatus ¶ added in v1.12.36

func (s *DescribeIndexOutput) SetIndexStatus(v string) *DescribeIndexOutput

SetIndexStatus sets the IndexStatus field's value.

func (*DescribeIndexOutput) SetSchema ¶ added in v1.12.36

SetSchema sets the Schema field's value.

func (DescribeIndexOutput) String ¶ added in v1.12.36

func (s DescribeIndexOutput) String() string

String returns the string representation

type DescribeJobExecutionInput ¶ added in v1.12.36

type DescribeJobExecutionInput struct {

	// A string (consisting of the digits "0" through "9" which is used to specify
	// a particular job execution on a particular device.
	ExecutionNumber *int64 `location:"querystring" locationName:"executionNumber" type:"long"`

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// The name of the thing on which the job execution is running.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeJobExecutionInput) GoString ¶ added in v1.12.36

func (s DescribeJobExecutionInput) GoString() string

GoString returns the string representation

func (*DescribeJobExecutionInput) SetExecutionNumber ¶ added in v1.12.36

func (s *DescribeJobExecutionInput) SetExecutionNumber(v int64) *DescribeJobExecutionInput

SetExecutionNumber sets the ExecutionNumber field's value.

func (*DescribeJobExecutionInput) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (*DescribeJobExecutionInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (DescribeJobExecutionInput) String ¶ added in v1.12.36

func (s DescribeJobExecutionInput) String() string

String returns the string representation

func (*DescribeJobExecutionInput) Validate ¶ added in v1.12.36

func (s *DescribeJobExecutionInput) Validate() error

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

type DescribeJobExecutionOutput ¶ added in v1.12.36

type DescribeJobExecutionOutput struct {

	// Information about the job execution.
	Execution *JobExecution `locationName:"execution" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeJobExecutionOutput) GoString ¶ added in v1.12.36

func (s DescribeJobExecutionOutput) GoString() string

GoString returns the string representation

func (*DescribeJobExecutionOutput) SetExecution ¶ added in v1.12.36

SetExecution sets the Execution field's value.

func (DescribeJobExecutionOutput) String ¶ added in v1.12.36

String returns the string representation

type DescribeJobInput ¶ added in v1.12.36

type DescribeJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeJobInput) GoString ¶ added in v1.12.36

func (s DescribeJobInput) GoString() string

GoString returns the string representation

func (*DescribeJobInput) SetJobId ¶ added in v1.12.36

func (s *DescribeJobInput) SetJobId(v string) *DescribeJobInput

SetJobId sets the JobId field's value.

func (DescribeJobInput) String ¶ added in v1.12.36

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate ¶ added in v1.12.36

func (s *DescribeJobInput) Validate() error

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

type DescribeJobOutput ¶ added in v1.12.36

type DescribeJobOutput struct {

	// An S3 link to the job document.
	DocumentSource *string `locationName:"documentSource" min:"1" type:"string"`

	// Information about the job.
	Job *Job `locationName:"job" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeJobOutput) GoString ¶ added in v1.12.36

func (s DescribeJobOutput) GoString() string

GoString returns the string representation

func (*DescribeJobOutput) SetDocumentSource ¶ added in v1.12.36

func (s *DescribeJobOutput) SetDocumentSource(v string) *DescribeJobOutput

SetDocumentSource sets the DocumentSource field's value.

func (*DescribeJobOutput) SetJob ¶ added in v1.12.36

func (s *DescribeJobOutput) SetJob(v *Job) *DescribeJobOutput

SetJob sets the Job field's value.

func (DescribeJobOutput) String ¶ added in v1.12.36

func (s DescribeJobOutput) String() string

String returns the string representation

type DescribeRoleAliasInput ¶ added in v1.12.36

type DescribeRoleAliasInput struct {

	// The role alias to describe.
	//
	// RoleAlias is a required field
	RoleAlias *string `location:"uri" locationName:"roleAlias" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRoleAliasInput) GoString ¶ added in v1.12.36

func (s DescribeRoleAliasInput) GoString() string

GoString returns the string representation

func (*DescribeRoleAliasInput) SetRoleAlias ¶ added in v1.12.36

SetRoleAlias sets the RoleAlias field's value.

func (DescribeRoleAliasInput) String ¶ added in v1.12.36

func (s DescribeRoleAliasInput) String() string

String returns the string representation

func (*DescribeRoleAliasInput) Validate ¶ added in v1.12.36

func (s *DescribeRoleAliasInput) Validate() error

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

type DescribeRoleAliasOutput ¶ added in v1.12.36

type DescribeRoleAliasOutput struct {

	// The role alias description.
	RoleAliasDescription *RoleAliasDescription `locationName:"roleAliasDescription" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeRoleAliasOutput) GoString ¶ added in v1.12.36

func (s DescribeRoleAliasOutput) GoString() string

GoString returns the string representation

func (*DescribeRoleAliasOutput) SetRoleAliasDescription ¶ added in v1.12.36

SetRoleAliasDescription sets the RoleAliasDescription field's value.

func (DescribeRoleAliasOutput) String ¶ added in v1.12.36

func (s DescribeRoleAliasOutput) String() string

String returns the string representation

type DescribeStreamInput ¶ added in v1.12.51

type DescribeStreamInput struct {

	// The stream ID.
	//
	// StreamId is a required field
	StreamId *string `location:"uri" locationName:"streamId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStreamInput) GoString ¶ added in v1.12.51

func (s DescribeStreamInput) GoString() string

GoString returns the string representation

func (*DescribeStreamInput) SetStreamId ¶ added in v1.12.51

func (s *DescribeStreamInput) SetStreamId(v string) *DescribeStreamInput

SetStreamId sets the StreamId field's value.

func (DescribeStreamInput) String ¶ added in v1.12.51

func (s DescribeStreamInput) String() string

String returns the string representation

func (*DescribeStreamInput) Validate ¶ added in v1.12.51

func (s *DescribeStreamInput) Validate() error

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

type DescribeStreamOutput ¶ added in v1.12.51

type DescribeStreamOutput struct {

	// Information about the stream.
	StreamInfo *StreamInfo `locationName:"streamInfo" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStreamOutput) GoString ¶ added in v1.12.51

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation

func (*DescribeStreamOutput) SetStreamInfo ¶ added in v1.12.51

SetStreamInfo sets the StreamInfo field's value.

func (DescribeStreamOutput) String ¶ added in v1.12.51

func (s DescribeStreamOutput) String() string

String returns the string representation

type DescribeThingGroupInput ¶ added in v1.12.36

type DescribeThingGroupInput struct {

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

func (DescribeThingGroupInput) GoString ¶ added in v1.12.36

func (s DescribeThingGroupInput) GoString() string

GoString returns the string representation

func (*DescribeThingGroupInput) SetThingGroupName ¶ added in v1.12.36

func (s *DescribeThingGroupInput) SetThingGroupName(v string) *DescribeThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (DescribeThingGroupInput) String ¶ added in v1.12.36

func (s DescribeThingGroupInput) String() string

String returns the string representation

func (*DescribeThingGroupInput) Validate ¶ added in v1.12.36

func (s *DescribeThingGroupInput) Validate() error

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

type DescribeThingGroupOutput ¶ added in v1.12.36

type DescribeThingGroupOutput struct {

	// The thing group ARN.
	ThingGroupArn *string `locationName:"thingGroupArn" type:"string"`

	// The thing group ID.
	ThingGroupId *string `locationName:"thingGroupId" min:"1" type:"string"`

	// Thing group metadata.
	ThingGroupMetadata *ThingGroupMetadata `locationName:"thingGroupMetadata" type:"structure"`

	// The name of the thing group.
	ThingGroupName *string `locationName:"thingGroupName" min:"1" type:"string"`

	// The thing group properties.
	ThingGroupProperties *ThingGroupProperties `locationName:"thingGroupProperties" type:"structure"`

	// The version of the thing group.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (DescribeThingGroupOutput) GoString ¶ added in v1.12.36

func (s DescribeThingGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeThingGroupOutput) SetThingGroupArn ¶ added in v1.12.36

SetThingGroupArn sets the ThingGroupArn field's value.

func (*DescribeThingGroupOutput) SetThingGroupId ¶ added in v1.12.36

SetThingGroupId sets the ThingGroupId field's value.

func (*DescribeThingGroupOutput) SetThingGroupMetadata ¶ added in v1.12.36

SetThingGroupMetadata sets the ThingGroupMetadata field's value.

func (*DescribeThingGroupOutput) SetThingGroupName ¶ added in v1.12.36

func (s *DescribeThingGroupOutput) SetThingGroupName(v string) *DescribeThingGroupOutput

SetThingGroupName sets the ThingGroupName field's value.

func (*DescribeThingGroupOutput) SetThingGroupProperties ¶ added in v1.12.36

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (*DescribeThingGroupOutput) SetVersion ¶ added in v1.12.36

SetVersion sets the Version field's value.

func (DescribeThingGroupOutput) String ¶ added in v1.12.36

func (s DescribeThingGroupOutput) 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 ARN of the thing to describe.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The ID of the thing to describe.
	ThingId *string `locationName:"thingId" 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) SetThingArn ¶ added in v1.12.36

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

SetThingArn sets the ThingArn field's value.

func (*DescribeThingOutput) SetThingId ¶ added in v1.12.36

SetThingId sets the ThingId 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 DescribeThingRegistrationTaskInput ¶ added in v1.12.36

type DescribeThingRegistrationTaskInput struct {

	// The task ID.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeThingRegistrationTaskInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*DescribeThingRegistrationTaskInput) SetTaskId ¶ added in v1.12.36

SetTaskId sets the TaskId field's value.

func (DescribeThingRegistrationTaskInput) String ¶ added in v1.12.36

String returns the string representation

func (*DescribeThingRegistrationTaskInput) Validate ¶ added in v1.12.36

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

type DescribeThingRegistrationTaskOutput ¶ added in v1.12.36

type DescribeThingRegistrationTaskOutput struct {

	// The task creation date.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The number of things that failed to be provisioned.
	FailureCount *int64 `locationName:"failureCount" type:"integer"`

	// The S3 bucket that contains the input file.
	InputFileBucket *string `locationName:"inputFileBucket" min:"3" type:"string"`

	// The input file key.
	InputFileKey *string `locationName:"inputFileKey" min:"1" type:"string"`

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

	// The message.
	Message *string `locationName:"message" type:"string"`

	// The progress of the bulk provisioning task expressed as a percentage.
	PercentageProgress *int64 `locationName:"percentageProgress" type:"integer"`

	// The role ARN that grants access to the input file bucket.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`

	// The status of the bulk thing provisioning task.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// The number of things successfully provisioned.
	SuccessCount *int64 `locationName:"successCount" type:"integer"`

	// The task ID.
	TaskId *string `locationName:"taskId" type:"string"`

	// The task's template.
	TemplateBody *string `locationName:"templateBody" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeThingRegistrationTaskOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*DescribeThingRegistrationTaskOutput) SetCreationDate ¶ added in v1.12.36

SetCreationDate sets the CreationDate field's value.

func (*DescribeThingRegistrationTaskOutput) SetFailureCount ¶ added in v1.12.36

SetFailureCount sets the FailureCount field's value.

func (*DescribeThingRegistrationTaskOutput) SetInputFileBucket ¶ added in v1.12.36

SetInputFileBucket sets the InputFileBucket field's value.

func (*DescribeThingRegistrationTaskOutput) SetInputFileKey ¶ added in v1.12.36

SetInputFileKey sets the InputFileKey field's value.

func (*DescribeThingRegistrationTaskOutput) SetLastModifiedDate ¶ added in v1.12.36

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeThingRegistrationTaskOutput) SetMessage ¶ added in v1.12.36

SetMessage sets the Message field's value.

func (*DescribeThingRegistrationTaskOutput) SetPercentageProgress ¶ added in v1.12.36

SetPercentageProgress sets the PercentageProgress field's value.

func (*DescribeThingRegistrationTaskOutput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (*DescribeThingRegistrationTaskOutput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (*DescribeThingRegistrationTaskOutput) SetSuccessCount ¶ added in v1.12.36

SetSuccessCount sets the SuccessCount field's value.

func (*DescribeThingRegistrationTaskOutput) SetTaskId ¶ added in v1.12.36

SetTaskId sets the TaskId field's value.

func (*DescribeThingRegistrationTaskOutput) SetTemplateBody ¶ added in v1.12.36

SetTemplateBody sets the TemplateBody field's value.

func (DescribeThingRegistrationTaskOutput) String ¶ added in v1.12.36

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 thing type ARN.
	ThingTypeArn *string `locationName:"thingTypeArn" type:"string"`

	// The thing type ID.
	ThingTypeId *string `locationName:"thingTypeId" type:"string"`

	// 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 it 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) SetThingTypeArn ¶ added in v1.12.36

SetThingTypeArn sets the ThingTypeArn field's value.

func (*DescribeThingTypeOutput) SetThingTypeId ¶ added in v1.12.36

SetThingTypeId sets the ThingTypeId field's value.

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 DetachPolicyInput ¶ added in v1.12.36

type DetachPolicyInput struct {

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

	// The target from which the policy will be detached.
	//
	// Target is a required field
	Target *string `locationName:"target" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachPolicyInput) GoString ¶ added in v1.12.36

func (s DetachPolicyInput) GoString() string

GoString returns the string representation

func (*DetachPolicyInput) SetPolicyName ¶ added in v1.12.36

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

SetPolicyName sets the PolicyName field's value.

func (*DetachPolicyInput) SetTarget ¶ added in v1.12.36

func (s *DetachPolicyInput) SetTarget(v string) *DetachPolicyInput

SetTarget sets the Target field's value.

func (DetachPolicyInput) String ¶ added in v1.12.36

func (s DetachPolicyInput) String() string

String returns the string representation

func (*DetachPolicyInput) Validate ¶ added in v1.12.36

func (s *DetachPolicyInput) Validate() error

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

type DetachPolicyOutput ¶ added in v1.12.36

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

func (DetachPolicyOutput) GoString ¶ added in v1.12.36

func (s DetachPolicyOutput) GoString() string

GoString returns the string representation

func (DetachPolicyOutput) String ¶ added in v1.12.36

func (s DetachPolicyOutput) 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 EffectivePolicy ¶ added in v1.12.36

type EffectivePolicy struct {

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

	// The IAM policy document.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

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

The policy that has the effect on the authorization results.

func (EffectivePolicy) GoString ¶ added in v1.12.36

func (s EffectivePolicy) GoString() string

GoString returns the string representation

func (*EffectivePolicy) SetPolicyArn ¶ added in v1.12.36

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

SetPolicyArn sets the PolicyArn field's value.

func (*EffectivePolicy) SetPolicyDocument ¶ added in v1.12.36

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

SetPolicyDocument sets the PolicyDocument field's value.

func (*EffectivePolicy) SetPolicyName ¶ added in v1.12.36

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

SetPolicyName sets the PolicyName field's value.

func (EffectivePolicy) String ¶ added in v1.12.36

func (s EffectivePolicy) String() string

String returns the string representation

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 ErrorInfo ¶ added in v1.12.51

type ErrorInfo struct {

	// The error code.
	Code *string `locationName:"code" type:"string"`

	// The error message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Error information.

func (ErrorInfo) GoString ¶ added in v1.12.51

func (s ErrorInfo) GoString() string

GoString returns the string representation

func (*ErrorInfo) SetCode ¶ added in v1.12.51

func (s *ErrorInfo) SetCode(v string) *ErrorInfo

SetCode sets the Code field's value.

func (*ErrorInfo) SetMessage ¶ added in v1.12.51

func (s *ErrorInfo) SetMessage(v string) *ErrorInfo

SetMessage sets the Message field's value.

func (ErrorInfo) String ¶ added in v1.12.51

func (s ErrorInfo) String() string

String returns the string representation

type ExplicitDeny ¶ added in v1.12.36

type ExplicitDeny struct {

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

Information that explicitly denies authorization.

func (ExplicitDeny) GoString ¶ added in v1.12.36

func (s ExplicitDeny) GoString() string

GoString returns the string representation

func (*ExplicitDeny) SetPolicies ¶ added in v1.12.36

func (s *ExplicitDeny) SetPolicies(v []*Policy) *ExplicitDeny

SetPolicies sets the Policies field's value.

func (ExplicitDeny) String ¶ added in v1.12.36

func (s ExplicitDeny) 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 Firehose 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 GetEffectivePoliciesInput ¶ added in v1.12.36

type GetEffectivePoliciesInput struct {

	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string `locationName:"cognitoIdentityPoolId" type:"string"`

	// The principal.
	Principal *string `locationName:"principal" type:"string"`

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

func (GetEffectivePoliciesInput) GoString ¶ added in v1.12.36

func (s GetEffectivePoliciesInput) GoString() string

GoString returns the string representation

func (*GetEffectivePoliciesInput) SetCognitoIdentityPoolId ¶ added in v1.12.36

func (s *GetEffectivePoliciesInput) SetCognitoIdentityPoolId(v string) *GetEffectivePoliciesInput

SetCognitoIdentityPoolId sets the CognitoIdentityPoolId field's value.

func (*GetEffectivePoliciesInput) SetPrincipal ¶ added in v1.12.36

SetPrincipal sets the Principal field's value.

func (*GetEffectivePoliciesInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (GetEffectivePoliciesInput) String ¶ added in v1.12.36

func (s GetEffectivePoliciesInput) String() string

String returns the string representation

func (*GetEffectivePoliciesInput) Validate ¶ added in v1.12.36

func (s *GetEffectivePoliciesInput) Validate() error

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

type GetEffectivePoliciesOutput ¶ added in v1.12.36

type GetEffectivePoliciesOutput struct {

	// The effective policies.
	EffectivePolicies []*EffectivePolicy `locationName:"effectivePolicies" type:"list"`
	// contains filtered or unexported fields
}

func (GetEffectivePoliciesOutput) GoString ¶ added in v1.12.36

func (s GetEffectivePoliciesOutput) GoString() string

GoString returns the string representation

func (*GetEffectivePoliciesOutput) SetEffectivePolicies ¶ added in v1.12.36

SetEffectivePolicies sets the EffectivePolicies field's value.

func (GetEffectivePoliciesOutput) String ¶ added in v1.12.36

String returns the string representation

type GetIndexingConfigurationInput ¶ added in v1.12.36

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

func (GetIndexingConfigurationInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (GetIndexingConfigurationInput) String ¶ added in v1.12.36

String returns the string representation

type GetIndexingConfigurationOutput ¶ added in v1.12.36

type GetIndexingConfigurationOutput struct {

	// Thing indexing configuration.
	ThingIndexingConfiguration *ThingIndexingConfiguration `locationName:"thingIndexingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (GetIndexingConfigurationOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*GetIndexingConfigurationOutput) SetThingIndexingConfiguration ¶ added in v1.12.36

SetThingIndexingConfiguration sets the ThingIndexingConfiguration field's value.

func (GetIndexingConfigurationOutput) String ¶ added in v1.12.36

String returns the string representation

type GetJobDocumentInput ¶ added in v1.12.36

type GetJobDocumentInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetJobDocumentInput) GoString ¶ added in v1.12.36

func (s GetJobDocumentInput) GoString() string

GoString returns the string representation

func (*GetJobDocumentInput) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (GetJobDocumentInput) String ¶ added in v1.12.36

func (s GetJobDocumentInput) String() string

String returns the string representation

func (*GetJobDocumentInput) Validate ¶ added in v1.12.36

func (s *GetJobDocumentInput) Validate() error

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

type GetJobDocumentOutput ¶ added in v1.12.36

type GetJobDocumentOutput struct {

	// The job document content.
	Document *string `locationName:"document" type:"string"`
	// contains filtered or unexported fields
}

func (GetJobDocumentOutput) GoString ¶ added in v1.12.36

func (s GetJobDocumentOutput) GoString() string

GoString returns the string representation

func (*GetJobDocumentOutput) SetDocument ¶ added in v1.12.36

SetDocument sets the Document field's value.

func (GetJobDocumentOutput) String ¶ added in v1.12.36

func (s GetJobDocumentOutput) String() string

String returns the string representation

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 GetOTAUpdateInput ¶ added in v1.12.51

type GetOTAUpdateInput struct {

	// The OTA update ID.
	//
	// OtaUpdateId is a required field
	OtaUpdateId *string `location:"uri" locationName:"otaUpdateId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetOTAUpdateInput) GoString ¶ added in v1.12.51

func (s GetOTAUpdateInput) GoString() string

GoString returns the string representation

func (*GetOTAUpdateInput) SetOtaUpdateId ¶ added in v1.12.51

func (s *GetOTAUpdateInput) SetOtaUpdateId(v string) *GetOTAUpdateInput

SetOtaUpdateId sets the OtaUpdateId field's value.

func (GetOTAUpdateInput) String ¶ added in v1.12.51

func (s GetOTAUpdateInput) String() string

String returns the string representation

func (*GetOTAUpdateInput) Validate ¶ added in v1.12.51

func (s *GetOTAUpdateInput) Validate() error

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

type GetOTAUpdateOutput ¶ added in v1.12.51

type GetOTAUpdateOutput struct {

	// The OTA update info.
	OtaUpdateInfo *OTAUpdateInfo `locationName:"otaUpdateInfo" type:"structure"`
	// contains filtered or unexported fields
}

func (GetOTAUpdateOutput) GoString ¶ added in v1.12.51

func (s GetOTAUpdateOutput) GoString() string

GoString returns the string representation

func (*GetOTAUpdateOutput) SetOtaUpdateInfo ¶ added in v1.12.51

func (s *GetOTAUpdateOutput) SetOtaUpdateInfo(v *OTAUpdateInfo) *GetOTAUpdateOutput

SetOtaUpdateInfo sets the OtaUpdateInfo field's value.

func (GetOTAUpdateOutput) String ¶ added in v1.12.51

func (s GetOTAUpdateOutput) 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 date the policy was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

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

	// The generation ID of the policy.
	GenerationId *string `locationName:"generationId" type:"string"`

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

	// 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) SetCreationDate ¶ added in v1.13.12

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

SetCreationDate sets the CreationDate field's value.

func (*GetPolicyOutput) SetDefaultVersionId ¶ added in v1.5.0

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

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*GetPolicyOutput) SetGenerationId ¶ added in v1.13.12

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

SetGenerationId sets the GenerationId field's value.

func (*GetPolicyOutput) SetLastModifiedDate ¶ added in v1.13.12

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

SetLastModifiedDate sets the LastModifiedDate 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 {

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

	// The generation ID of the policy version.
	GenerationId *string `locationName:"generationId" type:"string"`

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

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

	// 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) SetCreationDate ¶ added in v1.13.12

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

SetCreationDate sets the CreationDate field's value.

func (*GetPolicyVersionOutput) SetGenerationId ¶ added in v1.13.12

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

SetGenerationId sets the GenerationId field's value.

func (*GetPolicyVersionOutput) SetIsDefaultVersion ¶ added in v1.5.0

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

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*GetPolicyVersionOutput) SetLastModifiedDate ¶ added in v1.13.12

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

SetLastModifiedDate sets the LastModifiedDate 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 GetV2LoggingOptionsInput ¶ added in v1.12.36

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

func (GetV2LoggingOptionsInput) GoString ¶ added in v1.12.36

func (s GetV2LoggingOptionsInput) GoString() string

GoString returns the string representation

func (GetV2LoggingOptionsInput) String ¶ added in v1.12.36

func (s GetV2LoggingOptionsInput) String() string

String returns the string representation

type GetV2LoggingOptionsOutput ¶ added in v1.12.36

type GetV2LoggingOptionsOutput struct {

	// The default log level.
	DefaultLogLevel *string `locationName:"defaultLogLevel" type:"string" enum:"LogLevel"`

	// Disables all logs.
	DisableAllLogs *bool `locationName:"disableAllLogs" type:"boolean"`

	// The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

func (GetV2LoggingOptionsOutput) GoString ¶ added in v1.12.36

func (s GetV2LoggingOptionsOutput) GoString() string

GoString returns the string representation

func (*GetV2LoggingOptionsOutput) SetDefaultLogLevel ¶ added in v1.12.36

SetDefaultLogLevel sets the DefaultLogLevel field's value.

func (*GetV2LoggingOptionsOutput) SetDisableAllLogs ¶ added in v1.12.36

func (s *GetV2LoggingOptionsOutput) SetDisableAllLogs(v bool) *GetV2LoggingOptionsOutput

SetDisableAllLogs sets the DisableAllLogs field's value.

func (*GetV2LoggingOptionsOutput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (GetV2LoggingOptionsOutput) String ¶ added in v1.12.36

func (s GetV2LoggingOptionsOutput) String() string

String returns the string representation

type GroupNameAndArn ¶ added in v1.12.36

type GroupNameAndArn struct {

	// The group ARN.
	GroupArn *string `locationName:"groupArn" type:"string"`

	// The group name.
	GroupName *string `locationName:"groupName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The name and ARN of a group.

func (GroupNameAndArn) GoString ¶ added in v1.12.36

func (s GroupNameAndArn) GoString() string

GoString returns the string representation

func (*GroupNameAndArn) SetGroupArn ¶ added in v1.12.36

func (s *GroupNameAndArn) SetGroupArn(v string) *GroupNameAndArn

SetGroupArn sets the GroupArn field's value.

func (*GroupNameAndArn) SetGroupName ¶ added in v1.12.36

func (s *GroupNameAndArn) SetGroupName(v string) *GroupNameAndArn

SetGroupName sets the GroupName field's value.

func (GroupNameAndArn) String ¶ added in v1.12.36

func (s GroupNameAndArn) String() string

String returns the string representation

type ImplicitDeny ¶ added in v1.12.36

type ImplicitDeny struct {

	// Policies that don't contain a matching allow or deny statement for the specified
	// action on the specified resource.
	Policies []*Policy `locationName:"policies" type:"list"`
	// contains filtered or unexported fields
}

Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

func (ImplicitDeny) GoString ¶ added in v1.12.36

func (s ImplicitDeny) GoString() string

GoString returns the string representation

func (*ImplicitDeny) SetPolicies ¶ added in v1.12.36

func (s *ImplicitDeny) SetPolicies(v []*Policy) *ImplicitDeny

SetPolicies sets the Policies field's value.

func (ImplicitDeny) String ¶ added in v1.12.36

func (s ImplicitDeny) String() string

String returns the string representation

type IoT ¶

type IoT struct {
	*client.Client
}

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

IoT methods are safe to use concurrently. It is not safe to modify mutate any of the struct'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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AcceptCertificateTransfer for more information on using the AcceptCertificateTransfer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) AddThingToThingGroup ¶ added in v1.12.36

func (c *IoT) AddThingToThingGroup(input *AddThingToThingGroupInput) (*AddThingToThingGroupOutput, error)

AddThingToThingGroup API operation for AWS IoT.

Adds a thing to a thing group.

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 AddThingToThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) AddThingToThingGroupRequest ¶ added in v1.12.36

func (c *IoT) AddThingToThingGroupRequest(input *AddThingToThingGroupInput) (req *request.Request, output *AddThingToThingGroupOutput)

AddThingToThingGroupRequest generates a "aws/request.Request" representing the client's request for the AddThingToThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddThingToThingGroup for more information on using the AddThingToThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) AddThingToThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) AddThingToThingGroupWithContext(ctx aws.Context, input *AddThingToThingGroupInput, opts ...request.Option) (*AddThingToThingGroupOutput, error)

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

See AddThingToThingGroup 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) AssociateTargetsWithJob ¶ added in v1.12.36

func (c *IoT) AssociateTargetsWithJob(input *AssociateTargetsWithJobInput) (*AssociateTargetsWithJobOutput, error)

AssociateTargetsWithJob API operation for AWS IoT.

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

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 AssociateTargetsWithJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) AssociateTargetsWithJobRequest ¶ added in v1.12.36

func (c *IoT) AssociateTargetsWithJobRequest(input *AssociateTargetsWithJobInput) (req *request.Request, output *AssociateTargetsWithJobOutput)

AssociateTargetsWithJobRequest generates a "aws/request.Request" representing the client's request for the AssociateTargetsWithJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateTargetsWithJob for more information on using the AssociateTargetsWithJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) AssociateTargetsWithJobWithContext ¶ added in v1.12.36

func (c *IoT) AssociateTargetsWithJobWithContext(ctx aws.Context, input *AssociateTargetsWithJobInput, opts ...request.Option) (*AssociateTargetsWithJobOutput, error)

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

See AssociateTargetsWithJob 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) AttachPolicy ¶ added in v1.12.36

func (c *IoT) AttachPolicy(input *AttachPolicyInput) (*AttachPolicyOutput, error)

AttachPolicy API operation for AWS IoT.

Attaches a policy to the specified target.

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 AttachPolicy 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" A limit has been exceeded.

func (*IoT) AttachPolicyRequest ¶ added in v1.12.36

func (c *IoT) AttachPolicyRequest(input *AttachPolicyInput) (req *request.Request, output *AttachPolicyOutput)

AttachPolicyRequest generates a "aws/request.Request" representing the client's request for the AttachPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachPolicy for more information on using the AttachPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) AttachPolicyWithContext ¶ added in v1.12.36

func (c *IoT) AttachPolicyWithContext(ctx aws.Context, input *AttachPolicyInput, opts ...request.Option) (*AttachPolicyOutput, error)

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

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

Note: This API is deprecated. Please use AttachPolicy instead.

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" A limit has been exceeded.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachPrincipalPolicy for more information on using the AttachPrincipalPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachThingPrincipal for more information on using the AttachThingPrincipal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelCertificateTransfer for more information on using the CancelCertificateTransfer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) CancelJob ¶ added in v1.12.36

func (c *IoT) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)

CancelJob API operation for AWS IoT.

Cancels a job.

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 CancelJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) CancelJobExecution ¶ added in v1.13.60

func (c *IoT) CancelJobExecution(input *CancelJobExecutionInput) (*CancelJobExecutionOutput, error)

CancelJobExecution API operation for AWS IoT.

Cancels the execution of a job for a given 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 CancelJobExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidStateTransitionException "InvalidStateTransitionException" An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeVersionConflictException "VersionConflictException" An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

func (*IoT) CancelJobExecutionRequest ¶ added in v1.13.60

func (c *IoT) CancelJobExecutionRequest(input *CancelJobExecutionInput) (req *request.Request, output *CancelJobExecutionOutput)

CancelJobExecutionRequest generates a "aws/request.Request" representing the client's request for the CancelJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelJobExecution for more information on using the CancelJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CancelJobExecutionWithContext ¶ added in v1.13.60

func (c *IoT) CancelJobExecutionWithContext(ctx aws.Context, input *CancelJobExecutionInput, opts ...request.Option) (*CancelJobExecutionOutput, error)

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

See CancelJobExecution 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) CancelJobRequest ¶ added in v1.12.36

func (c *IoT) CancelJobRequest(input *CancelJobInput) (req *request.Request, output *CancelJobOutput)

CancelJobRequest generates a "aws/request.Request" representing the client's request for the CancelJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelJob for more information on using the CancelJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CancelJobWithContext ¶ added in v1.12.36

func (c *IoT) CancelJobWithContext(ctx aws.Context, input *CancelJobInput, opts ...request.Option) (*CancelJobOutput, error)

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

See CancelJob 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) ClearDefaultAuthorizer ¶ added in v1.12.36

func (c *IoT) ClearDefaultAuthorizer(input *ClearDefaultAuthorizerInput) (*ClearDefaultAuthorizerOutput, error)

ClearDefaultAuthorizer API operation for AWS IoT.

Clears the default authorizer.

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

func (*IoT) ClearDefaultAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) ClearDefaultAuthorizerRequest(input *ClearDefaultAuthorizerInput) (req *request.Request, output *ClearDefaultAuthorizerOutput)

ClearDefaultAuthorizerRequest generates a "aws/request.Request" representing the client's request for the ClearDefaultAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ClearDefaultAuthorizer for more information on using the ClearDefaultAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ClearDefaultAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) ClearDefaultAuthorizerWithContext(ctx aws.Context, input *ClearDefaultAuthorizerInput, opts ...request.Option) (*ClearDefaultAuthorizerOutput, error)

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

See ClearDefaultAuthorizer 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) CreateAuthorizer ¶ added in v1.12.36

func (c *IoT) CreateAuthorizer(input *CreateAuthorizerInput) (*CreateAuthorizerOutput, error)

CreateAuthorizer API operation for AWS IoT.

Creates an authorizer.

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 CreateAuthorizer for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

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

func (*IoT) CreateAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) CreateAuthorizerRequest(input *CreateAuthorizerInput) (req *request.Request, output *CreateAuthorizerOutput)

CreateAuthorizerRequest generates a "aws/request.Request" representing the client's request for the CreateAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAuthorizer for more information on using the CreateAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) CreateAuthorizerWithContext(ctx aws.Context, input *CreateAuthorizerInput, opts ...request.Option) (*CreateAuthorizerOutput, error)

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

See CreateAuthorizer 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: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCertificateFromCsr for more information on using the CreateCertificateFromCsr API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) CreateJob ¶ added in v1.12.36

func (c *IoT) CreateJob(input *CreateJobInput) (*CreateJobOutput, error)

CreateJob API operation for AWS IoT.

Creates a job.

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 CreateJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) CreateJobRequest ¶ added in v1.12.36

func (c *IoT) CreateJobRequest(input *CreateJobInput) (req *request.Request, output *CreateJobOutput)

CreateJobRequest generates a "aws/request.Request" representing the client's request for the CreateJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateJob for more information on using the CreateJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateJobWithContext ¶ added in v1.12.36

func (c *IoT) CreateJobWithContext(ctx aws.Context, input *CreateJobInput, opts ...request.Option) (*CreateJobOutput, error)

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

See CreateJob 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKeysAndCertificate for more information on using the CreateKeysAndCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) CreateOTAUpdate ¶ added in v1.12.51

func (c *IoT) CreateOTAUpdate(input *CreateOTAUpdateInput) (*CreateOTAUpdateOutput, error)

CreateOTAUpdate API operation for AWS IoT.

Creates an AWS IoT OTAUpdate on a target group of things or groups.

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 CreateOTAUpdate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) CreateOTAUpdateRequest ¶ added in v1.12.51

func (c *IoT) CreateOTAUpdateRequest(input *CreateOTAUpdateInput) (req *request.Request, output *CreateOTAUpdateOutput)

CreateOTAUpdateRequest generates a "aws/request.Request" representing the client's request for the CreateOTAUpdate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOTAUpdate for more information on using the CreateOTAUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateOTAUpdateWithContext ¶ added in v1.12.51

func (c *IoT) CreateOTAUpdateWithContext(ctx aws.Context, input *CreateOTAUpdateInput, opts ...request.Option) (*CreateOTAUpdateOutput, error)

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

See CreateOTAUpdate 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePolicy for more information on using the CreatePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePolicyVersion for more information on using the CreatePolicyVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) CreateRoleAlias ¶ added in v1.12.36

func (c *IoT) CreateRoleAlias(input *CreateRoleAliasInput) (*CreateRoleAliasOutput, error)

CreateRoleAlias API operation for AWS IoT.

Creates a role alias.

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 CreateRoleAlias for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

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

func (*IoT) CreateRoleAliasRequest ¶ added in v1.12.36

func (c *IoT) CreateRoleAliasRequest(input *CreateRoleAliasInput) (req *request.Request, output *CreateRoleAliasOutput)

CreateRoleAliasRequest generates a "aws/request.Request" representing the client's request for the CreateRoleAlias operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRoleAlias for more information on using the CreateRoleAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateRoleAliasWithContext ¶ added in v1.12.36

func (c *IoT) CreateRoleAliasWithContext(ctx aws.Context, input *CreateRoleAliasInput, opts ...request.Option) (*CreateRoleAliasOutput, error)

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

See CreateRoleAlias 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) CreateStream ¶ added in v1.12.51

func (c *IoT) CreateStream(input *CreateStreamInput) (*CreateStreamOutput, error)

CreateStream API operation for AWS IoT.

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

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 CreateStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

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

func (*IoT) CreateStreamRequest ¶ added in v1.12.51

func (c *IoT) CreateStreamRequest(input *CreateStreamInput) (req *request.Request, output *CreateStreamOutput)

CreateStreamRequest generates a "aws/request.Request" representing the client's request for the CreateStream operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStream for more information on using the CreateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateStreamWithContext ¶ added in v1.12.51

func (c *IoT) CreateStreamWithContext(ctx aws.Context, input *CreateStreamInput, opts ...request.Option) (*CreateStreamOutput, error)

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

See CreateStream 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 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.

func (*IoT) CreateThingGroup ¶ added in v1.12.36

func (c *IoT) CreateThingGroup(input *CreateThingGroupInput) (*CreateThingGroupOutput, error)

CreateThingGroup API operation for AWS IoT.

Create a thing group.

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 CreateThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

func (*IoT) CreateThingGroupRequest ¶ added in v1.12.36

func (c *IoT) CreateThingGroupRequest(input *CreateThingGroupInput) (req *request.Request, output *CreateThingGroupOutput)

CreateThingGroupRequest generates a "aws/request.Request" representing the client's request for the CreateThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThingGroup for more information on using the CreateThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) CreateThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) CreateThingGroupWithContext(ctx aws.Context, input *CreateThingGroupInput, opts ...request.Option) (*CreateThingGroupOutput, error)

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

See CreateThingGroup 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) 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThing for more information on using the CreateThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThingType for more information on using the CreateThingType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTopicRule for more information on using the CreateTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DeleteAuthorizer ¶ added in v1.12.36

func (c *IoT) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)

DeleteAuthorizer API operation for AWS IoT.

Deletes an authorizer.

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

func (*IoT) DeleteAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) (req *request.Request, output *DeleteAuthorizerOutput)

DeleteAuthorizerRequest generates a "aws/request.Request" representing the client's request for the DeleteAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAuthorizer for more information on using the DeleteAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) DeleteAuthorizerWithContext(ctx aws.Context, input *DeleteAuthorizerInput, opts ...request.Option) (*DeleteAuthorizerOutput, error)

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

See DeleteAuthorizer 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCACertificate for more information on using the DeleteCACertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCertificate for more information on using the DeleteCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DeleteJob ¶ added in v1.13.52

func (c *IoT) DeleteJob(input *DeleteJobInput) (*DeleteJobOutput, error)

DeleteJob API operation for AWS IoT.

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

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 DeleteJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidStateTransitionException "InvalidStateTransitionException" An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

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

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) DeleteJobExecution ¶ added in v1.13.52

func (c *IoT) DeleteJobExecution(input *DeleteJobExecutionInput) (*DeleteJobExecutionOutput, error)

DeleteJobExecution API operation for AWS IoT.

Deletes a job execution.

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 DeleteJobExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidStateTransitionException "InvalidStateTransitionException" An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) DeleteJobExecutionRequest ¶ added in v1.13.52

func (c *IoT) DeleteJobExecutionRequest(input *DeleteJobExecutionInput) (req *request.Request, output *DeleteJobExecutionOutput)

DeleteJobExecutionRequest generates a "aws/request.Request" representing the client's request for the DeleteJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteJobExecution for more information on using the DeleteJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteJobExecutionWithContext ¶ added in v1.13.52

func (c *IoT) DeleteJobExecutionWithContext(ctx aws.Context, input *DeleteJobExecutionInput, opts ...request.Option) (*DeleteJobExecutionOutput, error)

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

See DeleteJobExecution 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) DeleteJobRequest ¶ added in v1.13.52

func (c *IoT) DeleteJobRequest(input *DeleteJobInput) (req *request.Request, output *DeleteJobOutput)

DeleteJobRequest generates a "aws/request.Request" representing the client's request for the DeleteJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteJob for more information on using the DeleteJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteJobWithContext ¶ added in v1.13.52

func (c *IoT) DeleteJobWithContext(ctx aws.Context, input *DeleteJobInput, opts ...request.Option) (*DeleteJobOutput, error)

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

See DeleteJob 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) DeleteOTAUpdate ¶ added in v1.12.51

func (c *IoT) DeleteOTAUpdate(input *DeleteOTAUpdateInput) (*DeleteOTAUpdateOutput, error)

DeleteOTAUpdate API operation for AWS IoT.

Delete an OTA update.

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 DeleteOTAUpdate for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) DeleteOTAUpdateRequest ¶ added in v1.12.51

func (c *IoT) DeleteOTAUpdateRequest(input *DeleteOTAUpdateInput) (req *request.Request, output *DeleteOTAUpdateOutput)

DeleteOTAUpdateRequest generates a "aws/request.Request" representing the client's request for the DeleteOTAUpdate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteOTAUpdate for more information on using the DeleteOTAUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteOTAUpdateWithContext ¶ added in v1.12.51

func (c *IoT) DeleteOTAUpdateWithContext(ctx aws.Context, input *DeleteOTAUpdateInput, opts ...request.Option) (*DeleteOTAUpdateOutput, error)

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

See DeleteOTAUpdate 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePolicy for more information on using the DeletePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePolicyVersion for more information on using the DeletePolicyVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRegistrationCode for more information on using the DeleteRegistrationCode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DeleteRoleAlias ¶ added in v1.12.36

func (c *IoT) DeleteRoleAlias(input *DeleteRoleAliasInput) (*DeleteRoleAliasOutput, error)

DeleteRoleAlias API operation for AWS IoT.

Deletes a role alias ¶

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

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

func (*IoT) DeleteRoleAliasRequest ¶ added in v1.12.36

func (c *IoT) DeleteRoleAliasRequest(input *DeleteRoleAliasInput) (req *request.Request, output *DeleteRoleAliasOutput)

DeleteRoleAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteRoleAlias operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRoleAlias for more information on using the DeleteRoleAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteRoleAliasWithContext ¶ added in v1.12.36

func (c *IoT) DeleteRoleAliasWithContext(ctx aws.Context, input *DeleteRoleAliasInput, opts ...request.Option) (*DeleteRoleAliasOutput, error)

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

See DeleteRoleAlias 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) DeleteStream ¶ added in v1.12.51

func (c *IoT) DeleteStream(input *DeleteStreamInput) (*DeleteStreamOutput, error)

DeleteStream API operation for AWS IoT.

Deletes a stream.

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 DeleteStream for usage and error information.

Returned Error Codes:

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

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

func (*IoT) DeleteStreamRequest ¶ added in v1.12.51

func (c *IoT) DeleteStreamRequest(input *DeleteStreamInput) (req *request.Request, output *DeleteStreamOutput)

DeleteStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteStream operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStream for more information on using the DeleteStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteStreamWithContext ¶ added in v1.12.51

func (c *IoT) DeleteStreamWithContext(ctx aws.Context, input *DeleteStreamInput, opts ...request.Option) (*DeleteStreamOutput, error)

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

See DeleteStream 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 an entity specified with the expectedVersion parameter does not match the latest version in the system.

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

func (*IoT) DeleteThingGroup ¶ added in v1.12.36

func (c *IoT) DeleteThingGroup(input *DeleteThingGroupInput) (*DeleteThingGroupOutput, error)

DeleteThingGroup API operation for AWS IoT.

Deletes a thing group.

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 DeleteThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeVersionConflictException "VersionConflictException" An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

func (*IoT) DeleteThingGroupRequest ¶ added in v1.12.36

func (c *IoT) DeleteThingGroupRequest(input *DeleteThingGroupInput) (req *request.Request, output *DeleteThingGroupOutput)

DeleteThingGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThingGroup for more information on using the DeleteThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) DeleteThingGroupWithContext(ctx aws.Context, input *DeleteThingGroupInput, opts ...request.Option) (*DeleteThingGroupOutput, error)

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

See DeleteThingGroup 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) 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThing for more information on using the DeleteThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThingType for more information on using the DeleteThingType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTopicRule for more information on using the DeleteTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DeleteV2LoggingLevel ¶ added in v1.12.36

func (c *IoT) DeleteV2LoggingLevel(input *DeleteV2LoggingLevelInput) (*DeleteV2LoggingLevelOutput, error)

DeleteV2LoggingLevel API operation for AWS IoT.

Deletes a logging level.

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

func (*IoT) DeleteV2LoggingLevelRequest ¶ added in v1.12.36

func (c *IoT) DeleteV2LoggingLevelRequest(input *DeleteV2LoggingLevelInput) (req *request.Request, output *DeleteV2LoggingLevelOutput)

DeleteV2LoggingLevelRequest generates a "aws/request.Request" representing the client's request for the DeleteV2LoggingLevel operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteV2LoggingLevel for more information on using the DeleteV2LoggingLevel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DeleteV2LoggingLevelWithContext ¶ added in v1.12.36

func (c *IoT) DeleteV2LoggingLevelWithContext(ctx aws.Context, input *DeleteV2LoggingLevelInput, opts ...request.Option) (*DeleteV2LoggingLevelOutput, error)

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

See DeleteV2LoggingLevel 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateThingType for more information on using the DeprecateThingType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DescribeAuthorizer ¶ added in v1.12.36

func (c *IoT) DescribeAuthorizer(input *DescribeAuthorizerInput) (*DescribeAuthorizerOutput, error)

DescribeAuthorizer API operation for AWS IoT.

Describes an authorizer.

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

func (*IoT) DescribeAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) DescribeAuthorizerRequest(input *DescribeAuthorizerInput) (req *request.Request, output *DescribeAuthorizerOutput)

DescribeAuthorizerRequest generates a "aws/request.Request" representing the client's request for the DescribeAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAuthorizer for more information on using the DescribeAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) DescribeAuthorizerWithContext(ctx aws.Context, input *DescribeAuthorizerInput, opts ...request.Option) (*DescribeAuthorizerOutput, error)

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

See DescribeAuthorizer 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCACertificate for more information on using the DescribeCACertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCertificate for more information on using the DescribeCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DescribeDefaultAuthorizer ¶ added in v1.12.36

func (c *IoT) DescribeDefaultAuthorizer(input *DescribeDefaultAuthorizerInput) (*DescribeDefaultAuthorizerOutput, error)

DescribeDefaultAuthorizer API operation for AWS IoT.

Describes the default authorizer.

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

func (*IoT) DescribeDefaultAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) DescribeDefaultAuthorizerRequest(input *DescribeDefaultAuthorizerInput) (req *request.Request, output *DescribeDefaultAuthorizerOutput)

DescribeDefaultAuthorizerRequest generates a "aws/request.Request" representing the client's request for the DescribeDefaultAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDefaultAuthorizer for more information on using the DescribeDefaultAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeDefaultAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) DescribeDefaultAuthorizerWithContext(ctx aws.Context, input *DescribeDefaultAuthorizerInput, opts ...request.Option) (*DescribeDefaultAuthorizerOutput, error)

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

See DescribeDefaultAuthorizer 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.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEndpoint for more information on using the DescribeEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DescribeEventConfigurations ¶ added in v1.12.36

func (c *IoT) DescribeEventConfigurations(input *DescribeEventConfigurationsInput) (*DescribeEventConfigurationsOutput, error)

DescribeEventConfigurations API operation for AWS IoT.

Describes event configurations.

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 DescribeEventConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

func (*IoT) DescribeEventConfigurationsRequest ¶ added in v1.12.36

func (c *IoT) DescribeEventConfigurationsRequest(input *DescribeEventConfigurationsInput) (req *request.Request, output *DescribeEventConfigurationsOutput)

DescribeEventConfigurationsRequest generates a "aws/request.Request" representing the client's request for the DescribeEventConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventConfigurations for more information on using the DescribeEventConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeEventConfigurationsWithContext ¶ added in v1.12.36

func (c *IoT) DescribeEventConfigurationsWithContext(ctx aws.Context, input *DescribeEventConfigurationsInput, opts ...request.Option) (*DescribeEventConfigurationsOutput, error)

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

See DescribeEventConfigurations 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) DescribeIndex ¶ added in v1.12.36

func (c *IoT) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)

DescribeIndex API operation for AWS IoT.

Describes a search index.

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

func (*IoT) DescribeIndexRequest ¶ added in v1.12.36

func (c *IoT) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)

DescribeIndexRequest generates a "aws/request.Request" representing the client's request for the DescribeIndex operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIndex for more information on using the DescribeIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeIndexWithContext ¶ added in v1.12.36

func (c *IoT) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)

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

See DescribeIndex 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) DescribeJob ¶ added in v1.12.36

func (c *IoT) DescribeJob(input *DescribeJobInput) (*DescribeJobOutput, error)

DescribeJob API operation for AWS IoT.

Describes a job.

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 DescribeJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) DescribeJobExecution ¶ added in v1.12.36

func (c *IoT) DescribeJobExecution(input *DescribeJobExecutionInput) (*DescribeJobExecutionOutput, error)

DescribeJobExecution API operation for AWS IoT.

Describes a job execution.

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 DescribeJobExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) DescribeJobExecutionRequest ¶ added in v1.12.36

func (c *IoT) DescribeJobExecutionRequest(input *DescribeJobExecutionInput) (req *request.Request, output *DescribeJobExecutionOutput)

DescribeJobExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJobExecution for more information on using the DescribeJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeJobExecutionWithContext ¶ added in v1.12.36

func (c *IoT) DescribeJobExecutionWithContext(ctx aws.Context, input *DescribeJobExecutionInput, opts ...request.Option) (*DescribeJobExecutionOutput, error)

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

See DescribeJobExecution 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) DescribeJobRequest ¶ added in v1.12.36

func (c *IoT) DescribeJobRequest(input *DescribeJobInput) (req *request.Request, output *DescribeJobOutput)

DescribeJobRequest generates a "aws/request.Request" representing the client's request for the DescribeJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJob for more information on using the DescribeJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeJobWithContext ¶ added in v1.12.36

func (c *IoT) DescribeJobWithContext(ctx aws.Context, input *DescribeJobInput, opts ...request.Option) (*DescribeJobOutput, error)

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

See DescribeJob 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) DescribeRoleAlias ¶ added in v1.12.36

func (c *IoT) DescribeRoleAlias(input *DescribeRoleAliasInput) (*DescribeRoleAliasOutput, error)

DescribeRoleAlias API operation for AWS IoT.

Describes a role alias.

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

func (*IoT) DescribeRoleAliasRequest ¶ added in v1.12.36

func (c *IoT) DescribeRoleAliasRequest(input *DescribeRoleAliasInput) (req *request.Request, output *DescribeRoleAliasOutput)

DescribeRoleAliasRequest generates a "aws/request.Request" representing the client's request for the DescribeRoleAlias operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRoleAlias for more information on using the DescribeRoleAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeRoleAliasWithContext ¶ added in v1.12.36

func (c *IoT) DescribeRoleAliasWithContext(ctx aws.Context, input *DescribeRoleAliasInput, opts ...request.Option) (*DescribeRoleAliasOutput, error)

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

See DescribeRoleAlias 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) DescribeStream ¶ added in v1.12.51

func (c *IoT) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)

DescribeStream API operation for AWS IoT.

Gets information about a stream.

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 DescribeStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

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

func (*IoT) DescribeStreamRequest ¶ added in v1.12.51

func (c *IoT) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)

DescribeStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeStream operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStream for more information on using the DescribeStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeStreamWithContext ¶ added in v1.12.51

func (c *IoT) DescribeStreamWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.Option) (*DescribeStreamOutput, error)

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

See DescribeStream 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.

func (*IoT) DescribeThingGroup ¶ added in v1.12.36

func (c *IoT) DescribeThingGroup(input *DescribeThingGroupInput) (*DescribeThingGroupOutput, error)

DescribeThingGroup API operation for AWS IoT.

Describe a thing group.

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 DescribeThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) DescribeThingGroupRequest ¶ added in v1.12.36

func (c *IoT) DescribeThingGroupRequest(input *DescribeThingGroupInput) (req *request.Request, output *DescribeThingGroupOutput)

DescribeThingGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThingGroup for more information on using the DescribeThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) DescribeThingGroupWithContext(ctx aws.Context, input *DescribeThingGroupInput, opts ...request.Option) (*DescribeThingGroupOutput, error)

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

See DescribeThingGroup 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) DescribeThingRegistrationTask ¶ added in v1.12.36

func (c *IoT) DescribeThingRegistrationTask(input *DescribeThingRegistrationTaskInput) (*DescribeThingRegistrationTaskOutput, error)

DescribeThingRegistrationTask API operation for AWS IoT.

Describes a bulk thing provisioning task.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) DescribeThingRegistrationTaskRequest ¶ added in v1.12.36

func (c *IoT) DescribeThingRegistrationTaskRequest(input *DescribeThingRegistrationTaskInput) (req *request.Request, output *DescribeThingRegistrationTaskOutput)

DescribeThingRegistrationTaskRequest generates a "aws/request.Request" representing the client's request for the DescribeThingRegistrationTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThingRegistrationTask for more information on using the DescribeThingRegistrationTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DescribeThingRegistrationTaskWithContext ¶ added in v1.12.36

func (c *IoT) DescribeThingRegistrationTaskWithContext(ctx aws.Context, input *DescribeThingRegistrationTaskInput, opts ...request.Option) (*DescribeThingRegistrationTaskOutput, error)

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

See DescribeThingRegistrationTask 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) 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThing for more information on using the DescribeThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThingType for more information on using the DescribeThingType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) DetachPolicy ¶ added in v1.12.36

func (c *IoT) DetachPolicy(input *DetachPolicyInput) (*DetachPolicyOutput, error)

DetachPolicy API operation for AWS IoT.

Detaches a policy from the specified target.

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

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

func (*IoT) DetachPolicyRequest ¶ added in v1.12.36

func (c *IoT) DetachPolicyRequest(input *DetachPolicyInput) (req *request.Request, output *DetachPolicyOutput)

DetachPolicyRequest generates a "aws/request.Request" representing the client's request for the DetachPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachPolicy for more information on using the DetachPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) DetachPolicyWithContext ¶ added in v1.12.36

func (c *IoT) DetachPolicyWithContext(ctx aws.Context, input *DetachPolicyInput, opts ...request.Option) (*DetachPolicyOutput, error)

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

See DetachPolicy 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.

Note: This API is deprecated. Please use DetachPolicy instead.

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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachPrincipalPolicy for more information on using the DetachPrincipalPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachThingPrincipal for more information on using the DetachThingPrincipal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableTopicRule for more information on using the DisableTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableTopicRule for more information on using the EnableTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) GetEffectivePolicies ¶ added in v1.12.36

func (c *IoT) GetEffectivePolicies(input *GetEffectivePoliciesInput) (*GetEffectivePoliciesOutput, error)

GetEffectivePolicies API operation for AWS IoT.

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

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 GetEffectivePolicies 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" A limit has been exceeded.

func (*IoT) GetEffectivePoliciesRequest ¶ added in v1.12.36

func (c *IoT) GetEffectivePoliciesRequest(input *GetEffectivePoliciesInput) (req *request.Request, output *GetEffectivePoliciesOutput)

GetEffectivePoliciesRequest generates a "aws/request.Request" representing the client's request for the GetEffectivePolicies operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEffectivePolicies for more information on using the GetEffectivePolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) GetEffectivePoliciesWithContext ¶ added in v1.12.36

func (c *IoT) GetEffectivePoliciesWithContext(ctx aws.Context, input *GetEffectivePoliciesInput, opts ...request.Option) (*GetEffectivePoliciesOutput, error)

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

See GetEffectivePolicies 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) GetIndexingConfiguration ¶ added in v1.12.36

func (c *IoT) GetIndexingConfiguration(input *GetIndexingConfigurationInput) (*GetIndexingConfigurationOutput, error)

GetIndexingConfiguration API operation for AWS IoT.

Gets the search configuration.

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

func (*IoT) GetIndexingConfigurationRequest ¶ added in v1.12.36

func (c *IoT) GetIndexingConfigurationRequest(input *GetIndexingConfigurationInput) (req *request.Request, output *GetIndexingConfigurationOutput)

GetIndexingConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetIndexingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetIndexingConfiguration for more information on using the GetIndexingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) GetIndexingConfigurationWithContext ¶ added in v1.12.36

func (c *IoT) GetIndexingConfigurationWithContext(ctx aws.Context, input *GetIndexingConfigurationInput, opts ...request.Option) (*GetIndexingConfigurationOutput, error)

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

See GetIndexingConfiguration 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) GetJobDocument ¶ added in v1.12.36

func (c *IoT) GetJobDocument(input *GetJobDocumentInput) (*GetJobDocumentOutput, error)

GetJobDocument API operation for AWS IoT.

Gets a job document.

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 GetJobDocument for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) GetJobDocumentRequest ¶ added in v1.12.36

func (c *IoT) GetJobDocumentRequest(input *GetJobDocumentInput) (req *request.Request, output *GetJobDocumentOutput)

GetJobDocumentRequest generates a "aws/request.Request" representing the client's request for the GetJobDocument operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJobDocument for more information on using the GetJobDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) GetJobDocumentWithContext ¶ added in v1.12.36

func (c *IoT) GetJobDocumentWithContext(ctx aws.Context, input *GetJobDocumentInput, opts ...request.Option) (*GetJobDocumentOutput, error)

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

See GetJobDocument 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoggingOptions for more information on using the GetLoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) GetOTAUpdate ¶ added in v1.12.51

func (c *IoT) GetOTAUpdate(input *GetOTAUpdateInput) (*GetOTAUpdateOutput, error)

GetOTAUpdate API operation for AWS IoT.

Gets an OTA update.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

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

func (*IoT) GetOTAUpdateRequest ¶ added in v1.12.51

func (c *IoT) GetOTAUpdateRequest(input *GetOTAUpdateInput) (req *request.Request, output *GetOTAUpdateOutput)

GetOTAUpdateRequest generates a "aws/request.Request" representing the client's request for the GetOTAUpdate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOTAUpdate for more information on using the GetOTAUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) GetOTAUpdateWithContext ¶ added in v1.12.51

func (c *IoT) GetOTAUpdateWithContext(ctx aws.Context, input *GetOTAUpdateInput, opts ...request.Option) (*GetOTAUpdateOutput, error)

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

See GetOTAUpdate 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPolicy for more information on using the GetPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPolicyVersion for more information on using the GetPolicyVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRegistrationCode for more information on using the GetRegistrationCode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTopicRule for more information on using the GetTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) GetV2LoggingOptions ¶ added in v1.12.36

func (c *IoT) GetV2LoggingOptions(input *GetV2LoggingOptionsInput) (*GetV2LoggingOptionsOutput, error)

GetV2LoggingOptions API operation for AWS IoT.

Gets the fine grained 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 GetV2LoggingOptions 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.

func (*IoT) GetV2LoggingOptionsRequest ¶ added in v1.12.36

func (c *IoT) GetV2LoggingOptionsRequest(input *GetV2LoggingOptionsInput) (req *request.Request, output *GetV2LoggingOptionsOutput)

GetV2LoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the GetV2LoggingOptions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetV2LoggingOptions for more information on using the GetV2LoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) GetV2LoggingOptionsWithContext ¶ added in v1.12.36

func (c *IoT) GetV2LoggingOptionsWithContext(ctx aws.Context, input *GetV2LoggingOptionsInput, opts ...request.Option) (*GetV2LoggingOptionsOutput, error)

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

See GetV2LoggingOptions 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) ListAttachedPolicies ¶ added in v1.12.36

func (c *IoT) ListAttachedPolicies(input *ListAttachedPoliciesInput) (*ListAttachedPoliciesOutput, error)

ListAttachedPolicies API operation for AWS IoT.

Lists the policies attached to the specified thing group.

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 ListAttachedPolicies 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" A limit has been exceeded.

func (*IoT) ListAttachedPoliciesRequest ¶ added in v1.12.36

func (c *IoT) ListAttachedPoliciesRequest(input *ListAttachedPoliciesInput) (req *request.Request, output *ListAttachedPoliciesOutput)

ListAttachedPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListAttachedPolicies operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAttachedPolicies for more information on using the ListAttachedPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListAttachedPoliciesWithContext ¶ added in v1.12.36

func (c *IoT) ListAttachedPoliciesWithContext(ctx aws.Context, input *ListAttachedPoliciesInput, opts ...request.Option) (*ListAttachedPoliciesOutput, error)

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

See ListAttachedPolicies 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) ListAuthorizers ¶ added in v1.12.36

func (c *IoT) ListAuthorizers(input *ListAuthorizersInput) (*ListAuthorizersOutput, error)

ListAuthorizers API operation for AWS IoT.

Lists the authorizers registered in your account.

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

func (*IoT) ListAuthorizersRequest ¶ added in v1.12.36

func (c *IoT) ListAuthorizersRequest(input *ListAuthorizersInput) (req *request.Request, output *ListAuthorizersOutput)

ListAuthorizersRequest generates a "aws/request.Request" representing the client's request for the ListAuthorizers operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAuthorizers for more information on using the ListAuthorizers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListAuthorizersWithContext ¶ added in v1.12.36

func (c *IoT) ListAuthorizersWithContext(ctx aws.Context, input *ListAuthorizersInput, opts ...request.Option) (*ListAuthorizersOutput, error)

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

See ListAuthorizers 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCACertificates for more information on using the ListCACertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCertificatesByCA for more information on using the ListCertificatesByCA API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCertificates for more information on using the ListCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) ListIndices ¶ added in v1.12.36

func (c *IoT) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)

ListIndices API operation for AWS IoT.

Lists the search indices.

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

func (*IoT) ListIndicesRequest ¶ added in v1.12.36

func (c *IoT) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)

ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIndices for more information on using the ListIndices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListIndicesWithContext ¶ added in v1.12.36

func (c *IoT) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)

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

See ListIndices 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) ListJobExecutionsForJob ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForJob(input *ListJobExecutionsForJobInput) (*ListJobExecutionsForJobOutput, error)

ListJobExecutionsForJob API operation for AWS IoT.

Lists the job executions for a job.

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 ListJobExecutionsForJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) ListJobExecutionsForJobRequest ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForJobRequest(input *ListJobExecutionsForJobInput) (req *request.Request, output *ListJobExecutionsForJobOutput)

ListJobExecutionsForJobRequest generates a "aws/request.Request" representing the client's request for the ListJobExecutionsForJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobExecutionsForJob for more information on using the ListJobExecutionsForJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListJobExecutionsForJobWithContext ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForJobWithContext(ctx aws.Context, input *ListJobExecutionsForJobInput, opts ...request.Option) (*ListJobExecutionsForJobOutput, error)

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

See ListJobExecutionsForJob 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) ListJobExecutionsForThing ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForThing(input *ListJobExecutionsForThingInput) (*ListJobExecutionsForThingOutput, error)

ListJobExecutionsForThing API operation for AWS IoT.

Lists the job executions for 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 ListJobExecutionsForThing for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) ListJobExecutionsForThingRequest ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForThingRequest(input *ListJobExecutionsForThingInput) (req *request.Request, output *ListJobExecutionsForThingOutput)

ListJobExecutionsForThingRequest generates a "aws/request.Request" representing the client's request for the ListJobExecutionsForThing operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobExecutionsForThing for more information on using the ListJobExecutionsForThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListJobExecutionsForThingWithContext ¶ added in v1.12.36

func (c *IoT) ListJobExecutionsForThingWithContext(ctx aws.Context, input *ListJobExecutionsForThingInput, opts ...request.Option) (*ListJobExecutionsForThingOutput, error)

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

See ListJobExecutionsForThing 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) ListJobs ¶ added in v1.12.36

func (c *IoT) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs API operation for AWS IoT.

Lists jobs.

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 ListJobs for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) ListJobsRequest ¶ added in v1.12.36

func (c *IoT) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)

ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobs for more information on using the ListJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListJobsWithContext ¶ added in v1.12.36

func (c *IoT) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)

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

See ListJobs 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) ListOTAUpdates ¶ added in v1.12.51

func (c *IoT) ListOTAUpdates(input *ListOTAUpdatesInput) (*ListOTAUpdatesOutput, error)

ListOTAUpdates API operation for AWS IoT.

Lists OTA updates.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) ListOTAUpdatesRequest ¶ added in v1.12.51

func (c *IoT) ListOTAUpdatesRequest(input *ListOTAUpdatesInput) (req *request.Request, output *ListOTAUpdatesOutput)

ListOTAUpdatesRequest generates a "aws/request.Request" representing the client's request for the ListOTAUpdates operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOTAUpdates for more information on using the ListOTAUpdates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListOTAUpdatesWithContext ¶ added in v1.12.51

func (c *IoT) ListOTAUpdatesWithContext(ctx aws.Context, input *ListOTAUpdatesInput, opts ...request.Option) (*ListOTAUpdatesOutput, error)

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

See ListOTAUpdates 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 transferred 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOutgoingCertificates for more information on using the ListOutgoingCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPolicies for more information on using the ListPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPolicyPrincipals for more information on using the ListPolicyPrincipals API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPolicyVersions for more information on using the ListPolicyVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

Note: This API is deprecated. Please use ListAttachedPolicies instead.

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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPrincipalPolicies for more information on using the ListPrincipalPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPrincipalThings for more information on using the ListPrincipalThings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) ListRoleAliases ¶ added in v1.12.36

func (c *IoT) ListRoleAliases(input *ListRoleAliasesInput) (*ListRoleAliasesOutput, error)

ListRoleAliases API operation for AWS IoT.

Lists the role aliases registered in your account.

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

func (*IoT) ListRoleAliasesRequest ¶ added in v1.12.36

func (c *IoT) ListRoleAliasesRequest(input *ListRoleAliasesInput) (req *request.Request, output *ListRoleAliasesOutput)

ListRoleAliasesRequest generates a "aws/request.Request" representing the client's request for the ListRoleAliases operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRoleAliases for more information on using the ListRoleAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListRoleAliasesWithContext ¶ added in v1.12.36

func (c *IoT) ListRoleAliasesWithContext(ctx aws.Context, input *ListRoleAliasesInput, opts ...request.Option) (*ListRoleAliasesOutput, error)

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

See ListRoleAliases 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) ListStreams ¶ added in v1.12.51

func (c *IoT) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)

ListStreams API operation for AWS IoT.

Lists all of the streams in your AWS account.

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

func (*IoT) ListStreamsRequest ¶ added in v1.12.51

func (c *IoT) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)

ListStreamsRequest generates a "aws/request.Request" representing the client's request for the ListStreams operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStreams for more information on using the ListStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListStreamsWithContext ¶ added in v1.12.51

func (c *IoT) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error)

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

See ListStreams 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) ListTargetsForPolicy ¶ added in v1.12.36

func (c *IoT) ListTargetsForPolicy(input *ListTargetsForPolicyInput) (*ListTargetsForPolicyOutput, error)

ListTargetsForPolicy API operation for AWS IoT.

List targets for 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 ListTargetsForPolicy 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" A limit has been exceeded.

func (*IoT) ListTargetsForPolicyRequest ¶ added in v1.12.36

func (c *IoT) ListTargetsForPolicyRequest(input *ListTargetsForPolicyInput) (req *request.Request, output *ListTargetsForPolicyOutput)

ListTargetsForPolicyRequest generates a "aws/request.Request" representing the client's request for the ListTargetsForPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTargetsForPolicy for more information on using the ListTargetsForPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListTargetsForPolicyWithContext ¶ added in v1.12.36

func (c *IoT) ListTargetsForPolicyWithContext(ctx aws.Context, input *ListTargetsForPolicyInput, opts ...request.Option) (*ListTargetsForPolicyOutput, error)

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

See ListTargetsForPolicy 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) ListThingGroups ¶ added in v1.12.36

func (c *IoT) ListThingGroups(input *ListThingGroupsInput) (*ListThingGroupsOutput, error)

ListThingGroups API operation for AWS IoT.

List the thing groups in your account.

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 ListThingGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) ListThingGroupsForThing ¶ added in v1.12.36

func (c *IoT) ListThingGroupsForThing(input *ListThingGroupsForThingInput) (*ListThingGroupsForThingOutput, error)

ListThingGroupsForThing API operation for AWS IoT.

List the thing groups to which the specified thing belongs.

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 ListThingGroupsForThing for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) ListThingGroupsForThingRequest ¶ added in v1.12.36

func (c *IoT) ListThingGroupsForThingRequest(input *ListThingGroupsForThingInput) (req *request.Request, output *ListThingGroupsForThingOutput)

ListThingGroupsForThingRequest generates a "aws/request.Request" representing the client's request for the ListThingGroupsForThing operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingGroupsForThing for more information on using the ListThingGroupsForThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListThingGroupsForThingWithContext ¶ added in v1.12.36

func (c *IoT) ListThingGroupsForThingWithContext(ctx aws.Context, input *ListThingGroupsForThingInput, opts ...request.Option) (*ListThingGroupsForThingOutput, error)

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

See ListThingGroupsForThing 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) ListThingGroupsRequest ¶ added in v1.12.36

func (c *IoT) ListThingGroupsRequest(input *ListThingGroupsInput) (req *request.Request, output *ListThingGroupsOutput)

ListThingGroupsRequest generates a "aws/request.Request" representing the client's request for the ListThingGroups operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingGroups for more information on using the ListThingGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListThingGroupsWithContext ¶ added in v1.12.36

func (c *IoT) ListThingGroupsWithContext(ctx aws.Context, input *ListThingGroupsInput, opts ...request.Option) (*ListThingGroupsOutput, error)

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

See ListThingGroups 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingPrincipals for more information on using the ListThingPrincipals API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) ListThingRegistrationTaskReports ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTaskReports(input *ListThingRegistrationTaskReportsInput) (*ListThingRegistrationTaskReportsOutput, error)

ListThingRegistrationTaskReports API operation for AWS IoT.

Information about the thing registration tasks.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

func (*IoT) ListThingRegistrationTaskReportsRequest ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTaskReportsRequest(input *ListThingRegistrationTaskReportsInput) (req *request.Request, output *ListThingRegistrationTaskReportsOutput)

ListThingRegistrationTaskReportsRequest generates a "aws/request.Request" representing the client's request for the ListThingRegistrationTaskReports operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingRegistrationTaskReports for more information on using the ListThingRegistrationTaskReports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListThingRegistrationTaskReportsWithContext ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTaskReportsWithContext(ctx aws.Context, input *ListThingRegistrationTaskReportsInput, opts ...request.Option) (*ListThingRegistrationTaskReportsOutput, error)

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

See ListThingRegistrationTaskReports 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) ListThingRegistrationTasks ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTasks(input *ListThingRegistrationTasksInput) (*ListThingRegistrationTasksOutput, error)

ListThingRegistrationTasks API operation for AWS IoT.

List bulk thing provisioning tasks.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

func (*IoT) ListThingRegistrationTasksRequest ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTasksRequest(input *ListThingRegistrationTasksInput) (req *request.Request, output *ListThingRegistrationTasksOutput)

ListThingRegistrationTasksRequest generates a "aws/request.Request" representing the client's request for the ListThingRegistrationTasks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingRegistrationTasks for more information on using the ListThingRegistrationTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListThingRegistrationTasksWithContext ¶ added in v1.12.36

func (c *IoT) ListThingRegistrationTasksWithContext(ctx aws.Context, input *ListThingRegistrationTasksInput, opts ...request.Option) (*ListThingRegistrationTasksOutput, error)

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

See ListThingRegistrationTasks 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingTypes for more information on using the ListThingTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

func (*IoT) ListThingsInThingGroup ¶ added in v1.12.36

func (c *IoT) ListThingsInThingGroup(input *ListThingsInThingGroupInput) (*ListThingsInThingGroupOutput, error)

ListThingsInThingGroup API operation for AWS IoT.

Lists the things in the specified group.

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 ListThingsInThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) ListThingsInThingGroupRequest ¶ added in v1.12.36

func (c *IoT) ListThingsInThingGroupRequest(input *ListThingsInThingGroupInput) (req *request.Request, output *ListThingsInThingGroupOutput)

ListThingsInThingGroupRequest generates a "aws/request.Request" representing the client's request for the ListThingsInThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThingsInThingGroup for more information on using the ListThingsInThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListThingsInThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) ListThingsInThingGroupWithContext(ctx aws.Context, input *ListThingsInThingGroupInput, opts ...request.Option) (*ListThingsInThingGroupOutput, error)

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

See ListThingsInThingGroup 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) 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThings for more information on using the ListThings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTopicRules for more information on using the ListTopicRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) ListV2LoggingLevels ¶ added in v1.12.36

func (c *IoT) ListV2LoggingLevels(input *ListV2LoggingLevelsInput) (*ListV2LoggingLevelsOutput, error)

ListV2LoggingLevels API operation for AWS IoT.

Lists logging levels.

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 ListV2LoggingLevels for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeNotConfiguredException "NotConfiguredException" The resource is not configured.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) ListV2LoggingLevelsRequest ¶ added in v1.12.36

func (c *IoT) ListV2LoggingLevelsRequest(input *ListV2LoggingLevelsInput) (req *request.Request, output *ListV2LoggingLevelsOutput)

ListV2LoggingLevelsRequest generates a "aws/request.Request" representing the client's request for the ListV2LoggingLevels operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListV2LoggingLevels for more information on using the ListV2LoggingLevels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) ListV2LoggingLevelsWithContext ¶ added in v1.12.36

func (c *IoT) ListV2LoggingLevelsWithContext(ctx aws.Context, input *ListV2LoggingLevelsInput, opts ...request.Option) (*ListV2LoggingLevelsOutput, error)

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

See ListV2LoggingLevels 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. 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" A limit has been exceeded.

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

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterCACertificate for more information on using the RegisterCACertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterCertificate for more information on using the RegisterCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) RegisterThing ¶ added in v1.12.36

func (c *IoT) RegisterThing(input *RegisterThingInput) (*RegisterThingOutput, error)

RegisterThing API operation for AWS IoT.

Provisions 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 RegisterThing for usage and error information.

Returned Error Codes:

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeConflictingResourceUpdateException "ConflictingResourceUpdateException" A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

  • ErrCodeResourceRegistrationFailureException "ResourceRegistrationFailureException" The resource registration failed.

func (*IoT) RegisterThingRequest ¶ added in v1.12.36

func (c *IoT) RegisterThingRequest(input *RegisterThingInput) (req *request.Request, output *RegisterThingOutput)

RegisterThingRequest generates a "aws/request.Request" representing the client's request for the RegisterThing operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterThing for more information on using the RegisterThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) RegisterThingWithContext ¶ added in v1.12.36

func (c *IoT) RegisterThingWithContext(ctx aws.Context, input *RegisterThingInput, opts ...request.Option) (*RegisterThingOutput, error)

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

See RegisterThing 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RejectCertificateTransfer for more information on using the RejectCertificateTransfer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) RemoveThingFromThingGroup ¶ added in v1.12.36

func (c *IoT) RemoveThingFromThingGroup(input *RemoveThingFromThingGroupInput) (*RemoveThingFromThingGroupOutput, error)

RemoveThingFromThingGroup API operation for AWS IoT.

Remove the specified thing from the specified group.

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 RemoveThingFromThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) RemoveThingFromThingGroupRequest ¶ added in v1.12.36

func (c *IoT) RemoveThingFromThingGroupRequest(input *RemoveThingFromThingGroupInput) (req *request.Request, output *RemoveThingFromThingGroupOutput)

RemoveThingFromThingGroupRequest generates a "aws/request.Request" representing the client's request for the RemoveThingFromThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveThingFromThingGroup for more information on using the RemoveThingFromThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) RemoveThingFromThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) RemoveThingFromThingGroupWithContext(ctx aws.Context, input *RemoveThingFromThingGroupInput, opts ...request.Option) (*RemoveThingFromThingGroupOutput, error)

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

See RemoveThingFromThingGroup 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 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReplaceTopicRule for more information on using the ReplaceTopicRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) SearchIndex ¶ added in v1.12.36

func (c *IoT) SearchIndex(input *SearchIndexInput) (*SearchIndexOutput, error)

SearchIndex API operation for AWS IoT.

The query search index.

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

  • ErrCodeInvalidQueryException "InvalidQueryException" The query is invalid.

  • ErrCodeIndexNotReadyException "IndexNotReadyException" The index is not ready.

func (*IoT) SearchIndexRequest ¶ added in v1.12.36

func (c *IoT) SearchIndexRequest(input *SearchIndexInput) (req *request.Request, output *SearchIndexOutput)

SearchIndexRequest generates a "aws/request.Request" representing the client's request for the SearchIndex operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchIndex for more information on using the SearchIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) SearchIndexWithContext ¶ added in v1.12.36

func (c *IoT) SearchIndexWithContext(ctx aws.Context, input *SearchIndexInput, opts ...request.Option) (*SearchIndexOutput, error)

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

See SearchIndex 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) SetDefaultAuthorizer ¶ added in v1.12.36

func (c *IoT) SetDefaultAuthorizer(input *SetDefaultAuthorizerInput) (*SetDefaultAuthorizerOutput, error)

SetDefaultAuthorizer API operation for AWS IoT.

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

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

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource already exists.

func (*IoT) SetDefaultAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) SetDefaultAuthorizerRequest(input *SetDefaultAuthorizerInput) (req *request.Request, output *SetDefaultAuthorizerOutput)

SetDefaultAuthorizerRequest generates a "aws/request.Request" representing the client's request for the SetDefaultAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDefaultAuthorizer for more information on using the SetDefaultAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) SetDefaultAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) SetDefaultAuthorizerWithContext(ctx aws.Context, input *SetDefaultAuthorizerInput, opts ...request.Option) (*SetDefaultAuthorizerOutput, error)

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

See SetDefaultAuthorizer 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDefaultPolicyVersion for more information on using the SetDefaultPolicyVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetLoggingOptions for more information on using the SetLoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) SetV2LoggingLevel ¶ added in v1.12.36

func (c *IoT) SetV2LoggingLevel(input *SetV2LoggingLevelInput) (*SetV2LoggingLevelOutput, error)

SetV2LoggingLevel API operation for AWS IoT.

Sets the logging level.

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 SetV2LoggingLevel for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" An unexpected error has occurred.

  • ErrCodeNotConfiguredException "NotConfiguredException" The resource is not configured.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

func (*IoT) SetV2LoggingLevelRequest ¶ added in v1.12.36

func (c *IoT) SetV2LoggingLevelRequest(input *SetV2LoggingLevelInput) (req *request.Request, output *SetV2LoggingLevelOutput)

SetV2LoggingLevelRequest generates a "aws/request.Request" representing the client's request for the SetV2LoggingLevel operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetV2LoggingLevel for more information on using the SetV2LoggingLevel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) SetV2LoggingLevelWithContext ¶ added in v1.12.36

func (c *IoT) SetV2LoggingLevelWithContext(ctx aws.Context, input *SetV2LoggingLevelInput, opts ...request.Option) (*SetV2LoggingLevelOutput, error)

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

See SetV2LoggingLevel 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) SetV2LoggingOptions ¶ added in v1.12.36

func (c *IoT) SetV2LoggingOptions(input *SetV2LoggingOptionsInput) (*SetV2LoggingOptionsOutput, error)

SetV2LoggingOptions API operation for AWS IoT.

Sets the logging options for the V2 logging service.

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

func (*IoT) SetV2LoggingOptionsRequest ¶ added in v1.12.36

func (c *IoT) SetV2LoggingOptionsRequest(input *SetV2LoggingOptionsInput) (req *request.Request, output *SetV2LoggingOptionsOutput)

SetV2LoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the SetV2LoggingOptions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetV2LoggingOptions for more information on using the SetV2LoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) SetV2LoggingOptionsWithContext ¶ added in v1.12.36

func (c *IoT) SetV2LoggingOptionsWithContext(ctx aws.Context, input *SetV2LoggingOptionsInput, opts ...request.Option) (*SetV2LoggingOptionsOutput, error)

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

See SetV2LoggingOptions 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) StartThingRegistrationTask ¶ added in v1.12.36

func (c *IoT) StartThingRegistrationTask(input *StartThingRegistrationTaskInput) (*StartThingRegistrationTaskOutput, error)

StartThingRegistrationTask API operation for AWS IoT.

Creates a bulk thing provisioning task.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

func (*IoT) StartThingRegistrationTaskRequest ¶ added in v1.12.36

func (c *IoT) StartThingRegistrationTaskRequest(input *StartThingRegistrationTaskInput) (req *request.Request, output *StartThingRegistrationTaskOutput)

StartThingRegistrationTaskRequest generates a "aws/request.Request" representing the client's request for the StartThingRegistrationTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartThingRegistrationTask for more information on using the StartThingRegistrationTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) StartThingRegistrationTaskWithContext ¶ added in v1.12.36

func (c *IoT) StartThingRegistrationTaskWithContext(ctx aws.Context, input *StartThingRegistrationTaskInput, opts ...request.Option) (*StartThingRegistrationTaskOutput, error)

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

See StartThingRegistrationTask 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) StopThingRegistrationTask ¶ added in v1.12.36

func (c *IoT) StopThingRegistrationTask(input *StopThingRegistrationTaskInput) (*StopThingRegistrationTaskOutput, error)

StopThingRegistrationTask API operation for AWS IoT.

Cancels a bulk thing provisioning task.

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

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) StopThingRegistrationTaskRequest ¶ added in v1.12.36

func (c *IoT) StopThingRegistrationTaskRequest(input *StopThingRegistrationTaskInput) (req *request.Request, output *StopThingRegistrationTaskOutput)

StopThingRegistrationTaskRequest generates a "aws/request.Request" representing the client's request for the StopThingRegistrationTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopThingRegistrationTask for more information on using the StopThingRegistrationTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) StopThingRegistrationTaskWithContext ¶ added in v1.12.36

func (c *IoT) StopThingRegistrationTaskWithContext(ctx aws.Context, input *StopThingRegistrationTaskInput, opts ...request.Option) (*StopThingRegistrationTaskOutput, error)

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

See StopThingRegistrationTask 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) TestAuthorization ¶ added in v1.12.36

func (c *IoT) TestAuthorization(input *TestAuthorizationInput) (*TestAuthorizationOutput, error)

TestAuthorization API operation for AWS IoT.

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

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 TestAuthorization 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" A limit has been exceeded.

func (*IoT) TestAuthorizationRequest ¶ added in v1.12.36

func (c *IoT) TestAuthorizationRequest(input *TestAuthorizationInput) (req *request.Request, output *TestAuthorizationOutput)

TestAuthorizationRequest generates a "aws/request.Request" representing the client's request for the TestAuthorization operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestAuthorization for more information on using the TestAuthorization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) TestAuthorizationWithContext ¶ added in v1.12.36

func (c *IoT) TestAuthorizationWithContext(ctx aws.Context, input *TestAuthorizationInput, opts ...request.Option) (*TestAuthorizationOutput, error)

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

See TestAuthorization 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) TestInvokeAuthorizer ¶ added in v1.12.36

func (c *IoT) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)

TestInvokeAuthorizer API operation for AWS IoT.

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

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

  • ErrCodeInvalidResponseException "InvalidResponseException" The response is invalid.

func (*IoT) TestInvokeAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) (req *request.Request, output *TestInvokeAuthorizerOutput)

TestInvokeAuthorizerRequest generates a "aws/request.Request" representing the client's request for the TestInvokeAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestInvokeAuthorizer for more information on using the TestInvokeAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) TestInvokeAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) TestInvokeAuthorizerWithContext(ctx aws.Context, input *TestInvokeAuthorizerInput, opts ...request.Option) (*TestInvokeAuthorizerOutput, error)

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

See TestInvokeAuthorizer 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TransferCertificate for more information on using the TransferCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) UpdateAuthorizer ¶ added in v1.12.36

func (c *IoT) UpdateAuthorizer(input *UpdateAuthorizerInput) (*UpdateAuthorizerOutput, error)

UpdateAuthorizer API operation for AWS IoT.

Updates an authorizer.

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 UpdateAuthorizer for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeLimitExceededException "LimitExceededException" A limit has been exceeded.

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

func (*IoT) UpdateAuthorizerRequest ¶ added in v1.12.36

func (c *IoT) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) (req *request.Request, output *UpdateAuthorizerOutput)

UpdateAuthorizerRequest generates a "aws/request.Request" representing the client's request for the UpdateAuthorizer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAuthorizer for more information on using the UpdateAuthorizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateAuthorizerWithContext ¶ added in v1.12.36

func (c *IoT) UpdateAuthorizerWithContext(ctx aws.Context, input *UpdateAuthorizerInput, opts ...request.Option) (*UpdateAuthorizerOutput, error)

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

See UpdateAuthorizer 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.

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCACertificate for more information on using the UpdateCACertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCertificate for more information on using the UpdateCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) UpdateEventConfigurations ¶ added in v1.12.36

func (c *IoT) UpdateEventConfigurations(input *UpdateEventConfigurationsInput) (*UpdateEventConfigurationsOutput, error)

UpdateEventConfigurations API operation for AWS IoT.

Updates the event configurations.

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 UpdateEventConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

func (*IoT) UpdateEventConfigurationsRequest ¶ added in v1.12.36

func (c *IoT) UpdateEventConfigurationsRequest(input *UpdateEventConfigurationsInput) (req *request.Request, output *UpdateEventConfigurationsOutput)

UpdateEventConfigurationsRequest generates a "aws/request.Request" representing the client's request for the UpdateEventConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEventConfigurations for more information on using the UpdateEventConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateEventConfigurationsWithContext ¶ added in v1.12.36

func (c *IoT) UpdateEventConfigurationsWithContext(ctx aws.Context, input *UpdateEventConfigurationsInput, opts ...request.Option) (*UpdateEventConfigurationsOutput, error)

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

See UpdateEventConfigurations 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) UpdateIndexingConfiguration ¶ added in v1.12.36

func (c *IoT) UpdateIndexingConfiguration(input *UpdateIndexingConfigurationInput) (*UpdateIndexingConfigurationOutput, error)

UpdateIndexingConfiguration API operation for AWS IoT.

Updates the search configuration.

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

func (*IoT) UpdateIndexingConfigurationRequest ¶ added in v1.12.36

func (c *IoT) UpdateIndexingConfigurationRequest(input *UpdateIndexingConfigurationInput) (req *request.Request, output *UpdateIndexingConfigurationOutput)

UpdateIndexingConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateIndexingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateIndexingConfiguration for more information on using the UpdateIndexingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateIndexingConfigurationWithContext ¶ added in v1.12.36

func (c *IoT) UpdateIndexingConfigurationWithContext(ctx aws.Context, input *UpdateIndexingConfigurationInput, opts ...request.Option) (*UpdateIndexingConfigurationOutput, error)

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

See UpdateIndexingConfiguration 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) UpdateRoleAlias ¶ added in v1.12.36

func (c *IoT) UpdateRoleAlias(input *UpdateRoleAliasInput) (*UpdateRoleAliasOutput, error)

UpdateRoleAlias API operation for AWS IoT.

Updates a role alias.

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

func (*IoT) UpdateRoleAliasRequest ¶ added in v1.12.36

func (c *IoT) UpdateRoleAliasRequest(input *UpdateRoleAliasInput) (req *request.Request, output *UpdateRoleAliasOutput)

UpdateRoleAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateRoleAlias operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRoleAlias for more information on using the UpdateRoleAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateRoleAliasWithContext ¶ added in v1.12.36

func (c *IoT) UpdateRoleAliasWithContext(ctx aws.Context, input *UpdateRoleAliasInput, opts ...request.Option) (*UpdateRoleAliasOutput, error)

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

See UpdateRoleAlias 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) UpdateStream ¶ added in v1.12.51

func (c *IoT) UpdateStream(input *UpdateStreamInput) (*UpdateStreamOutput, error)

UpdateStream API operation for AWS IoT.

Updates an existing stream. The stream version will be incremented by one.

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 UpdateStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

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

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

func (*IoT) UpdateStreamRequest ¶ added in v1.12.51

func (c *IoT) UpdateStreamRequest(input *UpdateStreamInput) (req *request.Request, output *UpdateStreamOutput)

UpdateStreamRequest generates a "aws/request.Request" representing the client's request for the UpdateStream operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStream for more information on using the UpdateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateStreamWithContext ¶ added in v1.12.51

func (c *IoT) UpdateStreamWithContext(ctx aws.Context, input *UpdateStreamInput, opts ...request.Option) (*UpdateStreamOutput, error)

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

See UpdateStream 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 an entity specified with the expectedVersion parameter does not match the latest version in the system.

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

func (*IoT) UpdateThingGroup ¶ added in v1.12.36

func (c *IoT) UpdateThingGroup(input *UpdateThingGroupInput) (*UpdateThingGroupOutput, error)

UpdateThingGroup API operation for AWS IoT.

Update a thing group.

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 UpdateThingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeVersionConflictException "VersionConflictException" An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) UpdateThingGroupRequest ¶ added in v1.12.36

func (c *IoT) UpdateThingGroupRequest(input *UpdateThingGroupInput) (req *request.Request, output *UpdateThingGroupOutput)

UpdateThingGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThingGroup for more information on using the UpdateThingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateThingGroupWithContext ¶ added in v1.12.36

func (c *IoT) UpdateThingGroupWithContext(ctx aws.Context, input *UpdateThingGroupInput, opts ...request.Option) (*UpdateThingGroupOutput, error)

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

See UpdateThingGroup 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) UpdateThingGroupsForThing ¶ added in v1.12.36

func (c *IoT) UpdateThingGroupsForThing(input *UpdateThingGroupsForThingInput) (*UpdateThingGroupsForThingOutput, error)

UpdateThingGroupsForThing API operation for AWS IoT.

Updates the groups to which the thing belongs.

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 UpdateThingGroupsForThing for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeInternalFailureException "InternalFailureException" An unexpected error has occurred.

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

func (*IoT) UpdateThingGroupsForThingRequest ¶ added in v1.12.36

func (c *IoT) UpdateThingGroupsForThingRequest(input *UpdateThingGroupsForThingInput) (req *request.Request, output *UpdateThingGroupsForThingOutput)

UpdateThingGroupsForThingRequest generates a "aws/request.Request" representing the client's request for the UpdateThingGroupsForThing operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThingGroupsForThing for more information on using the UpdateThingGroupsForThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*IoT) UpdateThingGroupsForThingWithContext ¶ added in v1.12.36

func (c *IoT) UpdateThingGroupsForThingWithContext(ctx aws.Context, input *UpdateThingGroupsForThingInput, opts ...request.Option) (*UpdateThingGroupsForThingOutput, error)

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

See UpdateThingGroupsForThing 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) 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 will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThing for more information on using the UpdateThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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 IotAnalyticsAction ¶ added in v1.13.35

type IotAnalyticsAction struct {

	// (deprecated) The ARN of the IoT Analytics channel to which message data will
	// be sent.
	ChannelArn *string `locationName:"channelArn" type:"string"`

	// The name of the IoT Analytics channel to which message data will be sent.
	ChannelName *string `locationName:"channelName" type:"string"`

	// The ARN of the role which has a policy that grants IoT Analytics permission
	// to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

Sends messge data to an AWS IoT Analytics channel.

func (IotAnalyticsAction) GoString ¶ added in v1.13.35

func (s IotAnalyticsAction) GoString() string

GoString returns the string representation

func (*IotAnalyticsAction) SetChannelArn ¶ added in v1.13.35

func (s *IotAnalyticsAction) SetChannelArn(v string) *IotAnalyticsAction

SetChannelArn sets the ChannelArn field's value.

func (*IotAnalyticsAction) SetChannelName ¶ added in v1.13.35

func (s *IotAnalyticsAction) SetChannelName(v string) *IotAnalyticsAction

SetChannelName sets the ChannelName field's value.

func (*IotAnalyticsAction) SetRoleArn ¶ added in v1.13.35

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

SetRoleArn sets the RoleArn field's value.

func (IotAnalyticsAction) String ¶ added in v1.13.35

func (s IotAnalyticsAction) String() string

String returns the string representation

type Job ¶ added in v1.12.36

type Job struct {

	// If the job was updated, describes the reason for the update.
	Comment *string `locationName:"comment" type:"string"`

	// The time, in milliseconds since the epoch, when the job was completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// The parameters specified for the job document.
	DocumentParameters map[string]*string `locationName:"documentParameters" type:"map"`

	// Will be true if the job was canceled with the optional force parameter set
	// to true.
	ForceCanceled *bool `locationName:"forceCanceled" type:"boolean"`

	// An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
	JobArn *string `locationName:"jobArn" type:"string"`

	// Allows you to create a staged rollout of a job.
	JobExecutionsRolloutConfig *JobExecutionsRolloutConfig `locationName:"jobExecutionsRolloutConfig" type:"structure"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`

	// Details about the job process.
	JobProcessDetails *JobProcessDetails `locationName:"jobProcessDetails" type:"structure"`

	// The time, in milliseconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"`

	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"`

	// The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
	Status *string `locationName:"status" type:"string" enum:"JobStatus"`

	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected
	// in a target. For example, a job will run on a device when the thing representing
	// the device is added to a target group, even after the job was completed by
	// all things originally in the group.
	TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// A list of IoT things and thing groups to which the job should be sent.
	Targets []*string `locationName:"targets" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The Job object contains details about a job.

func (Job) GoString ¶ added in v1.12.36

func (s Job) GoString() string

GoString returns the string representation

func (*Job) SetComment ¶ added in v1.12.36

func (s *Job) SetComment(v string) *Job

SetComment sets the Comment field's value.

func (*Job) SetCompletedAt ¶ added in v1.12.36

func (s *Job) SetCompletedAt(v time.Time) *Job

SetCompletedAt sets the CompletedAt field's value.

func (*Job) SetCreatedAt ¶ added in v1.12.36

func (s *Job) SetCreatedAt(v time.Time) *Job

SetCreatedAt sets the CreatedAt field's value.

func (*Job) SetDescription ¶ added in v1.12.36

func (s *Job) SetDescription(v string) *Job

SetDescription sets the Description field's value.

func (*Job) SetDocumentParameters ¶ added in v1.12.36

func (s *Job) SetDocumentParameters(v map[string]*string) *Job

SetDocumentParameters sets the DocumentParameters field's value.

func (*Job) SetForceCanceled ¶ added in v1.13.60

func (s *Job) SetForceCanceled(v bool) *Job

SetForceCanceled sets the ForceCanceled field's value.

func (*Job) SetJobArn ¶ added in v1.12.36

func (s *Job) SetJobArn(v string) *Job

SetJobArn sets the JobArn field's value.

func (*Job) SetJobExecutionsRolloutConfig ¶ added in v1.12.36

func (s *Job) SetJobExecutionsRolloutConfig(v *JobExecutionsRolloutConfig) *Job

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*Job) SetJobId ¶ added in v1.12.36

func (s *Job) SetJobId(v string) *Job

SetJobId sets the JobId field's value.

func (*Job) SetJobProcessDetails ¶ added in v1.12.36

func (s *Job) SetJobProcessDetails(v *JobProcessDetails) *Job

SetJobProcessDetails sets the JobProcessDetails field's value.

func (*Job) SetLastUpdatedAt ¶ added in v1.12.36

func (s *Job) SetLastUpdatedAt(v time.Time) *Job

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*Job) SetPresignedUrlConfig ¶ added in v1.12.36

func (s *Job) SetPresignedUrlConfig(v *PresignedUrlConfig) *Job

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

func (*Job) SetStatus ¶ added in v1.12.36

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

SetStatus sets the Status field's value.

func (*Job) SetTargetSelection ¶ added in v1.12.36

func (s *Job) SetTargetSelection(v string) *Job

SetTargetSelection sets the TargetSelection field's value.

func (*Job) SetTargets ¶ added in v1.12.36

func (s *Job) SetTargets(v []*string) *Job

SetTargets sets the Targets field's value.

func (Job) String ¶ added in v1.12.36

func (s Job) String() string

String returns the string representation

type JobExecution ¶ added in v1.12.36

type JobExecution struct {

	// A string (consisting of the digits "0" through "9") which identifies this
	// particular job execution on this particular device. It can be used in commands
	// which return or update job execution information.
	ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`

	// Will be true if the job execution was canceled with the optional force parameter
	// set to true.
	ForceCanceled *bool `locationName:"forceCanceled" type:"boolean"`

	// The unique identifier you assigned to the job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time `locationName:"queuedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job execution started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"unix"`

	// The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED,
	// or REJECTED).
	Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails *JobExecutionStatusDetails `locationName:"statusDetails" type:"structure"`

	// The ARN of the thing on which the job execution is running.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The version of the job execution. Job execution versions are incremented
	// each time they are updated by a device.
	VersionNumber *int64 `locationName:"versionNumber" type:"long"`
	// contains filtered or unexported fields
}

The job execution object represents the execution of a job on a particular device.

func (JobExecution) GoString ¶ added in v1.12.36

func (s JobExecution) GoString() string

GoString returns the string representation

func (*JobExecution) SetExecutionNumber ¶ added in v1.12.36

func (s *JobExecution) SetExecutionNumber(v int64) *JobExecution

SetExecutionNumber sets the ExecutionNumber field's value.

func (*JobExecution) SetForceCanceled ¶ added in v1.13.60

func (s *JobExecution) SetForceCanceled(v bool) *JobExecution

SetForceCanceled sets the ForceCanceled field's value.

func (*JobExecution) SetJobId ¶ added in v1.12.36

func (s *JobExecution) SetJobId(v string) *JobExecution

SetJobId sets the JobId field's value.

func (*JobExecution) SetLastUpdatedAt ¶ added in v1.12.36

func (s *JobExecution) SetLastUpdatedAt(v time.Time) *JobExecution

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*JobExecution) SetQueuedAt ¶ added in v1.12.36

func (s *JobExecution) SetQueuedAt(v time.Time) *JobExecution

SetQueuedAt sets the QueuedAt field's value.

func (*JobExecution) SetStartedAt ¶ added in v1.12.36

func (s *JobExecution) SetStartedAt(v time.Time) *JobExecution

SetStartedAt sets the StartedAt field's value.

func (*JobExecution) SetStatus ¶ added in v1.12.36

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

SetStatus sets the Status field's value.

func (*JobExecution) SetStatusDetails ¶ added in v1.12.36

func (s *JobExecution) SetStatusDetails(v *JobExecutionStatusDetails) *JobExecution

SetStatusDetails sets the StatusDetails field's value.

func (*JobExecution) SetThingArn ¶ added in v1.12.36

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

SetThingArn sets the ThingArn field's value.

func (*JobExecution) SetVersionNumber ¶ added in v1.13.60

func (s *JobExecution) SetVersionNumber(v int64) *JobExecution

SetVersionNumber sets the VersionNumber field's value.

func (JobExecution) String ¶ added in v1.12.36

func (s JobExecution) String() string

String returns the string representation

type JobExecutionStatusDetails ¶ added in v1.12.36

type JobExecutionStatusDetails struct {

	// The job execution status.
	DetailsMap map[string]*string `locationName:"detailsMap" type:"map"`
	// contains filtered or unexported fields
}

Details of the job execution status.

func (JobExecutionStatusDetails) GoString ¶ added in v1.12.36

func (s JobExecutionStatusDetails) GoString() string

GoString returns the string representation

func (*JobExecutionStatusDetails) SetDetailsMap ¶ added in v1.12.36

SetDetailsMap sets the DetailsMap field's value.

func (JobExecutionStatusDetails) String ¶ added in v1.12.36

func (s JobExecutionStatusDetails) String() string

String returns the string representation

type JobExecutionSummary ¶ added in v1.12.36

type JobExecutionSummary struct {

	// A string (consisting of the digits "0" through "9") which identifies this
	// particular job execution on this particular device. It can be used later
	// in commands which return or update job execution information.
	ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time `locationName:"queuedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job execution started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"unix"`

	// The status of the job execution.
	Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`
	// contains filtered or unexported fields
}

The job execution summary.

func (JobExecutionSummary) GoString ¶ added in v1.12.36

func (s JobExecutionSummary) GoString() string

GoString returns the string representation

func (*JobExecutionSummary) SetExecutionNumber ¶ added in v1.12.36

func (s *JobExecutionSummary) SetExecutionNumber(v int64) *JobExecutionSummary

SetExecutionNumber sets the ExecutionNumber field's value.

func (*JobExecutionSummary) SetLastUpdatedAt ¶ added in v1.12.36

func (s *JobExecutionSummary) SetLastUpdatedAt(v time.Time) *JobExecutionSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*JobExecutionSummary) SetQueuedAt ¶ added in v1.12.36

func (s *JobExecutionSummary) SetQueuedAt(v time.Time) *JobExecutionSummary

SetQueuedAt sets the QueuedAt field's value.

func (*JobExecutionSummary) SetStartedAt ¶ added in v1.12.36

func (s *JobExecutionSummary) SetStartedAt(v time.Time) *JobExecutionSummary

SetStartedAt sets the StartedAt field's value.

func (*JobExecutionSummary) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (JobExecutionSummary) String ¶ added in v1.12.36

func (s JobExecutionSummary) String() string

String returns the string representation

type JobExecutionSummaryForJob ¶ added in v1.12.36

type JobExecutionSummaryForJob struct {

	// Contains a subset of information about a job execution.
	JobExecutionSummary *JobExecutionSummary `locationName:"jobExecutionSummary" type:"structure"`

	// The ARN of the thing on which the job execution is running.
	ThingArn *string `locationName:"thingArn" type:"string"`
	// contains filtered or unexported fields
}

Contains a summary of information about job executions for a specific job.

func (JobExecutionSummaryForJob) GoString ¶ added in v1.12.36

func (s JobExecutionSummaryForJob) GoString() string

GoString returns the string representation

func (*JobExecutionSummaryForJob) SetJobExecutionSummary ¶ added in v1.12.36

SetJobExecutionSummary sets the JobExecutionSummary field's value.

func (*JobExecutionSummaryForJob) SetThingArn ¶ added in v1.12.36

SetThingArn sets the ThingArn field's value.

func (JobExecutionSummaryForJob) String ¶ added in v1.12.36

func (s JobExecutionSummaryForJob) String() string

String returns the string representation

type JobExecutionSummaryForThing ¶ added in v1.12.36

type JobExecutionSummaryForThing struct {

	// Contains a subset of information about a job execution.
	JobExecutionSummary *JobExecutionSummary `locationName:"jobExecutionSummary" type:"structure"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The job execution summary for a thing.

func (JobExecutionSummaryForThing) GoString ¶ added in v1.12.36

func (s JobExecutionSummaryForThing) GoString() string

GoString returns the string representation

func (*JobExecutionSummaryForThing) SetJobExecutionSummary ¶ added in v1.12.36

SetJobExecutionSummary sets the JobExecutionSummary field's value.

func (*JobExecutionSummaryForThing) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (JobExecutionSummaryForThing) String ¶ added in v1.12.36

String returns the string representation

type JobExecutionsRolloutConfig ¶ added in v1.12.36

type JobExecutionsRolloutConfig struct {

	// The maximum number of things that will be notified of a pending job, per
	// minute. This parameter allows you to create a staged rollout.
	MaximumPerMinute *int64 `locationName:"maximumPerMinute" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Allows you to create a staged rollout of a job.

func (JobExecutionsRolloutConfig) GoString ¶ added in v1.12.36

func (s JobExecutionsRolloutConfig) GoString() string

GoString returns the string representation

func (*JobExecutionsRolloutConfig) SetMaximumPerMinute ¶ added in v1.12.36

func (s *JobExecutionsRolloutConfig) SetMaximumPerMinute(v int64) *JobExecutionsRolloutConfig

SetMaximumPerMinute sets the MaximumPerMinute field's value.

func (JobExecutionsRolloutConfig) String ¶ added in v1.12.36

String returns the string representation

func (*JobExecutionsRolloutConfig) Validate ¶ added in v1.12.36

func (s *JobExecutionsRolloutConfig) Validate() error

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

type JobProcessDetails ¶ added in v1.12.36

type JobProcessDetails struct {

	// The number of things that cancelled the job.
	NumberOfCanceledThings *int64 `locationName:"numberOfCanceledThings" type:"integer"`

	// The number of things that failed executing the job.
	NumberOfFailedThings *int64 `locationName:"numberOfFailedThings" type:"integer"`

	// The number of things currently executing the job.
	NumberOfInProgressThings *int64 `locationName:"numberOfInProgressThings" type:"integer"`

	// The number of things that are awaiting execution of the job.
	NumberOfQueuedThings *int64 `locationName:"numberOfQueuedThings" type:"integer"`

	// The number of things that rejected the job.
	NumberOfRejectedThings *int64 `locationName:"numberOfRejectedThings" type:"integer"`

	// The number of things that are no longer scheduled to execute the job because
	// they have been deleted or have been removed from the group that was a target
	// of the job.
	NumberOfRemovedThings *int64 `locationName:"numberOfRemovedThings" type:"integer"`

	// The number of things which successfully completed the job.
	NumberOfSucceededThings *int64 `locationName:"numberOfSucceededThings" type:"integer"`

	// The target devices to which the job execution is being rolled out. This value
	// will be null after the job execution has finished rolling out to all the
	// target devices.
	ProcessingTargets []*string `locationName:"processingTargets" type:"list"`
	// contains filtered or unexported fields
}

The job process details.

func (JobProcessDetails) GoString ¶ added in v1.12.36

func (s JobProcessDetails) GoString() string

GoString returns the string representation

func (*JobProcessDetails) SetNumberOfCanceledThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfCanceledThings(v int64) *JobProcessDetails

SetNumberOfCanceledThings sets the NumberOfCanceledThings field's value.

func (*JobProcessDetails) SetNumberOfFailedThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfFailedThings(v int64) *JobProcessDetails

SetNumberOfFailedThings sets the NumberOfFailedThings field's value.

func (*JobProcessDetails) SetNumberOfInProgressThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfInProgressThings(v int64) *JobProcessDetails

SetNumberOfInProgressThings sets the NumberOfInProgressThings field's value.

func (*JobProcessDetails) SetNumberOfQueuedThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfQueuedThings(v int64) *JobProcessDetails

SetNumberOfQueuedThings sets the NumberOfQueuedThings field's value.

func (*JobProcessDetails) SetNumberOfRejectedThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfRejectedThings(v int64) *JobProcessDetails

SetNumberOfRejectedThings sets the NumberOfRejectedThings field's value.

func (*JobProcessDetails) SetNumberOfRemovedThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfRemovedThings(v int64) *JobProcessDetails

SetNumberOfRemovedThings sets the NumberOfRemovedThings field's value.

func (*JobProcessDetails) SetNumberOfSucceededThings ¶ added in v1.12.36

func (s *JobProcessDetails) SetNumberOfSucceededThings(v int64) *JobProcessDetails

SetNumberOfSucceededThings sets the NumberOfSucceededThings field's value.

func (*JobProcessDetails) SetProcessingTargets ¶ added in v1.12.36

func (s *JobProcessDetails) SetProcessingTargets(v []*string) *JobProcessDetails

SetProcessingTargets sets the ProcessingTargets field's value.

func (JobProcessDetails) String ¶ added in v1.12.36

func (s JobProcessDetails) String() string

String returns the string representation

type JobSummary ¶ added in v1.12.36

type JobSummary struct {

	// The time, in milliseconds since the epoch, when the job completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp" timestampFormat:"unix"`

	// The time, in milliseconds since the epoch, when the job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The job ARN.
	JobArn *string `locationName:"jobArn" type:"string"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`

	// The time, in milliseconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"`

	// The job summary status.
	Status *string `locationName:"status" type:"string" enum:"JobStatus"`

	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected
	// in a target. For example, a job will run on a thing when the thing is added
	// to a target group, even after the job was completed by all things originally
	// in the group.
	TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// The ID of the thing group.
	ThingGroupId *string `locationName:"thingGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The job summary.

func (JobSummary) GoString ¶ added in v1.12.36

func (s JobSummary) GoString() string

GoString returns the string representation

func (*JobSummary) SetCompletedAt ¶ added in v1.12.36

func (s *JobSummary) SetCompletedAt(v time.Time) *JobSummary

SetCompletedAt sets the CompletedAt field's value.

func (*JobSummary) SetCreatedAt ¶ added in v1.12.36

func (s *JobSummary) SetCreatedAt(v time.Time) *JobSummary

SetCreatedAt sets the CreatedAt field's value.

func (*JobSummary) SetJobArn ¶ added in v1.12.36

func (s *JobSummary) SetJobArn(v string) *JobSummary

SetJobArn sets the JobArn field's value.

func (*JobSummary) SetJobId ¶ added in v1.12.36

func (s *JobSummary) SetJobId(v string) *JobSummary

SetJobId sets the JobId field's value.

func (*JobSummary) SetLastUpdatedAt ¶ added in v1.12.36

func (s *JobSummary) SetLastUpdatedAt(v time.Time) *JobSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*JobSummary) SetStatus ¶ added in v1.12.36

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

SetStatus sets the Status field's value.

func (*JobSummary) SetTargetSelection ¶ added in v1.12.36

func (s *JobSummary) SetTargetSelection(v string) *JobSummary

SetTargetSelection sets the TargetSelection field's value.

func (*JobSummary) SetThingGroupId ¶ added in v1.12.36

func (s *JobSummary) SetThingGroupId(v string) *JobSummary

SetThingGroupId sets the ThingGroupId field's value.

func (JobSummary) String ¶ added in v1.12.36

func (s JobSummary) String() string

String returns the string representation

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 ListAttachedPoliciesInput ¶ added in v1.12.36

type ListAttachedPoliciesInput struct {

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

	// The maximum number of results to be returned per request.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

	// When true, recursively list attached policies.
	Recursive *bool `location:"querystring" locationName:"recursive" type:"boolean"`

	// The group for which the policies will be listed.
	//
	// Target is a required field
	Target *string `location:"uri" locationName:"target" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAttachedPoliciesInput) GoString ¶ added in v1.12.36

func (s ListAttachedPoliciesInput) GoString() string

GoString returns the string representation

func (*ListAttachedPoliciesInput) SetMarker ¶ added in v1.12.36

SetMarker sets the Marker field's value.

func (*ListAttachedPoliciesInput) SetPageSize ¶ added in v1.12.36

SetPageSize sets the PageSize field's value.

func (*ListAttachedPoliciesInput) SetRecursive ¶ added in v1.12.36

SetRecursive sets the Recursive field's value.

func (*ListAttachedPoliciesInput) SetTarget ¶ added in v1.12.36

SetTarget sets the Target field's value.

func (ListAttachedPoliciesInput) String ¶ added in v1.12.36

func (s ListAttachedPoliciesInput) String() string

String returns the string representation

func (*ListAttachedPoliciesInput) Validate ¶ added in v1.12.36

func (s *ListAttachedPoliciesInput) Validate() error

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

type ListAttachedPoliciesOutput ¶ added in v1.12.36

type ListAttachedPoliciesOutput struct {

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

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

func (ListAttachedPoliciesOutput) GoString ¶ added in v1.12.36

func (s ListAttachedPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListAttachedPoliciesOutput) SetNextMarker ¶ added in v1.12.36

SetNextMarker sets the NextMarker field's value.

func (*ListAttachedPoliciesOutput) SetPolicies ¶ added in v1.12.36

SetPolicies sets the Policies field's value.

func (ListAttachedPoliciesOutput) String ¶ added in v1.12.36

String returns the string representation

type ListAuthorizersInput ¶ added in v1.12.36

type ListAuthorizersInput struct {

	// Return the list of authorizers in ascending alphabetical order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// A marker used to get the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The maximum number of results to return at one time.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

	// The status of the list authorizers request.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"AuthorizerStatus"`
	// contains filtered or unexported fields
}

func (ListAuthorizersInput) GoString ¶ added in v1.12.36

func (s ListAuthorizersInput) GoString() string

GoString returns the string representation

func (*ListAuthorizersInput) SetAscendingOrder ¶ added in v1.12.36

func (s *ListAuthorizersInput) SetAscendingOrder(v bool) *ListAuthorizersInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListAuthorizersInput) SetMarker ¶ added in v1.12.36

SetMarker sets the Marker field's value.

func (*ListAuthorizersInput) SetPageSize ¶ added in v1.12.36

func (s *ListAuthorizersInput) SetPageSize(v int64) *ListAuthorizersInput

SetPageSize sets the PageSize field's value.

func (*ListAuthorizersInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (ListAuthorizersInput) String ¶ added in v1.12.36

func (s ListAuthorizersInput) String() string

String returns the string representation

func (*ListAuthorizersInput) Validate ¶ added in v1.12.36

func (s *ListAuthorizersInput) Validate() error

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

type ListAuthorizersOutput ¶ added in v1.12.36

type ListAuthorizersOutput struct {

	// The authorizers.
	Authorizers []*AuthorizerSummary `locationName:"authorizers" type:"list"`

	// A marker used to get the next set of results.
	NextMarker *string `locationName:"nextMarker" type:"string"`
	// contains filtered or unexported fields
}

func (ListAuthorizersOutput) GoString ¶ added in v1.12.36

func (s ListAuthorizersOutput) GoString() string

GoString returns the string representation

func (*ListAuthorizersOutput) SetAuthorizers ¶ added in v1.12.36

SetAuthorizers sets the Authorizers field's value.

func (*ListAuthorizersOutput) SetNextMarker ¶ added in v1.12.36

func (s *ListAuthorizersOutput) SetNextMarker(v string) *ListAuthorizersOutput

SetNextMarker sets the NextMarker field's value.

func (ListAuthorizersOutput) String ¶ added in v1.12.36

func (s ListAuthorizersOutput) String() string

String returns the string representation

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 ListIndicesInput ¶ added in v1.12.36

type ListIndicesInput struct {

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

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

func (ListIndicesInput) GoString ¶ added in v1.12.36

func (s ListIndicesInput) GoString() string

GoString returns the string representation

func (*ListIndicesInput) SetMaxResults ¶ added in v1.12.36

func (s *ListIndicesInput) SetMaxResults(v int64) *ListIndicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndicesInput) SetNextToken ¶ added in v1.12.36

func (s *ListIndicesInput) SetNextToken(v string) *ListIndicesInput

SetNextToken sets the NextToken field's value.

func (ListIndicesInput) String ¶ added in v1.12.36

func (s ListIndicesInput) String() string

String returns the string representation

func (*ListIndicesInput) Validate ¶ added in v1.12.36

func (s *ListIndicesInput) Validate() error

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

type ListIndicesOutput ¶ added in v1.12.36

type ListIndicesOutput struct {

	// The index names.
	IndexNames []*string `locationName:"indexNames" type:"list"`

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

func (ListIndicesOutput) GoString ¶ added in v1.12.36

func (s ListIndicesOutput) GoString() string

GoString returns the string representation

func (*ListIndicesOutput) SetIndexNames ¶ added in v1.12.36

func (s *ListIndicesOutput) SetIndexNames(v []*string) *ListIndicesOutput

SetIndexNames sets the IndexNames field's value.

func (*ListIndicesOutput) SetNextToken ¶ added in v1.12.36

func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput

SetNextToken sets the NextToken field's value.

func (ListIndicesOutput) String ¶ added in v1.12.36

func (s ListIndicesOutput) String() string

String returns the string representation

type ListJobExecutionsForJobInput ¶ added in v1.12.36

type ListJobExecutionsForJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

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

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

	// The status of the job.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"JobExecutionStatus"`
	// contains filtered or unexported fields
}

func (ListJobExecutionsForJobInput) GoString ¶ added in v1.12.36

func (s ListJobExecutionsForJobInput) GoString() string

GoString returns the string representation

func (*ListJobExecutionsForJobInput) SetJobId ¶ added in v1.12.36

SetJobId sets the JobId field's value.

func (*ListJobExecutionsForJobInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListJobExecutionsForJobInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListJobExecutionsForJobInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (ListJobExecutionsForJobInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListJobExecutionsForJobInput) Validate ¶ added in v1.12.36

func (s *ListJobExecutionsForJobInput) Validate() error

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

type ListJobExecutionsForJobOutput ¶ added in v1.12.36

type ListJobExecutionsForJobOutput struct {

	// A list of job execution summaries.
	ExecutionSummaries []*JobExecutionSummaryForJob `locationName:"executionSummaries" type:"list"`

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

func (ListJobExecutionsForJobOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListJobExecutionsForJobOutput) SetExecutionSummaries ¶ added in v1.12.36

SetExecutionSummaries sets the ExecutionSummaries field's value.

func (*ListJobExecutionsForJobOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (ListJobExecutionsForJobOutput) String ¶ added in v1.12.36

String returns the string representation

type ListJobExecutionsForThingInput ¶ added in v1.12.36

type ListJobExecutionsForThingInput struct {

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

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

	// An optional filter that lets you search for jobs that have the specified
	// status.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"JobExecutionStatus"`

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

func (ListJobExecutionsForThingInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListJobExecutionsForThingInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListJobExecutionsForThingInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListJobExecutionsForThingInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (*ListJobExecutionsForThingInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (ListJobExecutionsForThingInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListJobExecutionsForThingInput) Validate ¶ added in v1.12.36

func (s *ListJobExecutionsForThingInput) Validate() error

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

type ListJobExecutionsForThingOutput ¶ added in v1.12.36

type ListJobExecutionsForThingOutput struct {

	// A list of job execution summaries.
	ExecutionSummaries []*JobExecutionSummaryForThing `locationName:"executionSummaries" type:"list"`

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

func (ListJobExecutionsForThingOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListJobExecutionsForThingOutput) SetExecutionSummaries ¶ added in v1.12.36

SetExecutionSummaries sets the ExecutionSummaries field's value.

func (*ListJobExecutionsForThingOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (ListJobExecutionsForThingOutput) String ¶ added in v1.12.36

String returns the string representation

type ListJobsInput ¶ added in v1.12.36

type ListJobsInput struct {

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

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

	// An optional filter that lets you search for jobs that have the specified
	// status.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"JobStatus"`

	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected
	// in a target. For example, a job will run on a thing when the thing is added
	// to a target group, even after the job was completed by all things originally
	// in the group.
	TargetSelection *string `location:"querystring" locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupId *string `location:"querystring" locationName:"thingGroupId" min:"1" type:"string"`

	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupName *string `location:"querystring" locationName:"thingGroupName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListJobsInput) GoString ¶ added in v1.12.36

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetMaxResults ¶ added in v1.12.36

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNextToken ¶ added in v1.12.36

func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput

SetNextToken sets the NextToken field's value.

func (*ListJobsInput) SetStatus ¶ added in v1.12.36

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

SetStatus sets the Status field's value.

func (*ListJobsInput) SetTargetSelection ¶ added in v1.12.36

func (s *ListJobsInput) SetTargetSelection(v string) *ListJobsInput

SetTargetSelection sets the TargetSelection field's value.

func (*ListJobsInput) SetThingGroupId ¶ added in v1.12.36

func (s *ListJobsInput) SetThingGroupId(v string) *ListJobsInput

SetThingGroupId sets the ThingGroupId field's value.

func (*ListJobsInput) SetThingGroupName ¶ added in v1.12.36

func (s *ListJobsInput) SetThingGroupName(v string) *ListJobsInput

SetThingGroupName sets the ThingGroupName field's value.

func (ListJobsInput) String ¶ added in v1.12.36

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate ¶ added in v1.12.36

func (s *ListJobsInput) Validate() error

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

type ListJobsOutput ¶ added in v1.12.36

type ListJobsOutput struct {

	// A list of jobs.
	Jobs []*JobSummary `locationName:"jobs" type:"list"`

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

func (ListJobsOutput) GoString ¶ added in v1.12.36

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobs ¶ added in v1.12.36

func (s *ListJobsOutput) SetJobs(v []*JobSummary) *ListJobsOutput

SetJobs sets the Jobs field's value.

func (*ListJobsOutput) SetNextToken ¶ added in v1.12.36

func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String ¶ added in v1.12.36

func (s ListJobsOutput) String() string

String returns the string representation

type ListOTAUpdatesInput ¶ added in v1.12.51

type ListOTAUpdatesInput struct {

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

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

	// The OTA update job status.
	OtaUpdateStatus *string `location:"querystring" locationName:"otaUpdateStatus" type:"string" enum:"OTAUpdateStatus"`
	// contains filtered or unexported fields
}

func (ListOTAUpdatesInput) GoString ¶ added in v1.12.51

func (s ListOTAUpdatesInput) GoString() string

GoString returns the string representation

func (*ListOTAUpdatesInput) SetMaxResults ¶ added in v1.12.51

func (s *ListOTAUpdatesInput) SetMaxResults(v int64) *ListOTAUpdatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListOTAUpdatesInput) SetNextToken ¶ added in v1.12.51

func (s *ListOTAUpdatesInput) SetNextToken(v string) *ListOTAUpdatesInput

SetNextToken sets the NextToken field's value.

func (*ListOTAUpdatesInput) SetOtaUpdateStatus ¶ added in v1.12.51

func (s *ListOTAUpdatesInput) SetOtaUpdateStatus(v string) *ListOTAUpdatesInput

SetOtaUpdateStatus sets the OtaUpdateStatus field's value.

func (ListOTAUpdatesInput) String ¶ added in v1.12.51

func (s ListOTAUpdatesInput) String() string

String returns the string representation

func (*ListOTAUpdatesInput) Validate ¶ added in v1.12.51

func (s *ListOTAUpdatesInput) Validate() error

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

type ListOTAUpdatesOutput ¶ added in v1.12.51

type ListOTAUpdatesOutput struct {

	// A token to use to get the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of OTA update jobs.
	OtaUpdates []*OTAUpdateSummary `locationName:"otaUpdates" type:"list"`
	// contains filtered or unexported fields
}

func (ListOTAUpdatesOutput) GoString ¶ added in v1.12.51

func (s ListOTAUpdatesOutput) GoString() string

GoString returns the string representation

func (*ListOTAUpdatesOutput) SetNextToken ¶ added in v1.12.51

func (s *ListOTAUpdatesOutput) SetNextToken(v string) *ListOTAUpdatesOutput

SetNextToken sets the NextToken field's value.

func (*ListOTAUpdatesOutput) SetOtaUpdates ¶ added in v1.12.51

SetOtaUpdates sets the OtaUpdates field's value.

func (ListOTAUpdatesOutput) String ¶ added in v1.12.51

func (s ListOTAUpdatesOutput) 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 transferred 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 used to get 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 used to get 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 ListRoleAliasesInput ¶ added in v1.12.36

type ListRoleAliasesInput struct {

	// Return the list of role aliases in ascending alphabetical order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

	// A marker used to get the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The maximum number of results to return at one time.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (ListRoleAliasesInput) GoString ¶ added in v1.12.36

func (s ListRoleAliasesInput) GoString() string

GoString returns the string representation

func (*ListRoleAliasesInput) SetAscendingOrder ¶ added in v1.12.36

func (s *ListRoleAliasesInput) SetAscendingOrder(v bool) *ListRoleAliasesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListRoleAliasesInput) SetMarker ¶ added in v1.12.36

SetMarker sets the Marker field's value.

func (*ListRoleAliasesInput) SetPageSize ¶ added in v1.12.36

func (s *ListRoleAliasesInput) SetPageSize(v int64) *ListRoleAliasesInput

SetPageSize sets the PageSize field's value.

func (ListRoleAliasesInput) String ¶ added in v1.12.36

func (s ListRoleAliasesInput) String() string

String returns the string representation

func (*ListRoleAliasesInput) Validate ¶ added in v1.12.36

func (s *ListRoleAliasesInput) Validate() error

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

type ListRoleAliasesOutput ¶ added in v1.12.36

type ListRoleAliasesOutput struct {

	// A marker used to get the next set of results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The role aliases.
	RoleAliases []*string `locationName:"roleAliases" type:"list"`
	// contains filtered or unexported fields
}

func (ListRoleAliasesOutput) GoString ¶ added in v1.12.36

func (s ListRoleAliasesOutput) GoString() string

GoString returns the string representation

func (*ListRoleAliasesOutput) SetNextMarker ¶ added in v1.12.36

func (s *ListRoleAliasesOutput) SetNextMarker(v string) *ListRoleAliasesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListRoleAliasesOutput) SetRoleAliases ¶ added in v1.12.36

func (s *ListRoleAliasesOutput) SetRoleAliases(v []*string) *ListRoleAliasesOutput

SetRoleAliases sets the RoleAliases field's value.

func (ListRoleAliasesOutput) String ¶ added in v1.12.36

func (s ListRoleAliasesOutput) String() string

String returns the string representation

type ListStreamsInput ¶ added in v1.12.51

type ListStreamsInput struct {

	// Set to true to return the list of streams in ascending order.
	AscendingOrder *bool `location:"querystring" locationName:"isAscendingOrder" type:"boolean"`

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

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

func (ListStreamsInput) GoString ¶ added in v1.12.51

func (s ListStreamsInput) GoString() string

GoString returns the string representation

func (*ListStreamsInput) SetAscendingOrder ¶ added in v1.12.51

func (s *ListStreamsInput) SetAscendingOrder(v bool) *ListStreamsInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListStreamsInput) SetMaxResults ¶ added in v1.12.51

func (s *ListStreamsInput) SetMaxResults(v int64) *ListStreamsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamsInput) SetNextToken ¶ added in v1.12.51

func (s *ListStreamsInput) SetNextToken(v string) *ListStreamsInput

SetNextToken sets the NextToken field's value.

func (ListStreamsInput) String ¶ added in v1.12.51

func (s ListStreamsInput) String() string

String returns the string representation

func (*ListStreamsInput) Validate ¶ added in v1.12.51

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput ¶ added in v1.12.51

type ListStreamsOutput struct {

	// A token used to get the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of streams.
	Streams []*StreamSummary `locationName:"streams" type:"list"`
	// contains filtered or unexported fields
}

func (ListStreamsOutput) GoString ¶ added in v1.12.51

func (s ListStreamsOutput) GoString() string

GoString returns the string representation

func (*ListStreamsOutput) SetNextToken ¶ added in v1.12.51

func (s *ListStreamsOutput) SetNextToken(v string) *ListStreamsOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamsOutput) SetStreams ¶ added in v1.12.51

func (s *ListStreamsOutput) SetStreams(v []*StreamSummary) *ListStreamsOutput

SetStreams sets the Streams field's value.

func (ListStreamsOutput) String ¶ added in v1.12.51

func (s ListStreamsOutput) String() string

String returns the string representation

type ListTargetsForPolicyInput ¶ added in v1.12.36

type ListTargetsForPolicyInput struct {

	// A marker used to get the next set of results.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The maximum number of results to return at one time.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

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

func (ListTargetsForPolicyInput) GoString ¶ added in v1.12.36

func (s ListTargetsForPolicyInput) GoString() string

GoString returns the string representation

func (*ListTargetsForPolicyInput) SetMarker ¶ added in v1.12.36

SetMarker sets the Marker field's value.

func (*ListTargetsForPolicyInput) SetPageSize ¶ added in v1.12.36

SetPageSize sets the PageSize field's value.

func (*ListTargetsForPolicyInput) SetPolicyName ¶ added in v1.12.36

SetPolicyName sets the PolicyName field's value.

func (ListTargetsForPolicyInput) String ¶ added in v1.12.36

func (s ListTargetsForPolicyInput) String() string

String returns the string representation

func (*ListTargetsForPolicyInput) Validate ¶ added in v1.12.36

func (s *ListTargetsForPolicyInput) Validate() error

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

type ListTargetsForPolicyOutput ¶ added in v1.12.36

type ListTargetsForPolicyOutput struct {

	// A marker used to get the next set of results.
	NextMarker *string `locationName:"nextMarker" type:"string"`

	// The policy targets.
	Targets []*string `locationName:"targets" type:"list"`
	// contains filtered or unexported fields
}

func (ListTargetsForPolicyOutput) GoString ¶ added in v1.12.36

func (s ListTargetsForPolicyOutput) GoString() string

GoString returns the string representation

func (*ListTargetsForPolicyOutput) SetNextMarker ¶ added in v1.12.36

SetNextMarker sets the NextMarker field's value.

func (*ListTargetsForPolicyOutput) SetTargets ¶ added in v1.12.36

SetTargets sets the Targets field's value.

func (ListTargetsForPolicyOutput) String ¶ added in v1.12.36

String returns the string representation

type ListThingGroupsForThingInput ¶ added in v1.12.36

type ListThingGroupsForThingInput struct {

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

	// The token used to get the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

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

func (ListThingGroupsForThingInput) GoString ¶ added in v1.12.36

func (s ListThingGroupsForThingInput) GoString() string

GoString returns the string representation

func (*ListThingGroupsForThingInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListThingGroupsForThingInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsForThingInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (ListThingGroupsForThingInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListThingGroupsForThingInput) Validate ¶ added in v1.12.36

func (s *ListThingGroupsForThingInput) Validate() error

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

type ListThingGroupsForThingOutput ¶ added in v1.12.36

type ListThingGroupsForThingOutput struct {

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

	// The thing groups.
	ThingGroups []*GroupNameAndArn `locationName:"thingGroups" type:"list"`
	// contains filtered or unexported fields
}

func (ListThingGroupsForThingOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListThingGroupsForThingOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsForThingOutput) SetThingGroups ¶ added in v1.12.36

SetThingGroups sets the ThingGroups field's value.

func (ListThingGroupsForThingOutput) String ¶ added in v1.12.36

String returns the string representation

type ListThingGroupsInput ¶ added in v1.12.36

type ListThingGroupsInput struct {

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

	// A filter that limits the results to those with the specified name prefix.
	NamePrefixFilter *string `location:"querystring" locationName:"namePrefixFilter" min:"1" type:"string"`

	// The token used to get the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// A filter that limits the results to those with the specified parent group.
	ParentGroup *string `location:"querystring" locationName:"parentGroup" min:"1" type:"string"`

	// If true, return child groups as well.
	Recursive *bool `location:"querystring" locationName:"recursive" type:"boolean"`
	// contains filtered or unexported fields
}

func (ListThingGroupsInput) GoString ¶ added in v1.12.36

func (s ListThingGroupsInput) GoString() string

GoString returns the string representation

func (*ListThingGroupsInput) SetMaxResults ¶ added in v1.12.36

func (s *ListThingGroupsInput) SetMaxResults(v int64) *ListThingGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingGroupsInput) SetNamePrefixFilter ¶ added in v1.12.36

func (s *ListThingGroupsInput) SetNamePrefixFilter(v string) *ListThingGroupsInput

SetNamePrefixFilter sets the NamePrefixFilter field's value.

func (*ListThingGroupsInput) SetNextToken ¶ added in v1.12.36

func (s *ListThingGroupsInput) SetNextToken(v string) *ListThingGroupsInput

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsInput) SetParentGroup ¶ added in v1.12.36

func (s *ListThingGroupsInput) SetParentGroup(v string) *ListThingGroupsInput

SetParentGroup sets the ParentGroup field's value.

func (*ListThingGroupsInput) SetRecursive ¶ added in v1.12.36

func (s *ListThingGroupsInput) SetRecursive(v bool) *ListThingGroupsInput

SetRecursive sets the Recursive field's value.

func (ListThingGroupsInput) String ¶ added in v1.12.36

func (s ListThingGroupsInput) String() string

String returns the string representation

func (*ListThingGroupsInput) Validate ¶ added in v1.12.36

func (s *ListThingGroupsInput) Validate() error

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

type ListThingGroupsOutput ¶ added in v1.12.36

type ListThingGroupsOutput struct {

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

	// The thing groups.
	ThingGroups []*GroupNameAndArn `locationName:"thingGroups" type:"list"`
	// contains filtered or unexported fields
}

func (ListThingGroupsOutput) GoString ¶ added in v1.12.36

func (s ListThingGroupsOutput) GoString() string

GoString returns the string representation

func (*ListThingGroupsOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsOutput) SetThingGroups ¶ added in v1.12.36

SetThingGroups sets the ThingGroups field's value.

func (ListThingGroupsOutput) String ¶ added in v1.12.36

func (s ListThingGroupsOutput) 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 ListThingRegistrationTaskReportsInput ¶ added in v1.12.36

type ListThingRegistrationTaskReportsInput struct {

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

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

	// The type of task report.
	//
	// ReportType is a required field
	ReportType *string `location:"querystring" locationName:"reportType" type:"string" required:"true" enum:"ReportType"`

	// The id of the task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListThingRegistrationTaskReportsInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListThingRegistrationTaskReportsInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListThingRegistrationTaskReportsInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTaskReportsInput) SetReportType ¶ added in v1.12.36

SetReportType sets the ReportType field's value.

func (*ListThingRegistrationTaskReportsInput) SetTaskId ¶ added in v1.12.36

SetTaskId sets the TaskId field's value.

func (ListThingRegistrationTaskReportsInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListThingRegistrationTaskReportsInput) Validate ¶ added in v1.12.36

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

type ListThingRegistrationTaskReportsOutput ¶ added in v1.12.36

type ListThingRegistrationTaskReportsOutput struct {

	// The token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of task report.
	ReportType *string `locationName:"reportType" type:"string" enum:"ReportType"`

	// Links to the task resources.
	ResourceLinks []*string `locationName:"resourceLinks" type:"list"`
	// contains filtered or unexported fields
}

func (ListThingRegistrationTaskReportsOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListThingRegistrationTaskReportsOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTaskReportsOutput) SetReportType ¶ added in v1.12.36

SetReportType sets the ReportType field's value.

SetResourceLinks sets the ResourceLinks field's value.

func (ListThingRegistrationTaskReportsOutput) String ¶ added in v1.12.36

String returns the string representation

type ListThingRegistrationTasksInput ¶ added in v1.12.36

type ListThingRegistrationTasksInput struct {

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

	// The token used to get the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The status of the bulk thing provisioning task.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"Status"`
	// contains filtered or unexported fields
}

func (ListThingRegistrationTasksInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListThingRegistrationTasksInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListThingRegistrationTasksInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTasksInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (ListThingRegistrationTasksInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListThingRegistrationTasksInput) Validate ¶ added in v1.12.36

func (s *ListThingRegistrationTasksInput) Validate() error

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

type ListThingRegistrationTasksOutput ¶ added in v1.12.36

type ListThingRegistrationTasksOutput struct {

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

	// A list of bulk thing provisioning task IDs.
	TaskIds []*string `locationName:"taskIds" type:"list"`
	// contains filtered or unexported fields
}

func (ListThingRegistrationTasksOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*ListThingRegistrationTasksOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTasksOutput) SetTaskIds ¶ added in v1.12.36

SetTaskIds sets the TaskIds field's value.

func (ListThingRegistrationTasksOutput) String ¶ added in v1.12.36

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 ListThingsInThingGroupInput ¶ added in v1.12.36

type ListThingsInThingGroupInput struct {

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

	// The token used to get the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// When true, list things in this thing group and in all child groups as well.
	Recursive *bool `location:"querystring" locationName:"recursive" type:"boolean"`

	// The thing group name.
	//
	// ThingGroupName is a required field
	ThingGroupName *string `location:"uri" locationName:"thingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListThingsInThingGroupInput) GoString ¶ added in v1.12.36

func (s ListThingsInThingGroupInput) GoString() string

GoString returns the string representation

func (*ListThingsInThingGroupInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListThingsInThingGroupInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingsInThingGroupInput) SetRecursive ¶ added in v1.12.36

SetRecursive sets the Recursive field's value.

func (*ListThingsInThingGroupInput) SetThingGroupName ¶ added in v1.12.36

SetThingGroupName sets the ThingGroupName field's value.

func (ListThingsInThingGroupInput) String ¶ added in v1.12.36

String returns the string representation

func (*ListThingsInThingGroupInput) Validate ¶ added in v1.12.36

func (s *ListThingsInThingGroupInput) Validate() error

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

type ListThingsInThingGroupOutput ¶ added in v1.12.36

type ListThingsInThingGroupOutput struct {

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

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

func (ListThingsInThingGroupOutput) GoString ¶ added in v1.12.36

func (s ListThingsInThingGroupOutput) GoString() string

GoString returns the string representation

func (*ListThingsInThingGroupOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListThingsInThingGroupOutput) SetThings ¶ added in v1.12.36

SetThings sets the Things field's value.

func (ListThingsInThingGroupOutput) String ¶ added in v1.12.36

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 used to get 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 used to get 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 ListV2LoggingLevelsInput ¶ added in v1.12.36

type ListV2LoggingLevelsInput struct {

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

	// The token used to get the next set of results, or null if there are no additional
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The type of resource for which you are configuring logging. Must be THING_Group.
	TargetType *string `location:"querystring" locationName:"targetType" type:"string" enum:"LogTargetType"`
	// contains filtered or unexported fields
}

func (ListV2LoggingLevelsInput) GoString ¶ added in v1.12.36

func (s ListV2LoggingLevelsInput) GoString() string

GoString returns the string representation

func (*ListV2LoggingLevelsInput) SetMaxResults ¶ added in v1.12.36

SetMaxResults sets the MaxResults field's value.

func (*ListV2LoggingLevelsInput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (*ListV2LoggingLevelsInput) SetTargetType ¶ added in v1.12.36

SetTargetType sets the TargetType field's value.

func (ListV2LoggingLevelsInput) String ¶ added in v1.12.36

func (s ListV2LoggingLevelsInput) String() string

String returns the string representation

func (*ListV2LoggingLevelsInput) Validate ¶ added in v1.12.36

func (s *ListV2LoggingLevelsInput) Validate() error

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

type ListV2LoggingLevelsOutput ¶ added in v1.12.36

type ListV2LoggingLevelsOutput struct {

	// The logging configuration for a target.
	LogTargetConfigurations []*LogTargetConfiguration `locationName:"logTargetConfigurations" type:"list"`

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

func (ListV2LoggingLevelsOutput) GoString ¶ added in v1.12.36

func (s ListV2LoggingLevelsOutput) GoString() string

GoString returns the string representation

func (*ListV2LoggingLevelsOutput) SetLogTargetConfigurations ¶ added in v1.12.36

func (s *ListV2LoggingLevelsOutput) SetLogTargetConfigurations(v []*LogTargetConfiguration) *ListV2LoggingLevelsOutput

SetLogTargetConfigurations sets the LogTargetConfigurations field's value.

func (*ListV2LoggingLevelsOutput) SetNextToken ¶ added in v1.12.36

SetNextToken sets the NextToken field's value.

func (ListV2LoggingLevelsOutput) String ¶ added in v1.12.36

func (s ListV2LoggingLevelsOutput) String() string

String returns the string representation

type LogTarget ¶ added in v1.12.36

type LogTarget struct {

	// The target name.
	TargetName *string `locationName:"targetName" type:"string"`

	// The target type.
	//
	// TargetType is a required field
	TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"LogTargetType"`
	// contains filtered or unexported fields
}

A log target.

func (LogTarget) GoString ¶ added in v1.12.36

func (s LogTarget) GoString() string

GoString returns the string representation

func (*LogTarget) SetTargetName ¶ added in v1.12.36

func (s *LogTarget) SetTargetName(v string) *LogTarget

SetTargetName sets the TargetName field's value.

func (*LogTarget) SetTargetType ¶ added in v1.12.36

func (s *LogTarget) SetTargetType(v string) *LogTarget

SetTargetType sets the TargetType field's value.

func (LogTarget) String ¶ added in v1.12.36

func (s LogTarget) String() string

String returns the string representation

func (*LogTarget) Validate ¶ added in v1.12.36

func (s *LogTarget) Validate() error

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

type LogTargetConfiguration ¶ added in v1.12.36

type LogTargetConfiguration struct {

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

	// A log target
	LogTarget *LogTarget `locationName:"logTarget" type:"structure"`
	// contains filtered or unexported fields
}

The target configuration.

func (LogTargetConfiguration) GoString ¶ added in v1.12.36

func (s LogTargetConfiguration) GoString() string

GoString returns the string representation

func (*LogTargetConfiguration) SetLogLevel ¶ added in v1.12.36

SetLogLevel sets the LogLevel field's value.

func (*LogTargetConfiguration) SetLogTarget ¶ added in v1.12.36

SetLogTarget sets the LogTarget field's value.

func (LogTargetConfiguration) String ¶ added in v1.12.36

func (s LogTargetConfiguration) String() string

String returns the string representation

type LoggingOptionsPayload ¶

type LoggingOptionsPayload struct {

	// The log 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 OTAUpdateFile ¶ added in v1.12.51

type OTAUpdateFile struct {

	// A list of name/attribute pairs.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// The code signing method of the file.
	CodeSigning *CodeSigning `locationName:"codeSigning" type:"structure"`

	// The name of the file.
	FileName *string `locationName:"fileName" type:"string"`

	// The source of the file.
	FileSource *Stream `locationName:"fileSource" type:"structure"`

	// The file version.
	FileVersion *string `locationName:"fileVersion" type:"string"`
	// contains filtered or unexported fields
}

Describes a file to be associated with an OTA update.

func (OTAUpdateFile) GoString ¶ added in v1.12.51

func (s OTAUpdateFile) GoString() string

GoString returns the string representation

func (*OTAUpdateFile) SetAttributes ¶ added in v1.12.51

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

SetAttributes sets the Attributes field's value.

func (*OTAUpdateFile) SetCodeSigning ¶ added in v1.12.51

func (s *OTAUpdateFile) SetCodeSigning(v *CodeSigning) *OTAUpdateFile

SetCodeSigning sets the CodeSigning field's value.

func (*OTAUpdateFile) SetFileName ¶ added in v1.12.51

func (s *OTAUpdateFile) SetFileName(v string) *OTAUpdateFile

SetFileName sets the FileName field's value.

func (*OTAUpdateFile) SetFileSource ¶ added in v1.12.51

func (s *OTAUpdateFile) SetFileSource(v *Stream) *OTAUpdateFile

SetFileSource sets the FileSource field's value.

func (*OTAUpdateFile) SetFileVersion ¶ added in v1.12.51

func (s *OTAUpdateFile) SetFileVersion(v string) *OTAUpdateFile

SetFileVersion sets the FileVersion field's value.

func (OTAUpdateFile) String ¶ added in v1.12.51

func (s OTAUpdateFile) String() string

String returns the string representation

func (*OTAUpdateFile) Validate ¶ added in v1.12.51

func (s *OTAUpdateFile) Validate() error

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

type OTAUpdateInfo ¶ added in v1.12.51

type OTAUpdateInfo struct {

	// A collection of name/value pairs
	AdditionalParameters map[string]*string `locationName:"additionalParameters" type:"map"`

	// The AWS IoT job ARN associated with the OTA update.
	AwsIotJobArn *string `locationName:"awsIotJobArn" type:"string"`

	// The AWS IoT job ID associated with the OTA update.
	AwsIotJobId *string `locationName:"awsIotJobId" type:"string"`

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

	// A description of the OTA update.
	Description *string `locationName:"description" type:"string"`

	// Error information associated with the OTA update.
	ErrorInfo *ErrorInfo `locationName:"errorInfo" type:"structure"`

	// The date when the OTA update was last updated.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`

	// The OTA update ARN.
	OtaUpdateArn *string `locationName:"otaUpdateArn" type:"string"`

	// A list of files associated with the OTA update.
	OtaUpdateFiles []*OTAUpdateFile `locationName:"otaUpdateFiles" min:"1" type:"list"`

	// The OTA update ID.
	OtaUpdateId *string `locationName:"otaUpdateId" min:"1" type:"string"`

	// The status of the OTA update.
	OtaUpdateStatus *string `locationName:"otaUpdateStatus" type:"string" enum:"OTAUpdateStatus"`

	// Specifies whether the OTA update will continue to run (CONTINUOUS), or will
	// be complete after all those things specified as targets have completed the
	// OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a
	// thing when a change is detected in a target. For example, an OTA update will
	// run on a thing when the thing is added to a target group, even after the
	// OTA update was completed by all things originally in the group.
	TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"`

	// The targets of the OTA update.
	Targets []*string `locationName:"targets" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Information about an OTA update.

func (OTAUpdateInfo) GoString ¶ added in v1.12.51

func (s OTAUpdateInfo) GoString() string

GoString returns the string representation

func (*OTAUpdateInfo) SetAdditionalParameters ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetAdditionalParameters(v map[string]*string) *OTAUpdateInfo

SetAdditionalParameters sets the AdditionalParameters field's value.

func (*OTAUpdateInfo) SetAwsIotJobArn ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetAwsIotJobArn(v string) *OTAUpdateInfo

SetAwsIotJobArn sets the AwsIotJobArn field's value.

func (*OTAUpdateInfo) SetAwsIotJobId ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetAwsIotJobId(v string) *OTAUpdateInfo

SetAwsIotJobId sets the AwsIotJobId field's value.

func (*OTAUpdateInfo) SetCreationDate ¶ added in v1.12.51

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

SetCreationDate sets the CreationDate field's value.

func (*OTAUpdateInfo) SetDescription ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetDescription(v string) *OTAUpdateInfo

SetDescription sets the Description field's value.

func (*OTAUpdateInfo) SetErrorInfo ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetErrorInfo(v *ErrorInfo) *OTAUpdateInfo

SetErrorInfo sets the ErrorInfo field's value.

func (*OTAUpdateInfo) SetLastModifiedDate ¶ added in v1.12.51

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*OTAUpdateInfo) SetOtaUpdateArn ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetOtaUpdateArn(v string) *OTAUpdateInfo

SetOtaUpdateArn sets the OtaUpdateArn field's value.

func (*OTAUpdateInfo) SetOtaUpdateFiles ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetOtaUpdateFiles(v []*OTAUpdateFile) *OTAUpdateInfo

SetOtaUpdateFiles sets the OtaUpdateFiles field's value.

func (*OTAUpdateInfo) SetOtaUpdateId ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetOtaUpdateId(v string) *OTAUpdateInfo

SetOtaUpdateId sets the OtaUpdateId field's value.

func (*OTAUpdateInfo) SetOtaUpdateStatus ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetOtaUpdateStatus(v string) *OTAUpdateInfo

SetOtaUpdateStatus sets the OtaUpdateStatus field's value.

func (*OTAUpdateInfo) SetTargetSelection ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetTargetSelection(v string) *OTAUpdateInfo

SetTargetSelection sets the TargetSelection field's value.

func (*OTAUpdateInfo) SetTargets ¶ added in v1.12.51

func (s *OTAUpdateInfo) SetTargets(v []*string) *OTAUpdateInfo

SetTargets sets the Targets field's value.

func (OTAUpdateInfo) String ¶ added in v1.12.51

func (s OTAUpdateInfo) String() string

String returns the string representation

type OTAUpdateSummary ¶ added in v1.12.51

type OTAUpdateSummary struct {

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

	// The OTA update ARN.
	OtaUpdateArn *string `locationName:"otaUpdateArn" type:"string"`

	// The OTA update ID.
	OtaUpdateId *string `locationName:"otaUpdateId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An OTA update summary.

func (OTAUpdateSummary) GoString ¶ added in v1.12.51

func (s OTAUpdateSummary) GoString() string

GoString returns the string representation

func (*OTAUpdateSummary) SetCreationDate ¶ added in v1.12.51

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

SetCreationDate sets the CreationDate field's value.

func (*OTAUpdateSummary) SetOtaUpdateArn ¶ added in v1.12.51

func (s *OTAUpdateSummary) SetOtaUpdateArn(v string) *OTAUpdateSummary

SetOtaUpdateArn sets the OtaUpdateArn field's value.

func (*OTAUpdateSummary) SetOtaUpdateId ¶ added in v1.12.51

func (s *OTAUpdateSummary) SetOtaUpdateId(v string) *OTAUpdateSummary

SetOtaUpdateId sets the OtaUpdateId field's value.

func (OTAUpdateSummary) String ¶ added in v1.12.51

func (s OTAUpdateSummary) String() string

String returns the string representation

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 transferred 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 PresignedUrlConfig ¶ added in v1.12.36

type PresignedUrlConfig struct {

	// How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600,
	// the default value is 3600 seconds. Pre-signed URLs are generated when Jobs
	// receives an MQTT request for the job document.
	ExpiresInSec *int64 `locationName:"expiresInSec" min:"60" type:"long"`

	// The ARN of an IAM role that grants grants permission to download files from
	// the S3 bucket where the job data/updates are stored. The role must also grant
	// permission for IoT to download the files.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Configuration for pre-signed S3 URLs.

func (PresignedUrlConfig) GoString ¶ added in v1.12.36

func (s PresignedUrlConfig) GoString() string

GoString returns the string representation

func (*PresignedUrlConfig) SetExpiresInSec ¶ added in v1.12.36

func (s *PresignedUrlConfig) SetExpiresInSec(v int64) *PresignedUrlConfig

SetExpiresInSec sets the ExpiresInSec field's value.

func (*PresignedUrlConfig) SetRoleArn ¶ added in v1.12.36

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

SetRoleArn sets the RoleArn field's value.

func (PresignedUrlConfig) String ¶ added in v1.12.36

func (s PresignedUrlConfig) String() string

String returns the string representation

func (*PresignedUrlConfig) Validate ¶ added in v1.12.36

func (s *PresignedUrlConfig) Validate() error

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

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

	// Information about the registration configuration.
	RegistrationConfig *RegistrationConfig `locationName:"registrationConfig" type:"structure"`

	// 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) SetRegistrationConfig ¶ added in v1.12.36

SetRegistrationConfig sets the RegistrationConfig 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"`

	// The status of the register certificate request.
	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 RegisterThingInput ¶ added in v1.12.36

type RegisterThingInput struct {

	// The parameters for provisioning a thing. See Programmatic Provisioning (http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html)
	// for more information.
	Parameters map[string]*string `locationName:"parameters" type:"map"`

	// The provisioning template. See Programmatic Provisioning (http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html)
	// for more information.
	//
	// TemplateBody is a required field
	TemplateBody *string `locationName:"templateBody" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterThingInput) GoString ¶ added in v1.12.36

func (s RegisterThingInput) GoString() string

GoString returns the string representation

func (*RegisterThingInput) SetParameters ¶ added in v1.12.36

func (s *RegisterThingInput) SetParameters(v map[string]*string) *RegisterThingInput

SetParameters sets the Parameters field's value.

func (*RegisterThingInput) SetTemplateBody ¶ added in v1.12.36

func (s *RegisterThingInput) SetTemplateBody(v string) *RegisterThingInput

SetTemplateBody sets the TemplateBody field's value.

func (RegisterThingInput) String ¶ added in v1.12.36

func (s RegisterThingInput) String() string

String returns the string representation

func (*RegisterThingInput) Validate ¶ added in v1.12.36

func (s *RegisterThingInput) Validate() error

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

type RegisterThingOutput ¶ added in v1.12.36

type RegisterThingOutput struct {

	// The PEM of a certificate.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`

	// ARNs for the generated resources.
	ResourceArns map[string]*string `locationName:"resourceArns" type:"map"`
	// contains filtered or unexported fields
}

func (RegisterThingOutput) GoString ¶ added in v1.12.36

func (s RegisterThingOutput) GoString() string

GoString returns the string representation

func (*RegisterThingOutput) SetCertificatePem ¶ added in v1.12.36

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

SetCertificatePem sets the CertificatePem field's value.

func (*RegisterThingOutput) SetResourceArns ¶ added in v1.12.36

func (s *RegisterThingOutput) SetResourceArns(v map[string]*string) *RegisterThingOutput

SetResourceArns sets the ResourceArns field's value.

func (RegisterThingOutput) String ¶ added in v1.12.36

func (s RegisterThingOutput) String() string

String returns the string representation

type RegistrationConfig ¶ added in v1.12.36

type RegistrationConfig struct {

	// The ARN of the role.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`

	// The template body.
	TemplateBody *string `locationName:"templateBody" type:"string"`
	// contains filtered or unexported fields
}

The registration configuration.

func (RegistrationConfig) GoString ¶ added in v1.12.36

func (s RegistrationConfig) GoString() string

GoString returns the string representation

func (*RegistrationConfig) SetRoleArn ¶ added in v1.12.36

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

SetRoleArn sets the RoleArn field's value.

func (*RegistrationConfig) SetTemplateBody ¶ added in v1.12.36

func (s *RegistrationConfig) SetTemplateBody(v string) *RegistrationConfig

SetTemplateBody sets the TemplateBody field's value.

func (RegistrationConfig) String ¶ added in v1.12.36

func (s RegistrationConfig) String() string

String returns the string representation

func (*RegistrationConfig) Validate ¶ added in v1.12.36

func (s *RegistrationConfig) Validate() error

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

type RejectCertificateTransferInput ¶

type RejectCertificateTransferInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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 RemoveThingFromThingGroupInput ¶ added in v1.12.36

type RemoveThingFromThingGroupInput struct {

	// The ARN of the thing to remove from the group.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The group ARN.
	ThingGroupArn *string `locationName:"thingGroupArn" type:"string"`

	// The group name.
	ThingGroupName *string `locationName:"thingGroupName" min:"1" type:"string"`

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

func (RemoveThingFromThingGroupInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*RemoveThingFromThingGroupInput) SetThingArn ¶ added in v1.12.36

SetThingArn sets the ThingArn field's value.

func (*RemoveThingFromThingGroupInput) SetThingGroupArn ¶ added in v1.12.36

SetThingGroupArn sets the ThingGroupArn field's value.

func (*RemoveThingFromThingGroupInput) SetThingGroupName ¶ added in v1.12.36

SetThingGroupName sets the ThingGroupName field's value.

func (*RemoveThingFromThingGroupInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (RemoveThingFromThingGroupInput) String ¶ added in v1.12.36

String returns the string representation

func (*RemoveThingFromThingGroupInput) Validate ¶ added in v1.12.36

func (s *RemoveThingFromThingGroupInput) Validate() error

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

type RemoveThingFromThingGroupOutput ¶ added in v1.12.36

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

func (RemoveThingFromThingGroupOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (RemoveThingFromThingGroupOutput) String ¶ added in v1.12.36

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 RoleAliasDescription ¶ added in v1.12.36

type RoleAliasDescription struct {

	// The UNIX timestamp of when the role alias was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The number of seconds for which the credential is valid.
	CredentialDurationSeconds *int64 `locationName:"credentialDurationSeconds" min:"900" type:"integer"`

	// The UNIX timestamp of when the role alias was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`

	// The role alias owner.
	Owner *string `locationName:"owner" type:"string"`

	// The role alias.
	RoleAlias *string `locationName:"roleAlias" min:"1" type:"string"`

	// The ARN of the role alias.
	RoleAliasArn *string `locationName:"roleAliasArn" type:"string"`

	// The role ARN.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Role alias description.

func (RoleAliasDescription) GoString ¶ added in v1.12.36

func (s RoleAliasDescription) GoString() string

GoString returns the string representation

func (*RoleAliasDescription) SetCreationDate ¶ added in v1.12.36

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

SetCreationDate sets the CreationDate field's value.

func (*RoleAliasDescription) SetCredentialDurationSeconds ¶ added in v1.12.36

func (s *RoleAliasDescription) SetCredentialDurationSeconds(v int64) *RoleAliasDescription

SetCredentialDurationSeconds sets the CredentialDurationSeconds field's value.

func (*RoleAliasDescription) SetLastModifiedDate ¶ added in v1.12.36

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*RoleAliasDescription) SetOwner ¶ added in v1.12.36

SetOwner sets the Owner field's value.

func (*RoleAliasDescription) SetRoleAlias ¶ added in v1.12.36

func (s *RoleAliasDescription) SetRoleAlias(v string) *RoleAliasDescription

SetRoleAlias sets the RoleAlias field's value.

func (*RoleAliasDescription) SetRoleAliasArn ¶ added in v1.13.12

func (s *RoleAliasDescription) SetRoleAliasArn(v string) *RoleAliasDescription

SetRoleAliasArn sets the RoleAliasArn field's value.

func (*RoleAliasDescription) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (RoleAliasDescription) String ¶ added in v1.12.36

func (s RoleAliasDescription) String() string

String returns the string representation

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 S3Location ¶ added in v1.12.51

type S3Location struct {

	// The S3 bucket that contains the file to stream.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"1" type:"string" required:"true"`

	// The name of the file within the S3 bucket to stream.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The file version.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

The location in S3 the contains the files to stream.

func (S3Location) GoString ¶ added in v1.12.51

func (s S3Location) GoString() string

GoString returns the string representation

func (*S3Location) SetBucket ¶ added in v1.12.51

func (s *S3Location) SetBucket(v string) *S3Location

SetBucket sets the Bucket field's value.

func (*S3Location) SetKey ¶ added in v1.12.51

func (s *S3Location) SetKey(v string) *S3Location

SetKey sets the Key field's value.

func (*S3Location) SetVersion ¶ added in v1.12.51

func (s *S3Location) SetVersion(v string) *S3Location

SetVersion sets the Version field's value.

func (S3Location) String ¶ added in v1.12.51

func (s S3Location) String() string

String returns the string representation

func (*S3Location) Validate ¶ added in v1.12.51

func (s *S3Location) Validate() error

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

type SalesforceAction ¶ added in v1.8.35

type SalesforceAction struct {

	// The token used to authenticate access to the Salesforce IoT Cloud Input Stream.
	// The token is available from the Salesforce IoT Cloud platform after creation
	// of the Input Stream.
	//
	// Token is a required field
	Token *string `locationName:"token" min:"40" type:"string" required:"true"`

	// The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available
	// from the Salesforce IoT Cloud platform after creation of the Input Stream.
	//
	// Url is a required field
	Url *string `locationName:"url" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to write a message to a Salesforce IoT Cloud Input Stream.

func (SalesforceAction) GoString ¶ added in v1.8.35

func (s SalesforceAction) GoString() string

GoString returns the string representation

func (*SalesforceAction) SetToken ¶ added in v1.8.35

func (s *SalesforceAction) SetToken(v string) *SalesforceAction

SetToken sets the Token field's value.

func (*SalesforceAction) SetUrl ¶ added in v1.8.35

SetUrl sets the Url field's value.

func (SalesforceAction) String ¶ added in v1.8.35

func (s SalesforceAction) String() string

String returns the string representation

func (*SalesforceAction) Validate ¶ added in v1.8.35

func (s *SalesforceAction) Validate() error

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

type SearchIndexInput ¶ added in v1.12.36

type SearchIndexInput struct {

	// The search index name.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

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

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

	// The search query string.
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" min:"1" type:"string" required:"true"`

	// The query version.
	QueryVersion *string `locationName:"queryVersion" type:"string"`
	// contains filtered or unexported fields
}

func (SearchIndexInput) GoString ¶ added in v1.12.36

func (s SearchIndexInput) GoString() string

GoString returns the string representation

func (*SearchIndexInput) SetIndexName ¶ added in v1.12.36

func (s *SearchIndexInput) SetIndexName(v string) *SearchIndexInput

SetIndexName sets the IndexName field's value.

func (*SearchIndexInput) SetMaxResults ¶ added in v1.12.36

func (s *SearchIndexInput) SetMaxResults(v int64) *SearchIndexInput

SetMaxResults sets the MaxResults field's value.

func (*SearchIndexInput) SetNextToken ¶ added in v1.12.36

func (s *SearchIndexInput) SetNextToken(v string) *SearchIndexInput

SetNextToken sets the NextToken field's value.

func (*SearchIndexInput) SetQueryString ¶ added in v1.12.36

func (s *SearchIndexInput) SetQueryString(v string) *SearchIndexInput

SetQueryString sets the QueryString field's value.

func (*SearchIndexInput) SetQueryVersion ¶ added in v1.12.36

func (s *SearchIndexInput) SetQueryVersion(v string) *SearchIndexInput

SetQueryVersion sets the QueryVersion field's value.

func (SearchIndexInput) String ¶ added in v1.12.36

func (s SearchIndexInput) String() string

String returns the string representation

func (*SearchIndexInput) Validate ¶ added in v1.12.36

func (s *SearchIndexInput) Validate() error

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

type SearchIndexOutput ¶ added in v1.12.36

type SearchIndexOutput struct {

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

	// The things that match the search query.
	Things []*ThingDocument `locationName:"things" type:"list"`
	// contains filtered or unexported fields
}

func (SearchIndexOutput) GoString ¶ added in v1.12.36

func (s SearchIndexOutput) GoString() string

GoString returns the string representation

func (*SearchIndexOutput) SetNextToken ¶ added in v1.12.36

func (s *SearchIndexOutput) SetNextToken(v string) *SearchIndexOutput

SetNextToken sets the NextToken field's value.

func (*SearchIndexOutput) SetThings ¶ added in v1.12.36

SetThings sets the Things field's value.

func (SearchIndexOutput) String ¶ added in v1.12.36

func (s SearchIndexOutput) String() string

String returns the string representation

type SetDefaultAuthorizerInput ¶ added in v1.12.36

type SetDefaultAuthorizerInput struct {

	// The authorizer name.
	//
	// AuthorizerName is a required field
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SetDefaultAuthorizerInput) GoString ¶ added in v1.12.36

func (s SetDefaultAuthorizerInput) GoString() string

GoString returns the string representation

func (*SetDefaultAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

SetAuthorizerName sets the AuthorizerName field's value.

func (SetDefaultAuthorizerInput) String ¶ added in v1.12.36

func (s SetDefaultAuthorizerInput) String() string

String returns the string representation

func (*SetDefaultAuthorizerInput) Validate ¶ added in v1.12.36

func (s *SetDefaultAuthorizerInput) Validate() error

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

type SetDefaultAuthorizerOutput ¶ added in v1.12.36

type SetDefaultAuthorizerOutput struct {

	// The authorizer ARN.
	AuthorizerArn *string `locationName:"authorizerArn" type:"string"`

	// The authorizer name.
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SetDefaultAuthorizerOutput) GoString ¶ added in v1.12.36

func (s SetDefaultAuthorizerOutput) GoString() string

GoString returns the string representation

func (*SetDefaultAuthorizerOutput) SetAuthorizerArn ¶ added in v1.12.36

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*SetDefaultAuthorizerOutput) SetAuthorizerName ¶ added in v1.12.36

SetAuthorizerName sets the AuthorizerName field's value.

func (SetDefaultAuthorizerOutput) String ¶ added in v1.12.36

String returns the string representation

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 SetV2LoggingLevelInput ¶ added in v1.12.36

type SetV2LoggingLevelInput struct {

	// The log level.
	//
	// LogLevel is a required field
	LogLevel *string `locationName:"logLevel" type:"string" required:"true" enum:"LogLevel"`

	// The log target.
	//
	// LogTarget is a required field
	LogTarget *LogTarget `locationName:"logTarget" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SetV2LoggingLevelInput) GoString ¶ added in v1.12.36

func (s SetV2LoggingLevelInput) GoString() string

GoString returns the string representation

func (*SetV2LoggingLevelInput) SetLogLevel ¶ added in v1.12.36

SetLogLevel sets the LogLevel field's value.

func (*SetV2LoggingLevelInput) SetLogTarget ¶ added in v1.12.36

SetLogTarget sets the LogTarget field's value.

func (SetV2LoggingLevelInput) String ¶ added in v1.12.36

func (s SetV2LoggingLevelInput) String() string

String returns the string representation

func (*SetV2LoggingLevelInput) Validate ¶ added in v1.12.36

func (s *SetV2LoggingLevelInput) Validate() error

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

type SetV2LoggingLevelOutput ¶ added in v1.12.36

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

func (SetV2LoggingLevelOutput) GoString ¶ added in v1.12.36

func (s SetV2LoggingLevelOutput) GoString() string

GoString returns the string representation

func (SetV2LoggingLevelOutput) String ¶ added in v1.12.36

func (s SetV2LoggingLevelOutput) String() string

String returns the string representation

type SetV2LoggingOptionsInput ¶ added in v1.12.36

type SetV2LoggingOptionsInput struct {

	// The default logging level.
	DefaultLogLevel *string `locationName:"defaultLogLevel" type:"string" enum:"LogLevel"`

	// Set to true to disable all logs, otherwise set to false.
	DisableAllLogs *bool `locationName:"disableAllLogs" type:"boolean"`

	// The role ARN that allows IoT to write to Cloudwatch logs.
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

func (SetV2LoggingOptionsInput) GoString ¶ added in v1.12.36

func (s SetV2LoggingOptionsInput) GoString() string

GoString returns the string representation

func (*SetV2LoggingOptionsInput) SetDefaultLogLevel ¶ added in v1.12.36

func (s *SetV2LoggingOptionsInput) SetDefaultLogLevel(v string) *SetV2LoggingOptionsInput

SetDefaultLogLevel sets the DefaultLogLevel field's value.

func (*SetV2LoggingOptionsInput) SetDisableAllLogs ¶ added in v1.12.36

func (s *SetV2LoggingOptionsInput) SetDisableAllLogs(v bool) *SetV2LoggingOptionsInput

SetDisableAllLogs sets the DisableAllLogs field's value.

func (*SetV2LoggingOptionsInput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (SetV2LoggingOptionsInput) String ¶ added in v1.12.36

func (s SetV2LoggingOptionsInput) String() string

String returns the string representation

type SetV2LoggingOptionsOutput ¶ added in v1.12.36

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

func (SetV2LoggingOptionsOutput) GoString ¶ added in v1.12.36

func (s SetV2LoggingOptionsOutput) GoString() string

GoString returns the string representation

func (SetV2LoggingOptionsOutput) String ¶ added in v1.12.36

func (s SetV2LoggingOptionsOutput) String() string

String returns the string representation

type SnsAction ¶

type SnsAction struct {

	// (Optional) The message format of the message to publish. 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 http://docs.aws.amazon.com/sns/latest/dg/json-formats.html (http://docs.aws.amazon.com/sns/latest/dg/json-formats.html)
	// refer to their official documentation.
	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 StartThingRegistrationTaskInput ¶ added in v1.12.36

type StartThingRegistrationTaskInput struct {

	// The S3 bucket that contains the input file.
	//
	// InputFileBucket is a required field
	InputFileBucket *string `locationName:"inputFileBucket" min:"3" type:"string" required:"true"`

	// The name of input file within the S3 bucket. This file contains a newline
	// delimited JSON file. Each line contains the parameter values to provision
	// one device (thing).
	//
	// InputFileKey is a required field
	InputFileKey *string `locationName:"inputFileKey" min:"1" type:"string" required:"true"`

	// The IAM role ARN that grants permission the input file.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The provisioning template.
	//
	// TemplateBody is a required field
	TemplateBody *string `locationName:"templateBody" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartThingRegistrationTaskInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*StartThingRegistrationTaskInput) SetInputFileBucket ¶ added in v1.12.36

SetInputFileBucket sets the InputFileBucket field's value.

func (*StartThingRegistrationTaskInput) SetInputFileKey ¶ added in v1.12.36

SetInputFileKey sets the InputFileKey field's value.

func (*StartThingRegistrationTaskInput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (*StartThingRegistrationTaskInput) SetTemplateBody ¶ added in v1.12.36

SetTemplateBody sets the TemplateBody field's value.

func (StartThingRegistrationTaskInput) String ¶ added in v1.12.36

String returns the string representation

func (*StartThingRegistrationTaskInput) Validate ¶ added in v1.12.36

func (s *StartThingRegistrationTaskInput) Validate() error

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

type StartThingRegistrationTaskOutput ¶ added in v1.12.36

type StartThingRegistrationTaskOutput struct {

	// The bulk thing provisioning task ID.
	TaskId *string `locationName:"taskId" type:"string"`
	// contains filtered or unexported fields
}

func (StartThingRegistrationTaskOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*StartThingRegistrationTaskOutput) SetTaskId ¶ added in v1.12.36

SetTaskId sets the TaskId field's value.

func (StartThingRegistrationTaskOutput) String ¶ added in v1.12.36

String returns the string representation

type StopThingRegistrationTaskInput ¶ added in v1.12.36

type StopThingRegistrationTaskInput struct {

	// The bulk thing provisioning task ID.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopThingRegistrationTaskInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*StopThingRegistrationTaskInput) SetTaskId ¶ added in v1.12.36

SetTaskId sets the TaskId field's value.

func (StopThingRegistrationTaskInput) String ¶ added in v1.12.36

String returns the string representation

func (*StopThingRegistrationTaskInput) Validate ¶ added in v1.12.36

func (s *StopThingRegistrationTaskInput) Validate() error

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

type StopThingRegistrationTaskOutput ¶ added in v1.12.36

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

func (StopThingRegistrationTaskOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (StopThingRegistrationTaskOutput) String ¶ added in v1.12.36

String returns the string representation

type Stream ¶ added in v1.12.51

type Stream struct {

	// The ID of a file associated with a stream.
	FileId *int64 `locationName:"fileId" type:"integer"`

	// The stream ID.
	StreamId *string `locationName:"streamId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a group of files that can be streamed.

func (Stream) GoString ¶ added in v1.12.51

func (s Stream) GoString() string

GoString returns the string representation

func (*Stream) SetFileId ¶ added in v1.12.51

func (s *Stream) SetFileId(v int64) *Stream

SetFileId sets the FileId field's value.

func (*Stream) SetStreamId ¶ added in v1.12.51

func (s *Stream) SetStreamId(v string) *Stream

SetStreamId sets the StreamId field's value.

func (Stream) String ¶ added in v1.12.51

func (s Stream) String() string

String returns the string representation

func (*Stream) Validate ¶ added in v1.12.51

func (s *Stream) Validate() error

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

type StreamFile ¶ added in v1.12.51

type StreamFile struct {

	// The file ID.
	FileId *int64 `locationName:"fileId" type:"integer"`

	// The location of the file in S3.
	S3Location *S3Location `locationName:"s3Location" type:"structure"`
	// contains filtered or unexported fields
}

Represents a file to stream.

func (StreamFile) GoString ¶ added in v1.12.51

func (s StreamFile) GoString() string

GoString returns the string representation

func (*StreamFile) SetFileId ¶ added in v1.12.51

func (s *StreamFile) SetFileId(v int64) *StreamFile

SetFileId sets the FileId field's value.

func (*StreamFile) SetS3Location ¶ added in v1.12.51

func (s *StreamFile) SetS3Location(v *S3Location) *StreamFile

SetS3Location sets the S3Location field's value.

func (StreamFile) String ¶ added in v1.12.51

func (s StreamFile) String() string

String returns the string representation

func (*StreamFile) Validate ¶ added in v1.12.51

func (s *StreamFile) Validate() error

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

type StreamInfo ¶ added in v1.12.51

type StreamInfo struct {

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

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

	// The files to stream.
	Files []*StreamFile `locationName:"files" min:"1" type:"list"`

	// The date when the stream was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"`

	// An IAM role AWS IoT assumes to access your S3 files.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`

	// The stream ARN.
	StreamArn *string `locationName:"streamArn" type:"string"`

	// The stream ID.
	StreamId *string `locationName:"streamId" min:"1" type:"string"`

	// The stream version.
	StreamVersion *int64 `locationName:"streamVersion" type:"integer"`
	// contains filtered or unexported fields
}

Information about a stream.

func (StreamInfo) GoString ¶ added in v1.12.51

func (s StreamInfo) GoString() string

GoString returns the string representation

func (*StreamInfo) SetCreatedAt ¶ added in v1.12.51

func (s *StreamInfo) SetCreatedAt(v time.Time) *StreamInfo

SetCreatedAt sets the CreatedAt field's value.

func (*StreamInfo) SetDescription ¶ added in v1.12.51

func (s *StreamInfo) SetDescription(v string) *StreamInfo

SetDescription sets the Description field's value.

func (*StreamInfo) SetFiles ¶ added in v1.12.51

func (s *StreamInfo) SetFiles(v []*StreamFile) *StreamInfo

SetFiles sets the Files field's value.

func (*StreamInfo) SetLastUpdatedAt ¶ added in v1.12.51

func (s *StreamInfo) SetLastUpdatedAt(v time.Time) *StreamInfo

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*StreamInfo) SetRoleArn ¶ added in v1.12.51

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

SetRoleArn sets the RoleArn field's value.

func (*StreamInfo) SetStreamArn ¶ added in v1.12.51

func (s *StreamInfo) SetStreamArn(v string) *StreamInfo

SetStreamArn sets the StreamArn field's value.

func (*StreamInfo) SetStreamId ¶ added in v1.12.51

func (s *StreamInfo) SetStreamId(v string) *StreamInfo

SetStreamId sets the StreamId field's value.

func (*StreamInfo) SetStreamVersion ¶ added in v1.12.51

func (s *StreamInfo) SetStreamVersion(v int64) *StreamInfo

SetStreamVersion sets the StreamVersion field's value.

func (StreamInfo) String ¶ added in v1.12.51

func (s StreamInfo) String() string

String returns the string representation

type StreamSummary ¶ added in v1.12.51

type StreamSummary struct {

	// A description of the stream.
	Description *string `locationName:"description" type:"string"`

	// The stream ARN.
	StreamArn *string `locationName:"streamArn" type:"string"`

	// The stream ID.
	StreamId *string `locationName:"streamId" min:"1" type:"string"`

	// The stream version.
	StreamVersion *int64 `locationName:"streamVersion" type:"integer"`
	// contains filtered or unexported fields
}

A summary of a stream.

func (StreamSummary) GoString ¶ added in v1.12.51

func (s StreamSummary) GoString() string

GoString returns the string representation

func (*StreamSummary) SetDescription ¶ added in v1.12.51

func (s *StreamSummary) SetDescription(v string) *StreamSummary

SetDescription sets the Description field's value.

func (*StreamSummary) SetStreamArn ¶ added in v1.12.51

func (s *StreamSummary) SetStreamArn(v string) *StreamSummary

SetStreamArn sets the StreamArn field's value.

func (*StreamSummary) SetStreamId ¶ added in v1.12.51

func (s *StreamSummary) SetStreamId(v string) *StreamSummary

SetStreamId sets the StreamId field's value.

func (*StreamSummary) SetStreamVersion ¶ added in v1.12.51

func (s *StreamSummary) SetStreamVersion(v int64) *StreamSummary

SetStreamVersion sets the StreamVersion field's value.

func (StreamSummary) String ¶ added in v1.12.51

func (s StreamSummary) String() string

String returns the string representation

type TestAuthorizationInput ¶ added in v1.12.36

type TestAuthorizationInput struct {

	// A list of authorization info objects. Simulating authorization will create
	// a response for each authInfo object in the list.
	//
	// AuthInfos is a required field
	AuthInfos []*AuthInfo `locationName:"authInfos" min:"1" type:"list" required:"true"`

	// The MQTT client ID.
	ClientId *string `location:"querystring" locationName:"clientId" type:"string"`

	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string `locationName:"cognitoIdentityPoolId" type:"string"`

	// When testing custom authorization, the policies specified here are treated
	// as if they are attached to the principal being authorized.
	PolicyNamesToAdd []*string `locationName:"policyNamesToAdd" type:"list"`

	// When testing custom authorization, the policies specified here are treated
	// as if they are not attached to the principal being authorized.
	PolicyNamesToSkip []*string `locationName:"policyNamesToSkip" type:"list"`

	// The principal.
	Principal *string `locationName:"principal" type:"string"`
	// contains filtered or unexported fields
}

func (TestAuthorizationInput) GoString ¶ added in v1.12.36

func (s TestAuthorizationInput) GoString() string

GoString returns the string representation

func (*TestAuthorizationInput) SetAuthInfos ¶ added in v1.12.36

SetAuthInfos sets the AuthInfos field's value.

func (*TestAuthorizationInput) SetClientId ¶ added in v1.12.36

SetClientId sets the ClientId field's value.

func (*TestAuthorizationInput) SetCognitoIdentityPoolId ¶ added in v1.12.36

func (s *TestAuthorizationInput) SetCognitoIdentityPoolId(v string) *TestAuthorizationInput

SetCognitoIdentityPoolId sets the CognitoIdentityPoolId field's value.

func (*TestAuthorizationInput) SetPolicyNamesToAdd ¶ added in v1.12.36

func (s *TestAuthorizationInput) SetPolicyNamesToAdd(v []*string) *TestAuthorizationInput

SetPolicyNamesToAdd sets the PolicyNamesToAdd field's value.

func (*TestAuthorizationInput) SetPolicyNamesToSkip ¶ added in v1.12.36

func (s *TestAuthorizationInput) SetPolicyNamesToSkip(v []*string) *TestAuthorizationInput

SetPolicyNamesToSkip sets the PolicyNamesToSkip field's value.

func (*TestAuthorizationInput) SetPrincipal ¶ added in v1.12.36

SetPrincipal sets the Principal field's value.

func (TestAuthorizationInput) String ¶ added in v1.12.36

func (s TestAuthorizationInput) String() string

String returns the string representation

func (*TestAuthorizationInput) Validate ¶ added in v1.12.36

func (s *TestAuthorizationInput) Validate() error

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

type TestAuthorizationOutput ¶ added in v1.12.36

type TestAuthorizationOutput struct {

	// The authentication results.
	AuthResults []*AuthResult `locationName:"authResults" type:"list"`
	// contains filtered or unexported fields
}

func (TestAuthorizationOutput) GoString ¶ added in v1.12.36

func (s TestAuthorizationOutput) GoString() string

GoString returns the string representation

func (*TestAuthorizationOutput) SetAuthResults ¶ added in v1.12.36

SetAuthResults sets the AuthResults field's value.

func (TestAuthorizationOutput) String ¶ added in v1.12.36

func (s TestAuthorizationOutput) String() string

String returns the string representation

type TestInvokeAuthorizerInput ¶ added in v1.12.36

type TestInvokeAuthorizerInput struct {

	// The custom authorizer name.
	//
	// AuthorizerName is a required field
	AuthorizerName *string `location:"uri" locationName:"authorizerName" min:"1" type:"string" required:"true"`

	// The token returned by your custom authentication service.
	//
	// Token is a required field
	Token *string `locationName:"token" min:"1" type:"string" required:"true"`

	// The signature made with the token and your custom authentication service's
	// private key.
	//
	// TokenSignature is a required field
	TokenSignature *string `locationName:"tokenSignature" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TestInvokeAuthorizerInput) GoString ¶ added in v1.12.36

func (s TestInvokeAuthorizerInput) GoString() string

GoString returns the string representation

func (*TestInvokeAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

SetAuthorizerName sets the AuthorizerName field's value.

func (*TestInvokeAuthorizerInput) SetToken ¶ added in v1.12.36

SetToken sets the Token field's value.

func (*TestInvokeAuthorizerInput) SetTokenSignature ¶ added in v1.12.36

SetTokenSignature sets the TokenSignature field's value.

func (TestInvokeAuthorizerInput) String ¶ added in v1.12.36

func (s TestInvokeAuthorizerInput) String() string

String returns the string representation

func (*TestInvokeAuthorizerInput) Validate ¶ added in v1.12.36

func (s *TestInvokeAuthorizerInput) Validate() error

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

type TestInvokeAuthorizerOutput ¶ added in v1.12.36

type TestInvokeAuthorizerOutput struct {

	// The number of seconds after which the connection is terminated.
	DisconnectAfterInSeconds *int64 `locationName:"disconnectAfterInSeconds" type:"integer"`

	// True if the token is authenticated, otherwise false.
	IsAuthenticated *bool `locationName:"isAuthenticated" type:"boolean"`

	// IAM policy documents.
	PolicyDocuments []*string `locationName:"policyDocuments" type:"list"`

	// The principal ID.
	PrincipalId *string `locationName:"principalId" min:"1" type:"string"`

	// The number of seconds after which the temporary credentials are refreshed.
	RefreshAfterInSeconds *int64 `locationName:"refreshAfterInSeconds" type:"integer"`
	// contains filtered or unexported fields
}

func (TestInvokeAuthorizerOutput) GoString ¶ added in v1.12.36

func (s TestInvokeAuthorizerOutput) GoString() string

GoString returns the string representation

func (*TestInvokeAuthorizerOutput) SetDisconnectAfterInSeconds ¶ added in v1.12.36

func (s *TestInvokeAuthorizerOutput) SetDisconnectAfterInSeconds(v int64) *TestInvokeAuthorizerOutput

SetDisconnectAfterInSeconds sets the DisconnectAfterInSeconds field's value.

func (*TestInvokeAuthorizerOutput) SetIsAuthenticated ¶ added in v1.12.36

SetIsAuthenticated sets the IsAuthenticated field's value.

func (*TestInvokeAuthorizerOutput) SetPolicyDocuments ¶ added in v1.12.36

func (s *TestInvokeAuthorizerOutput) SetPolicyDocuments(v []*string) *TestInvokeAuthorizerOutput

SetPolicyDocuments sets the PolicyDocuments field's value.

func (*TestInvokeAuthorizerOutput) SetPrincipalId ¶ added in v1.12.36

SetPrincipalId sets the PrincipalId field's value.

func (*TestInvokeAuthorizerOutput) SetRefreshAfterInSeconds ¶ added in v1.12.36

func (s *TestInvokeAuthorizerOutput) SetRefreshAfterInSeconds(v int64) *TestInvokeAuthorizerOutput

SetRefreshAfterInSeconds sets the RefreshAfterInSeconds field's value.

func (TestInvokeAuthorizerOutput) String ¶ added in v1.12.36

String returns the string representation

type ThingAttribute ¶

type ThingAttribute struct {

	// A list of thing attributes which are name-value pairs.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

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

	// 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) SetThingArn ¶ added in v1.12.36

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

SetThingArn sets the ThingArn 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 ThingDocument ¶ added in v1.12.36

type ThingDocument struct {

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

	// The shadow.
	Shadow *string `locationName:"shadow" type:"string"`

	// Thing group names.
	ThingGroupNames []*string `locationName:"thingGroupNames" type:"list"`

	// The thing ID.
	ThingId *string `locationName:"thingId" type:"string"`

	// The thing name.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`

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

The thing search index document.

func (ThingDocument) GoString ¶ added in v1.12.36

func (s ThingDocument) GoString() string

GoString returns the string representation

func (*ThingDocument) SetAttributes ¶ added in v1.12.36

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

SetAttributes sets the Attributes field's value.

func (*ThingDocument) SetShadow ¶ added in v1.12.36

func (s *ThingDocument) SetShadow(v string) *ThingDocument

SetShadow sets the Shadow field's value.

func (*ThingDocument) SetThingGroupNames ¶ added in v1.12.36

func (s *ThingDocument) SetThingGroupNames(v []*string) *ThingDocument

SetThingGroupNames sets the ThingGroupNames field's value.

func (*ThingDocument) SetThingId ¶ added in v1.12.36

func (s *ThingDocument) SetThingId(v string) *ThingDocument

SetThingId sets the ThingId field's value.

func (*ThingDocument) SetThingName ¶ added in v1.12.36

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

SetThingName sets the ThingName field's value.

func (*ThingDocument) SetThingTypeName ¶ added in v1.12.36

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

SetThingTypeName sets the ThingTypeName field's value.

func (ThingDocument) String ¶ added in v1.12.36

func (s ThingDocument) String() string

String returns the string representation

type ThingGroupMetadata ¶ added in v1.12.36

type ThingGroupMetadata struct {

	// The UNIX timestamp of when the thing group was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`

	// The parent thing group name.
	ParentGroupName *string `locationName:"parentGroupName" min:"1" type:"string"`

	// The root parent thing group.
	RootToParentThingGroups []*GroupNameAndArn `locationName:"rootToParentThingGroups" type:"list"`
	// contains filtered or unexported fields
}

Thing group metadata.

func (ThingGroupMetadata) GoString ¶ added in v1.12.36

func (s ThingGroupMetadata) GoString() string

GoString returns the string representation

func (*ThingGroupMetadata) SetCreationDate ¶ added in v1.12.36

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

SetCreationDate sets the CreationDate field's value.

func (*ThingGroupMetadata) SetParentGroupName ¶ added in v1.12.36

func (s *ThingGroupMetadata) SetParentGroupName(v string) *ThingGroupMetadata

SetParentGroupName sets the ParentGroupName field's value.

func (*ThingGroupMetadata) SetRootToParentThingGroups ¶ added in v1.12.36

func (s *ThingGroupMetadata) SetRootToParentThingGroups(v []*GroupNameAndArn) *ThingGroupMetadata

SetRootToParentThingGroups sets the RootToParentThingGroups field's value.

func (ThingGroupMetadata) String ¶ added in v1.12.36

func (s ThingGroupMetadata) String() string

String returns the string representation

type ThingGroupProperties ¶ added in v1.12.36

type ThingGroupProperties struct {

	// The thing group attributes in JSON format.
	AttributePayload *AttributePayload `locationName:"attributePayload" type:"structure"`

	// The thing group description.
	ThingGroupDescription *string `locationName:"thingGroupDescription" type:"string"`
	// contains filtered or unexported fields
}

Thing group properties.

func (ThingGroupProperties) GoString ¶ added in v1.12.36

func (s ThingGroupProperties) GoString() string

GoString returns the string representation

func (*ThingGroupProperties) SetAttributePayload ¶ added in v1.12.36

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

SetAttributePayload sets the AttributePayload field's value.

func (*ThingGroupProperties) SetThingGroupDescription ¶ added in v1.12.36

func (s *ThingGroupProperties) SetThingGroupDescription(v string) *ThingGroupProperties

SetThingGroupDescription sets the ThingGroupDescription field's value.

func (ThingGroupProperties) String ¶ added in v1.12.36

func (s ThingGroupProperties) String() string

String returns the string representation

type ThingIndexingConfiguration ¶ added in v1.12.36

type ThingIndexingConfiguration struct {

	// Thing indexing mode. Valid values are:
	//
	//    * REGISTRY – Your thing index will contain only registry data.
	//
	//    * REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow
	//    data.
	//
	//    * OFF - Thing indexing is disabled.
	ThingIndexingMode *string `locationName:"thingIndexingMode" type:"string" enum:"ThingIndexingMode"`
	// contains filtered or unexported fields
}

Thing indexing configuration.

func (ThingIndexingConfiguration) GoString ¶ added in v1.12.36

func (s ThingIndexingConfiguration) GoString() string

GoString returns the string representation

func (*ThingIndexingConfiguration) SetThingIndexingMode ¶ added in v1.12.36

func (s *ThingIndexingConfiguration) SetThingIndexingMode(v string) *ThingIndexingConfiguration

SetThingIndexingMode sets the ThingIndexingMode field's value.

func (ThingIndexingConfiguration) String ¶ added in v1.12.36

String returns the string representation

type ThingTypeDefinition ¶ added in v1.2.8

type ThingTypeDefinition struct {

	// The thing type ARN.
	ThingTypeArn *string `locationName:"thingTypeArn" type:"string"`

	// 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 it 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) SetThingTypeArn ¶ added in v1.12.36

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

SetThingTypeArn sets the ThingTypeArn field's value.

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

	// The action to perform when an error occurs.
	ErrorAction *Action `locationName:"errorAction" type:"structure"`

	// 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) SetErrorAction ¶ added in v1.12.41

func (s *TopicRule) SetErrorAction(v *Action) *TopicRule

SetErrorAction sets the ErrorAction 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"`

	// The action to take when an error occurs.
	ErrorAction *Action `locationName:"errorAction" type:"structure"`

	// 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) SetErrorAction ¶ added in v1.12.41

func (s *TopicRulePayload) SetErrorAction(v *Action) *TopicRulePayload

SetErrorAction sets the ErrorAction 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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 UpdateAuthorizerInput ¶ added in v1.12.36

type UpdateAuthorizerInput struct {

	// The ARN of the authorizer's Lambda function.
	AuthorizerFunctionArn *string `locationName:"authorizerFunctionArn" type:"string"`

	// The authorizer name.
	//
	// AuthorizerName is a required field
	AuthorizerName *string `location:"uri" locationName:"authorizerName" min:"1" type:"string" required:"true"`

	// The status of the update authorizer request.
	Status *string `locationName:"status" type:"string" enum:"AuthorizerStatus"`

	// The key used to extract the token from the HTTP headers.
	TokenKeyName *string `locationName:"tokenKeyName" min:"1" type:"string"`

	// The public keys used to verify the token signature.
	TokenSigningPublicKeys map[string]*string `locationName:"tokenSigningPublicKeys" type:"map"`
	// contains filtered or unexported fields
}

func (UpdateAuthorizerInput) GoString ¶ added in v1.12.36

func (s UpdateAuthorizerInput) GoString() string

GoString returns the string representation

func (*UpdateAuthorizerInput) SetAuthorizerFunctionArn ¶ added in v1.12.36

func (s *UpdateAuthorizerInput) SetAuthorizerFunctionArn(v string) *UpdateAuthorizerInput

SetAuthorizerFunctionArn sets the AuthorizerFunctionArn field's value.

func (*UpdateAuthorizerInput) SetAuthorizerName ¶ added in v1.12.36

func (s *UpdateAuthorizerInput) SetAuthorizerName(v string) *UpdateAuthorizerInput

SetAuthorizerName sets the AuthorizerName field's value.

func (*UpdateAuthorizerInput) SetStatus ¶ added in v1.12.36

SetStatus sets the Status field's value.

func (*UpdateAuthorizerInput) SetTokenKeyName ¶ added in v1.12.36

func (s *UpdateAuthorizerInput) SetTokenKeyName(v string) *UpdateAuthorizerInput

SetTokenKeyName sets the TokenKeyName field's value.

func (*UpdateAuthorizerInput) SetTokenSigningPublicKeys ¶ added in v1.12.36

func (s *UpdateAuthorizerInput) SetTokenSigningPublicKeys(v map[string]*string) *UpdateAuthorizerInput

SetTokenSigningPublicKeys sets the TokenSigningPublicKeys field's value.

func (UpdateAuthorizerInput) String ¶ added in v1.12.36

func (s UpdateAuthorizerInput) String() string

String returns the string representation

func (*UpdateAuthorizerInput) Validate ¶ added in v1.12.36

func (s *UpdateAuthorizerInput) Validate() error

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

type UpdateAuthorizerOutput ¶ added in v1.12.36

type UpdateAuthorizerOutput struct {

	// The authorizer ARN.
	AuthorizerArn *string `locationName:"authorizerArn" type:"string"`

	// The authorizer name.
	AuthorizerName *string `locationName:"authorizerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAuthorizerOutput) GoString ¶ added in v1.12.36

func (s UpdateAuthorizerOutput) GoString() string

GoString returns the string representation

func (*UpdateAuthorizerOutput) SetAuthorizerArn ¶ added in v1.12.36

func (s *UpdateAuthorizerOutput) SetAuthorizerArn(v string) *UpdateAuthorizerOutput

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*UpdateAuthorizerOutput) SetAuthorizerName ¶ added in v1.12.36

func (s *UpdateAuthorizerOutput) SetAuthorizerName(v string) *UpdateAuthorizerOutput

SetAuthorizerName sets the AuthorizerName field's value.

func (UpdateAuthorizerOutput) String ¶ added in v1.12.36

func (s UpdateAuthorizerOutput) 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"`

	// Information about the registration configuration.
	RegistrationConfig *RegistrationConfig `locationName:"registrationConfig" type:"structure"`

	// If true, remove auto registration.
	RemoveAutoRegistration *bool `locationName:"removeAutoRegistration" type:"boolean"`
	// 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) SetRegistrationConfig ¶ added in v1.12.36

SetRegistrationConfig sets the RegistrationConfig field's value.

func (*UpdateCACertificateInput) SetRemoveAutoRegistration ¶ added in v1.12.36

func (s *UpdateCACertificateInput) SetRemoveAutoRegistration(v bool) *UpdateCACertificateInput

SetRemoveAutoRegistration sets the RemoveAutoRegistration 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. (The last part of the certificate ARN contains
	// the certificate ID.)
	//
	// 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 UpdateEventConfigurationsInput ¶ added in v1.12.36

type UpdateEventConfigurationsInput struct {

	// The new event configuration values.
	EventConfigurations map[string]*Configuration `locationName:"eventConfigurations" type:"map"`
	// contains filtered or unexported fields
}

func (UpdateEventConfigurationsInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*UpdateEventConfigurationsInput) SetEventConfigurations ¶ added in v1.12.36

SetEventConfigurations sets the EventConfigurations field's value.

func (UpdateEventConfigurationsInput) String ¶ added in v1.12.36

String returns the string representation

type UpdateEventConfigurationsOutput ¶ added in v1.12.36

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

func (UpdateEventConfigurationsOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (UpdateEventConfigurationsOutput) String ¶ added in v1.12.36

String returns the string representation

type UpdateIndexingConfigurationInput ¶ added in v1.12.36

type UpdateIndexingConfigurationInput struct {

	// Thing indexing configuration.
	ThingIndexingConfiguration *ThingIndexingConfiguration `locationName:"thingIndexingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateIndexingConfigurationInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*UpdateIndexingConfigurationInput) SetThingIndexingConfiguration ¶ added in v1.12.36

SetThingIndexingConfiguration sets the ThingIndexingConfiguration field's value.

func (UpdateIndexingConfigurationInput) String ¶ added in v1.12.36

String returns the string representation

type UpdateIndexingConfigurationOutput ¶ added in v1.12.36

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

func (UpdateIndexingConfigurationOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (UpdateIndexingConfigurationOutput) String ¶ added in v1.12.36

String returns the string representation

type UpdateRoleAliasInput ¶ added in v1.12.36

type UpdateRoleAliasInput struct {

	// The number of seconds the credential will be valid.
	CredentialDurationSeconds *int64 `locationName:"credentialDurationSeconds" min:"900" type:"integer"`

	// The role alias to update.
	//
	// RoleAlias is a required field
	RoleAlias *string `location:"uri" locationName:"roleAlias" min:"1" type:"string" required:"true"`

	// The role ARN.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateRoleAliasInput) GoString ¶ added in v1.12.36

func (s UpdateRoleAliasInput) GoString() string

GoString returns the string representation

func (*UpdateRoleAliasInput) SetCredentialDurationSeconds ¶ added in v1.12.36

func (s *UpdateRoleAliasInput) SetCredentialDurationSeconds(v int64) *UpdateRoleAliasInput

SetCredentialDurationSeconds sets the CredentialDurationSeconds field's value.

func (*UpdateRoleAliasInput) SetRoleAlias ¶ added in v1.12.36

func (s *UpdateRoleAliasInput) SetRoleAlias(v string) *UpdateRoleAliasInput

SetRoleAlias sets the RoleAlias field's value.

func (*UpdateRoleAliasInput) SetRoleArn ¶ added in v1.12.36

SetRoleArn sets the RoleArn field's value.

func (UpdateRoleAliasInput) String ¶ added in v1.12.36

func (s UpdateRoleAliasInput) String() string

String returns the string representation

func (*UpdateRoleAliasInput) Validate ¶ added in v1.12.36

func (s *UpdateRoleAliasInput) Validate() error

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

type UpdateRoleAliasOutput ¶ added in v1.12.36

type UpdateRoleAliasOutput struct {

	// The role alias.
	RoleAlias *string `locationName:"roleAlias" min:"1" type:"string"`

	// The role alias ARN.
	RoleAliasArn *string `locationName:"roleAliasArn" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateRoleAliasOutput) GoString ¶ added in v1.12.36

func (s UpdateRoleAliasOutput) GoString() string

GoString returns the string representation

func (*UpdateRoleAliasOutput) SetRoleAlias ¶ added in v1.12.36

SetRoleAlias sets the RoleAlias field's value.

func (*UpdateRoleAliasOutput) SetRoleAliasArn ¶ added in v1.12.36

func (s *UpdateRoleAliasOutput) SetRoleAliasArn(v string) *UpdateRoleAliasOutput

SetRoleAliasArn sets the RoleAliasArn field's value.

func (UpdateRoleAliasOutput) String ¶ added in v1.12.36

func (s UpdateRoleAliasOutput) String() string

String returns the string representation

type UpdateStreamInput ¶ added in v1.12.51

type UpdateStreamInput struct {

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

	// The files associated with the stream.
	Files []*StreamFile `locationName:"files" min:"1" type:"list"`

	// An IAM role that allows the IoT service principal assumes to access your
	// S3 files.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`

	// The stream ID.
	//
	// StreamId is a required field
	StreamId *string `location:"uri" locationName:"streamId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStreamInput) GoString ¶ added in v1.12.51

func (s UpdateStreamInput) GoString() string

GoString returns the string representation

func (*UpdateStreamInput) SetDescription ¶ added in v1.12.51

func (s *UpdateStreamInput) SetDescription(v string) *UpdateStreamInput

SetDescription sets the Description field's value.

func (*UpdateStreamInput) SetFiles ¶ added in v1.12.51

func (s *UpdateStreamInput) SetFiles(v []*StreamFile) *UpdateStreamInput

SetFiles sets the Files field's value.

func (*UpdateStreamInput) SetRoleArn ¶ added in v1.12.51

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

SetRoleArn sets the RoleArn field's value.

func (*UpdateStreamInput) SetStreamId ¶ added in v1.12.51

func (s *UpdateStreamInput) SetStreamId(v string) *UpdateStreamInput

SetStreamId sets the StreamId field's value.

func (UpdateStreamInput) String ¶ added in v1.12.51

func (s UpdateStreamInput) String() string

String returns the string representation

func (*UpdateStreamInput) Validate ¶ added in v1.12.51

func (s *UpdateStreamInput) Validate() error

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

type UpdateStreamOutput ¶ added in v1.12.51

type UpdateStreamOutput struct {

	// A description of the stream.
	Description *string `locationName:"description" type:"string"`

	// The stream ARN.
	StreamArn *string `locationName:"streamArn" type:"string"`

	// The stream ID.
	StreamId *string `locationName:"streamId" min:"1" type:"string"`

	// The stream version.
	StreamVersion *int64 `locationName:"streamVersion" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateStreamOutput) GoString ¶ added in v1.12.51

func (s UpdateStreamOutput) GoString() string

GoString returns the string representation

func (*UpdateStreamOutput) SetDescription ¶ added in v1.12.51

func (s *UpdateStreamOutput) SetDescription(v string) *UpdateStreamOutput

SetDescription sets the Description field's value.

func (*UpdateStreamOutput) SetStreamArn ¶ added in v1.12.51

func (s *UpdateStreamOutput) SetStreamArn(v string) *UpdateStreamOutput

SetStreamArn sets the StreamArn field's value.

func (*UpdateStreamOutput) SetStreamId ¶ added in v1.12.51

func (s *UpdateStreamOutput) SetStreamId(v string) *UpdateStreamOutput

SetStreamId sets the StreamId field's value.

func (*UpdateStreamOutput) SetStreamVersion ¶ added in v1.12.51

func (s *UpdateStreamOutput) SetStreamVersion(v int64) *UpdateStreamOutput

SetStreamVersion sets the StreamVersion field's value.

func (UpdateStreamOutput) String ¶ added in v1.12.51

func (s UpdateStreamOutput) String() string

String returns the string representation

type UpdateThingGroupInput ¶ added in v1.12.36

type UpdateThingGroupInput struct {

	// The expected version of the thing group. If this does not match the version
	// of the thing group being updated, the update will fail.
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// The thing group to update.
	//
	// ThingGroupName is a required field
	ThingGroupName *string `location:"uri" locationName:"thingGroupName" min:"1" type:"string" required:"true"`

	// The thing group properties.
	//
	// ThingGroupProperties is a required field
	ThingGroupProperties *ThingGroupProperties `locationName:"thingGroupProperties" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateThingGroupInput) GoString ¶ added in v1.12.36

func (s UpdateThingGroupInput) GoString() string

GoString returns the string representation

func (*UpdateThingGroupInput) SetExpectedVersion ¶ added in v1.12.36

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateThingGroupInput) SetThingGroupName ¶ added in v1.12.36

func (s *UpdateThingGroupInput) SetThingGroupName(v string) *UpdateThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (*UpdateThingGroupInput) SetThingGroupProperties ¶ added in v1.12.36

func (s *UpdateThingGroupInput) SetThingGroupProperties(v *ThingGroupProperties) *UpdateThingGroupInput

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (UpdateThingGroupInput) String ¶ added in v1.12.36

func (s UpdateThingGroupInput) String() string

String returns the string representation

func (*UpdateThingGroupInput) Validate ¶ added in v1.12.36

func (s *UpdateThingGroupInput) Validate() error

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

type UpdateThingGroupOutput ¶ added in v1.12.36

type UpdateThingGroupOutput struct {

	// The version of the updated thing group.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (UpdateThingGroupOutput) GoString ¶ added in v1.12.36

func (s UpdateThingGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateThingGroupOutput) SetVersion ¶ added in v1.12.36

SetVersion sets the Version field's value.

func (UpdateThingGroupOutput) String ¶ added in v1.12.36

func (s UpdateThingGroupOutput) String() string

String returns the string representation

type UpdateThingGroupsForThingInput ¶ added in v1.12.36

type UpdateThingGroupsForThingInput struct {

	// The groups to which the thing will be added.
	ThingGroupsToAdd []*string `locationName:"thingGroupsToAdd" type:"list"`

	// The groups from which the thing will be removed.
	ThingGroupsToRemove []*string `locationName:"thingGroupsToRemove" type:"list"`

	// The thing whose group memberships will be updated.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateThingGroupsForThingInput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (*UpdateThingGroupsForThingInput) SetThingGroupsToAdd ¶ added in v1.12.36

SetThingGroupsToAdd sets the ThingGroupsToAdd field's value.

func (*UpdateThingGroupsForThingInput) SetThingGroupsToRemove ¶ added in v1.12.36

func (s *UpdateThingGroupsForThingInput) SetThingGroupsToRemove(v []*string) *UpdateThingGroupsForThingInput

SetThingGroupsToRemove sets the ThingGroupsToRemove field's value.

func (*UpdateThingGroupsForThingInput) SetThingName ¶ added in v1.12.36

SetThingName sets the ThingName field's value.

func (UpdateThingGroupsForThingInput) String ¶ added in v1.12.36

String returns the string representation

func (*UpdateThingGroupsForThingInput) Validate ¶ added in v1.12.36

func (s *UpdateThingGroupsForThingInput) Validate() error

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

type UpdateThingGroupsForThingOutput ¶ added in v1.12.36

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

func (UpdateThingGroupsForThingOutput) GoString ¶ added in v1.12.36

GoString returns the string representation

func (UpdateThingGroupsForThingOutput) String ¶ added in v1.12.36

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