iot

package
v1.44.50 Latest Latest
Warning

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

 Go to latest Published: Jul 7, 2022 License: Apache-2.0 Imports: 10 Imported by: 156

Documentation

Overview

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

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/iot-core.html). You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide (https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html).

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services (https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.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 (
	// AggregationTypeNameStatistics is a AggregationTypeName enum value
	AggregationTypeNameStatistics = "Statistics"

	// AggregationTypeNamePercentiles is a AggregationTypeName enum value
	AggregationTypeNamePercentiles = "Percentiles"

	// AggregationTypeNameCardinality is a AggregationTypeName enum value
	AggregationTypeNameCardinality = "Cardinality"
)
View Source 
const (
	// AuditCheckRunStatusInProgress is a AuditCheckRunStatus enum value
	AuditCheckRunStatusInProgress = "IN_PROGRESS"

	// AuditCheckRunStatusWaitingForDataCollection is a AuditCheckRunStatus enum value
	AuditCheckRunStatusWaitingForDataCollection = "WAITING_FOR_DATA_COLLECTION"

	// AuditCheckRunStatusCanceled is a AuditCheckRunStatus enum value
	AuditCheckRunStatusCanceled = "CANCELED"

	// AuditCheckRunStatusCompletedCompliant is a AuditCheckRunStatus enum value
	AuditCheckRunStatusCompletedCompliant = "COMPLETED_COMPLIANT"

	// AuditCheckRunStatusCompletedNonCompliant is a AuditCheckRunStatus enum value
	AuditCheckRunStatusCompletedNonCompliant = "COMPLETED_NON_COMPLIANT"

	// AuditCheckRunStatusFailed is a AuditCheckRunStatus enum value
	AuditCheckRunStatusFailed = "FAILED"
)
View Source 
const (
	// AuditFindingSeverityCritical is a AuditFindingSeverity enum value
	AuditFindingSeverityCritical = "CRITICAL"

	// AuditFindingSeverityHigh is a AuditFindingSeverity enum value
	AuditFindingSeverityHigh = "HIGH"

	// AuditFindingSeverityMedium is a AuditFindingSeverity enum value
	AuditFindingSeverityMedium = "MEDIUM"

	// AuditFindingSeverityLow is a AuditFindingSeverity enum value
	AuditFindingSeverityLow = "LOW"
)
View Source 
const (
	// AuditFrequencyDaily is a AuditFrequency enum value
	AuditFrequencyDaily = "DAILY"

	// AuditFrequencyWeekly is a AuditFrequency enum value
	AuditFrequencyWeekly = "WEEKLY"

	// AuditFrequencyBiweekly is a AuditFrequency enum value
	AuditFrequencyBiweekly = "BIWEEKLY"

	// AuditFrequencyMonthly is a AuditFrequency enum value
	AuditFrequencyMonthly = "MONTHLY"
)
View Source 
const (
	// AuditMitigationActionsExecutionStatusInProgress is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusInProgress = "IN_PROGRESS"

	// AuditMitigationActionsExecutionStatusCompleted is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusCompleted = "COMPLETED"

	// AuditMitigationActionsExecutionStatusFailed is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusFailed = "FAILED"

	// AuditMitigationActionsExecutionStatusCanceled is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusCanceled = "CANCELED"

	// AuditMitigationActionsExecutionStatusSkipped is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusSkipped = "SKIPPED"

	// AuditMitigationActionsExecutionStatusPending is a AuditMitigationActionsExecutionStatus enum value
	AuditMitigationActionsExecutionStatusPending = "PENDING"
)
View Source 
const (
	// AuditMitigationActionsTaskStatusInProgress is a AuditMitigationActionsTaskStatus enum value
	AuditMitigationActionsTaskStatusInProgress = "IN_PROGRESS"

	// AuditMitigationActionsTaskStatusCompleted is a AuditMitigationActionsTaskStatus enum value
	AuditMitigationActionsTaskStatusCompleted = "COMPLETED"

	// AuditMitigationActionsTaskStatusFailed is a AuditMitigationActionsTaskStatus enum value
	AuditMitigationActionsTaskStatusFailed = "FAILED"

	// AuditMitigationActionsTaskStatusCanceled is a AuditMitigationActionsTaskStatus enum value
	AuditMitigationActionsTaskStatusCanceled = "CANCELED"
)
View Source 
const (
	// AuditTaskStatusInProgress is a AuditTaskStatus enum value
	AuditTaskStatusInProgress = "IN_PROGRESS"

	// AuditTaskStatusCompleted is a AuditTaskStatus enum value
	AuditTaskStatusCompleted = "COMPLETED"

	// AuditTaskStatusFailed is a AuditTaskStatus enum value
	AuditTaskStatusFailed = "FAILED"

	// AuditTaskStatusCanceled is a AuditTaskStatus enum value
	AuditTaskStatusCanceled = "CANCELED"
)
View Source 
const (
	// AuditTaskTypeOnDemandAuditTask is a AuditTaskType enum value
	AuditTaskTypeOnDemandAuditTask = "ON_DEMAND_AUDIT_TASK"

	// AuditTaskTypeScheduledAuditTask is a AuditTaskType enum value
	AuditTaskTypeScheduledAuditTask = "SCHEDULED_AUDIT_TASK"
)
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 (
	// AwsJobAbortCriteriaFailureTypeFailed is a AwsJobAbortCriteriaFailureType enum value
	AwsJobAbortCriteriaFailureTypeFailed = "FAILED"

	// AwsJobAbortCriteriaFailureTypeRejected is a AwsJobAbortCriteriaFailureType enum value
	AwsJobAbortCriteriaFailureTypeRejected = "REJECTED"

	// AwsJobAbortCriteriaFailureTypeTimedOut is a AwsJobAbortCriteriaFailureType enum value
	AwsJobAbortCriteriaFailureTypeTimedOut = "TIMED_OUT"

	// AwsJobAbortCriteriaFailureTypeAll is a AwsJobAbortCriteriaFailureType enum value
	AwsJobAbortCriteriaFailureTypeAll = "ALL"
)
View Source 
const (
	// BehaviorCriteriaTypeStatic is a BehaviorCriteriaType enum value
	BehaviorCriteriaTypeStatic = "STATIC"

	// BehaviorCriteriaTypeStatistical is a BehaviorCriteriaType enum value
	BehaviorCriteriaTypeStatistical = "STATISTICAL"

	// BehaviorCriteriaTypeMachineLearning is a BehaviorCriteriaType enum value
	BehaviorCriteriaTypeMachineLearning = "MACHINE_LEARNING"
)
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 (
	// CertificateModeDefault is a CertificateMode enum value
	CertificateModeDefault = "DEFAULT"

	// CertificateModeSniOnly is a CertificateMode enum value
	CertificateModeSniOnly = "SNI_ONLY"
)
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 (
	// ComparisonOperatorLessThan is a ComparisonOperator enum value
	ComparisonOperatorLessThan = "less-than"

	// ComparisonOperatorLessThanEquals is a ComparisonOperator enum value
	ComparisonOperatorLessThanEquals = "less-than-equals"

	// ComparisonOperatorGreaterThan is a ComparisonOperator enum value
	ComparisonOperatorGreaterThan = "greater-than"

	// ComparisonOperatorGreaterThanEquals is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanEquals = "greater-than-equals"

	// ComparisonOperatorInCidrSet is a ComparisonOperator enum value
	ComparisonOperatorInCidrSet = "in-cidr-set"

	// ComparisonOperatorNotInCidrSet is a ComparisonOperator enum value
	ComparisonOperatorNotInCidrSet = "not-in-cidr-set"

	// ComparisonOperatorInPortSet is a ComparisonOperator enum value
	ComparisonOperatorInPortSet = "in-port-set"

	// ComparisonOperatorNotInPortSet is a ComparisonOperator enum value
	ComparisonOperatorNotInPortSet = "not-in-port-set"

	// ComparisonOperatorInSet is a ComparisonOperator enum value
	ComparisonOperatorInSet = "in-set"

	// ComparisonOperatorNotInSet is a ComparisonOperator enum value
	ComparisonOperatorNotInSet = "not-in-set"
)
View Source 
const (
	// ConfidenceLevelLow is a ConfidenceLevel enum value
	ConfidenceLevelLow = "LOW"

	// ConfidenceLevelMedium is a ConfidenceLevel enum value
	ConfidenceLevelMedium = "MEDIUM"

	// ConfidenceLevelHigh is a ConfidenceLevel enum value
	ConfidenceLevelHigh = "HIGH"
)
View Source 
const (
	// CustomMetricTypeStringList is a CustomMetricType enum value
	CustomMetricTypeStringList = "string-list"

	// CustomMetricTypeIpAddressList is a CustomMetricType enum value
	CustomMetricTypeIpAddressList = "ip-address-list"

	// CustomMetricTypeNumberList is a CustomMetricType enum value
	CustomMetricTypeNumberList = "number-list"

	// CustomMetricTypeNumber is a CustomMetricType enum value
	CustomMetricTypeNumber = "number"
)
View Source 
const (
	// DayOfWeekSun is a DayOfWeek enum value
	DayOfWeekSun = "SUN"

	// DayOfWeekMon is a DayOfWeek enum value
	DayOfWeekMon = "MON"

	// DayOfWeekTue is a DayOfWeek enum value
	DayOfWeekTue = "TUE"

	// DayOfWeekWed is a DayOfWeek enum value
	DayOfWeekWed = "WED"

	// DayOfWeekThu is a DayOfWeek enum value
	DayOfWeekThu = "THU"

	// DayOfWeekFri is a DayOfWeek enum value
	DayOfWeekFri = "FRI"

	// DayOfWeekSat is a DayOfWeek enum value
	DayOfWeekSat = "SAT"
)
View Source 
const (
	// DetectMitigationActionExecutionStatusInProgress is a DetectMitigationActionExecutionStatus enum value
	DetectMitigationActionExecutionStatusInProgress = "IN_PROGRESS"

	// DetectMitigationActionExecutionStatusSuccessful is a DetectMitigationActionExecutionStatus enum value
	DetectMitigationActionExecutionStatusSuccessful = "SUCCESSFUL"

	// DetectMitigationActionExecutionStatusFailed is a DetectMitigationActionExecutionStatus enum value
	DetectMitigationActionExecutionStatusFailed = "FAILED"

	// DetectMitigationActionExecutionStatusSkipped is a DetectMitigationActionExecutionStatus enum value
	DetectMitigationActionExecutionStatusSkipped = "SKIPPED"
)
View Source 
const (
	// DetectMitigationActionsTaskStatusInProgress is a DetectMitigationActionsTaskStatus enum value
	DetectMitigationActionsTaskStatusInProgress = "IN_PROGRESS"

	// DetectMitigationActionsTaskStatusSuccessful is a DetectMitigationActionsTaskStatus enum value
	DetectMitigationActionsTaskStatusSuccessful = "SUCCESSFUL"

	// DetectMitigationActionsTaskStatusFailed is a DetectMitigationActionsTaskStatus enum value
	DetectMitigationActionsTaskStatusFailed = "FAILED"

	// DetectMitigationActionsTaskStatusCanceled is a DetectMitigationActionsTaskStatus enum value
	DetectMitigationActionsTaskStatusCanceled = "CANCELED"
)
View Source 
const (
	// DeviceDefenderIndexingModeOff is a DeviceDefenderIndexingMode enum value
	DeviceDefenderIndexingModeOff = "OFF"

	// DeviceDefenderIndexingModeViolations is a DeviceDefenderIndexingMode enum value
	DeviceDefenderIndexingModeViolations = "VIOLATIONS"
)
View Source 
const (
	// DimensionValueOperatorIn is a DimensionValueOperator enum value
	DimensionValueOperatorIn = "IN"

	// DimensionValueOperatorNotIn is a DimensionValueOperator enum value
	DimensionValueOperatorNotIn = "NOT_IN"
)
View Source 
const (
	// DomainConfigurationStatusEnabled is a DomainConfigurationStatus enum value
	DomainConfigurationStatusEnabled = "ENABLED"

	// DomainConfigurationStatusDisabled is a DomainConfigurationStatus enum value
	DomainConfigurationStatusDisabled = "DISABLED"
)
View Source 
const (
	// DomainTypeEndpoint is a DomainType enum value
	DomainTypeEndpoint = "ENDPOINT"

	// DomainTypeAwsManaged is a DomainType enum value
	DomainTypeAwsManaged = "AWS_MANAGED"

	// DomainTypeCustomerManaged is a DomainType enum value
	DomainTypeCustomerManaged = "CUSTOMER_MANAGED"
)
View Source 
const (
	// DynamicGroupStatusActive is a DynamicGroupStatus enum value
	DynamicGroupStatusActive = "ACTIVE"

	// DynamicGroupStatusBuilding is a DynamicGroupStatus enum value
	DynamicGroupStatusBuilding = "BUILDING"

	// DynamicGroupStatusRebuilding is a DynamicGroupStatus enum value
	DynamicGroupStatusRebuilding = "REBUILDING"
)
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"

	// EventTypePolicy is a EventType enum value
	EventTypePolicy = "POLICY"

	// EventTypeCertificate is a EventType enum value
	EventTypeCertificate = "CERTIFICATE"

	// EventTypeCaCertificate is a EventType enum value
	EventTypeCaCertificate = "CA_CERTIFICATE"
)
View Source 
const (
	// FieldTypeNumber is a FieldType enum value
	FieldTypeNumber = "Number"

	// FieldTypeString is a FieldType enum value
	FieldTypeString = "String"

	// FieldTypeBoolean is a FieldType enum value
	FieldTypeBoolean = "Boolean"
)
View Source 
const (
	// FleetMetricUnitSeconds is a FleetMetricUnit enum value
	FleetMetricUnitSeconds = "Seconds"

	// FleetMetricUnitMicroseconds is a FleetMetricUnit enum value
	FleetMetricUnitMicroseconds = "Microseconds"

	// FleetMetricUnitMilliseconds is a FleetMetricUnit enum value
	FleetMetricUnitMilliseconds = "Milliseconds"

	// FleetMetricUnitBytes is a FleetMetricUnit enum value
	FleetMetricUnitBytes = "Bytes"

	// FleetMetricUnitKilobytes is a FleetMetricUnit enum value
	FleetMetricUnitKilobytes = "Kilobytes"

	// FleetMetricUnitMegabytes is a FleetMetricUnit enum value
	FleetMetricUnitMegabytes = "Megabytes"

	// FleetMetricUnitGigabytes is a FleetMetricUnit enum value
	FleetMetricUnitGigabytes = "Gigabytes"

	// FleetMetricUnitTerabytes is a FleetMetricUnit enum value
	FleetMetricUnitTerabytes = "Terabytes"

	// FleetMetricUnitBits is a FleetMetricUnit enum value
	FleetMetricUnitBits = "Bits"

	// FleetMetricUnitKilobits is a FleetMetricUnit enum value
	FleetMetricUnitKilobits = "Kilobits"

	// FleetMetricUnitMegabits is a FleetMetricUnit enum value
	FleetMetricUnitMegabits = "Megabits"

	// FleetMetricUnitGigabits is a FleetMetricUnit enum value
	FleetMetricUnitGigabits = "Gigabits"

	// FleetMetricUnitTerabits is a FleetMetricUnit enum value
	FleetMetricUnitTerabits = "Terabits"

	// FleetMetricUnitPercent is a FleetMetricUnit enum value
	FleetMetricUnitPercent = "Percent"

	// FleetMetricUnitCount is a FleetMetricUnit enum value
	FleetMetricUnitCount = "Count"

	// FleetMetricUnitBytesSecond is a FleetMetricUnit enum value
	FleetMetricUnitBytesSecond = "Bytes/Second"

	// FleetMetricUnitKilobytesSecond is a FleetMetricUnit enum value
	FleetMetricUnitKilobytesSecond = "Kilobytes/Second"

	// FleetMetricUnitMegabytesSecond is a FleetMetricUnit enum value
	FleetMetricUnitMegabytesSecond = "Megabytes/Second"

	// FleetMetricUnitGigabytesSecond is a FleetMetricUnit enum value
	FleetMetricUnitGigabytesSecond = "Gigabytes/Second"

	// FleetMetricUnitTerabytesSecond is a FleetMetricUnit enum value
	FleetMetricUnitTerabytesSecond = "Terabytes/Second"

	// FleetMetricUnitBitsSecond is a FleetMetricUnit enum value
	FleetMetricUnitBitsSecond = "Bits/Second"

	// FleetMetricUnitKilobitsSecond is a FleetMetricUnit enum value
	FleetMetricUnitKilobitsSecond = "Kilobits/Second"

	// FleetMetricUnitMegabitsSecond is a FleetMetricUnit enum value
	FleetMetricUnitMegabitsSecond = "Megabits/Second"

	// FleetMetricUnitGigabitsSecond is a FleetMetricUnit enum value
	FleetMetricUnitGigabitsSecond = "Gigabits/Second"

	// FleetMetricUnitTerabitsSecond is a FleetMetricUnit enum value
	FleetMetricUnitTerabitsSecond = "Terabits/Second"

	// FleetMetricUnitCountSecond is a FleetMetricUnit enum value
	FleetMetricUnitCountSecond = "Count/Second"

	// FleetMetricUnitNone is a FleetMetricUnit enum value
	FleetMetricUnitNone = "None"
)
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 (
	// JobExecutionFailureTypeFailed is a JobExecutionFailureType enum value
	JobExecutionFailureTypeFailed = "FAILED"

	// JobExecutionFailureTypeRejected is a JobExecutionFailureType enum value
	JobExecutionFailureTypeRejected = "REJECTED"

	// JobExecutionFailureTypeTimedOut is a JobExecutionFailureType enum value
	JobExecutionFailureTypeTimedOut = "TIMED_OUT"

	// JobExecutionFailureTypeAll is a JobExecutionFailureType enum value
	JobExecutionFailureTypeAll = "ALL"
)
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"

	// JobExecutionStatusTimedOut is a JobExecutionStatus enum value
	JobExecutionStatusTimedOut = "TIMED_OUT"

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

	// LogTargetTypeClientId is a LogTargetType enum value
	LogTargetTypeClientId = "CLIENT_ID"

	// LogTargetTypeSourceIp is a LogTargetType enum value
	LogTargetTypeSourceIp = "SOURCE_IP"

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

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

	// MitigationActionTypeUpdateCaCertificate is a MitigationActionType enum value
	MitigationActionTypeUpdateCaCertificate = "UPDATE_CA_CERTIFICATE"

	// MitigationActionTypeAddThingsToThingGroup is a MitigationActionType enum value
	MitigationActionTypeAddThingsToThingGroup = "ADD_THINGS_TO_THING_GROUP"

	// MitigationActionTypeReplaceDefaultPolicyVersion is a MitigationActionType enum value
	MitigationActionTypeReplaceDefaultPolicyVersion = "REPLACE_DEFAULT_POLICY_VERSION"

	// MitigationActionTypeEnableIotLogging is a MitigationActionType enum value
	MitigationActionTypeEnableIotLogging = "ENABLE_IOT_LOGGING"

	// MitigationActionTypePublishFindingToSns is a MitigationActionType enum value
	MitigationActionTypePublishFindingToSns = "PUBLISH_FINDING_TO_SNS"
)
View Source 
const (
	// ModelStatusPendingBuild is a ModelStatus enum value
	ModelStatusPendingBuild = "PENDING_BUILD"

	// ModelStatusActive is a ModelStatus enum value
	ModelStatusActive = "ACTIVE"

	// ModelStatusExpired is a ModelStatus enum value
	ModelStatusExpired = "EXPIRED"
)
View Source 
const (
	// NamedShadowIndexingModeOff is a NamedShadowIndexingMode enum value
	NamedShadowIndexingModeOff = "OFF"

	// NamedShadowIndexingModeOn is a NamedShadowIndexingMode enum value
	NamedShadowIndexingModeOn = "ON"
)
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 (
	// ProtocolMqtt is a Protocol enum value
	ProtocolMqtt = "MQTT"

	// ProtocolHttp is a Protocol enum value
	ProtocolHttp = "HTTP"
)
View Source 
const (
	// ReportTypeErrors is a ReportType enum value
	ReportTypeErrors = "ERRORS"

	// ReportTypeResults is a ReportType enum value
	ReportTypeResults = "RESULTS"
)
View Source 
const (
	// ResourceTypeDeviceCertificate is a ResourceType enum value
	ResourceTypeDeviceCertificate = "DEVICE_CERTIFICATE"

	// ResourceTypeCaCertificate is a ResourceType enum value
	ResourceTypeCaCertificate = "CA_CERTIFICATE"

	// ResourceTypeIotPolicy is a ResourceType enum value
	ResourceTypeIotPolicy = "IOT_POLICY"

	// ResourceTypeCognitoIdentityPool is a ResourceType enum value
	ResourceTypeCognitoIdentityPool = "COGNITO_IDENTITY_POOL"

	// ResourceTypeClientId is a ResourceType enum value
	ResourceTypeClientId = "CLIENT_ID"

	// ResourceTypeAccountSettings is a ResourceType enum value
	ResourceTypeAccountSettings = "ACCOUNT_SETTINGS"

	// ResourceTypeRoleAlias is a ResourceType enum value
	ResourceTypeRoleAlias = "ROLE_ALIAS"

	// ResourceTypeIamRole is a ResourceType enum value
	ResourceTypeIamRole = "IAM_ROLE"
)
View Source 
const (
	// RetryableFailureTypeFailed is a RetryableFailureType enum value
	RetryableFailureTypeFailed = "FAILED"

	// RetryableFailureTypeTimedOut is a RetryableFailureType enum value
	RetryableFailureTypeTimedOut = "TIMED_OUT"

	// RetryableFailureTypeAll is a RetryableFailureType enum value
	RetryableFailureTypeAll = "ALL"
)
View Source 
const (
	// ServerCertificateStatusInvalid is a ServerCertificateStatus enum value
	ServerCertificateStatusInvalid = "INVALID"

	// ServerCertificateStatusValid is a ServerCertificateStatus enum value
	ServerCertificateStatusValid = "VALID"
)
View Source 
const (
	// ServiceTypeData is a ServiceType enum value
	ServiceTypeData = "DATA"

	// ServiceTypeCredentialProvider is a ServiceType enum value
	ServiceTypeCredentialProvider = "CREDENTIAL_PROVIDER"

	// ServiceTypeJobs is a ServiceType enum value
	ServiceTypeJobs = "JOBS"
)
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 (
	// ThingConnectivityIndexingModeOff is a ThingConnectivityIndexingMode enum value
	ThingConnectivityIndexingModeOff = "OFF"

	// ThingConnectivityIndexingModeStatus is a ThingConnectivityIndexingMode enum value
	ThingConnectivityIndexingModeStatus = "STATUS"
)
View Source 
const (
	// ThingGroupIndexingModeOff is a ThingGroupIndexingMode enum value
	ThingGroupIndexingModeOff = "OFF"

	// ThingGroupIndexingModeOn is a ThingGroupIndexingMode enum value
	ThingGroupIndexingModeOn = "ON"
)
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 (
	// TopicRuleDestinationStatusEnabled is a TopicRuleDestinationStatus enum value
	TopicRuleDestinationStatusEnabled = "ENABLED"

	// TopicRuleDestinationStatusInProgress is a TopicRuleDestinationStatus enum value
	TopicRuleDestinationStatusInProgress = "IN_PROGRESS"

	// TopicRuleDestinationStatusDisabled is a TopicRuleDestinationStatus enum value
	TopicRuleDestinationStatusDisabled = "DISABLED"

	// TopicRuleDestinationStatusError is a TopicRuleDestinationStatus enum value
	TopicRuleDestinationStatusError = "ERROR"

	// TopicRuleDestinationStatusDeleting is a TopicRuleDestinationStatus enum value
	TopicRuleDestinationStatusDeleting = "DELETING"
)
View Source 
const (
	// VerificationStateFalsePositive is a VerificationState enum value
	VerificationStateFalsePositive = "FALSE_POSITIVE"

	// VerificationStateBenignPositive is a VerificationState enum value
	VerificationStateBenignPositive = "BENIGN_POSITIVE"

	// VerificationStateTruePositive is a VerificationState enum value
	VerificationStateTruePositive = "TRUE_POSITIVE"

	// VerificationStateUnknown is a VerificationState enum value
	VerificationStateUnknown = "UNKNOWN"
)
View Source 
const (
	// ViolationEventTypeInAlarm is a ViolationEventType enum value
	ViolationEventTypeInAlarm = "in-alarm"

	// ViolationEventTypeAlarmCleared is a ViolationEventType enum value
	ViolationEventTypeAlarmCleared = "alarm-cleared"

	// ViolationEventTypeAlarmInvalidated is a ViolationEventType enum value
	ViolationEventTypeAlarmInvalidated = "alarm-invalidated"
)
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"

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

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

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Internal error from the service that indicates an unexpected error or that
	// the service is unavailable.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidAggregationException for service response error code
	// "InvalidAggregationException".
	//
	// The aggregation is invalid.
	ErrCodeInvalidAggregationException = "InvalidAggregationException"

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

	// ErrCodeTaskAlreadyExistsException for service response error code
	// "TaskAlreadyExistsException".
	//
	// This exception occurs if you attempt to start a task with the same task-id
	// as an existing task but with a different clientRequestToken.
	ErrCodeTaskAlreadyExistsException = "TaskAlreadyExistsException"

	// 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 identifier of a specific service.
)

Service information constants

View Source 
const (
	// AbortActionCancel is a AbortAction enum value
	AbortActionCancel = "CANCEL"
)
View Source 
const (
	// AlertTargetTypeSns is a AlertTargetType enum value
	AlertTargetTypeSns = "SNS"
)

The type of alert target: one of "SNS".

View Source 
const (
	// AuditNotificationTypeSns is a AuditNotificationType enum value
	AuditNotificationTypeSns = "SNS"
)
View Source 
const (
	// AwsJobAbortCriteriaAbortActionCancel is a AwsJobAbortCriteriaAbortAction enum value
	AwsJobAbortCriteriaAbortActionCancel = "CANCEL"
)
View Source 
const (
	// CACertificateUpdateActionDeactivate is a CACertificateUpdateAction enum value
	CACertificateUpdateActionDeactivate = "DEACTIVATE"
)
View Source 
const (
	// DeviceCertificateUpdateActionDeactivate is a DeviceCertificateUpdateAction enum value
	DeviceCertificateUpdateActionDeactivate = "DEACTIVATE"
)
View Source 
const (
	// DimensionTypeTopicFilter is a DimensionType enum value
	DimensionTypeTopicFilter = "TOPIC_FILTER"
)
View Source 
const (
	// PolicyTemplateNameBlankPolicy is a PolicyTemplateName enum value
	PolicyTemplateNameBlankPolicy = "BLANK_POLICY"
)

Variables

This section is empty.

Functions

func AbortAction_Values added in v1.34.3 

func AbortAction_Values() []string

AbortAction_Values returns all elements of the AbortAction enum

func ActionType_Values added in v1.34.3 

func ActionType_Values() []string

ActionType_Values returns all elements of the ActionType enum

func AggregationTypeName_Values added in v1.40.34 

func AggregationTypeName_Values() []string

AggregationTypeName_Values returns all elements of the AggregationTypeName enum

func AlertTargetType_Values added in v1.34.3 

func AlertTargetType_Values() []string

AlertTargetType_Values returns all elements of the AlertTargetType enum

func AuditCheckRunStatus_Values added in v1.34.3 

func AuditCheckRunStatus_Values() []string

AuditCheckRunStatus_Values returns all elements of the AuditCheckRunStatus enum

func AuditFindingSeverity_Values added in v1.34.3 

func AuditFindingSeverity_Values() []string

AuditFindingSeverity_Values returns all elements of the AuditFindingSeverity enum

func AuditFrequency_Values added in v1.34.3 

func AuditFrequency_Values() []string

AuditFrequency_Values returns all elements of the AuditFrequency enum

func AuditMitigationActionsExecutionStatus_Values added in v1.34.3 

func AuditMitigationActionsExecutionStatus_Values() []string

AuditMitigationActionsExecutionStatus_Values returns all elements of the AuditMitigationActionsExecutionStatus enum

func AuditMitigationActionsTaskStatus_Values added in v1.34.3 

func AuditMitigationActionsTaskStatus_Values() []string

AuditMitigationActionsTaskStatus_Values returns all elements of the AuditMitigationActionsTaskStatus enum

func AuditNotificationType_Values added in v1.34.3 

func AuditNotificationType_Values() []string

AuditNotificationType_Values returns all elements of the AuditNotificationType enum

func AuditTaskStatus_Values added in v1.34.3 

func AuditTaskStatus_Values() []string

AuditTaskStatus_Values returns all elements of the AuditTaskStatus enum

func AuditTaskType_Values added in v1.34.3 

func AuditTaskType_Values() []string

AuditTaskType_Values returns all elements of the AuditTaskType enum

func AuthDecision_Values added in v1.34.3 

func AuthDecision_Values() []string

AuthDecision_Values returns all elements of the AuthDecision enum

func AuthorizerStatus_Values added in v1.34.3 

func AuthorizerStatus_Values() []string

AuthorizerStatus_Values returns all elements of the AuthorizerStatus enum

func AutoRegistrationStatus_Values added in v1.34.3 

func AutoRegistrationStatus_Values() []string

AutoRegistrationStatus_Values returns all elements of the AutoRegistrationStatus enum

func AwsJobAbortCriteriaAbortAction_Values added in v1.34.3 

func AwsJobAbortCriteriaAbortAction_Values() []string

AwsJobAbortCriteriaAbortAction_Values returns all elements of the AwsJobAbortCriteriaAbortAction enum

func AwsJobAbortCriteriaFailureType_Values added in v1.34.3 

func AwsJobAbortCriteriaFailureType_Values() []string

AwsJobAbortCriteriaFailureType_Values returns all elements of the AwsJobAbortCriteriaFailureType enum

func BehaviorCriteriaType_Values added in v1.36.9 

func BehaviorCriteriaType_Values() []string

BehaviorCriteriaType_Values returns all elements of the BehaviorCriteriaType enum

func CACertificateStatus_Values added in v1.34.3 

func CACertificateStatus_Values() []string

CACertificateStatus_Values returns all elements of the CACertificateStatus enum

func CACertificateUpdateAction_Values added in v1.34.3 

func CACertificateUpdateAction_Values() []string

CACertificateUpdateAction_Values returns all elements of the CACertificateUpdateAction enum

func CannedAccessControlList_Values added in v1.34.3 

func CannedAccessControlList_Values() []string

CannedAccessControlList_Values returns all elements of the CannedAccessControlList enum

func CertificateMode_Values added in v1.34.3 

func CertificateMode_Values() []string

CertificateMode_Values returns all elements of the CertificateMode enum

func CertificateStatus_Values added in v1.34.3 

func CertificateStatus_Values() []string

CertificateStatus_Values returns all elements of the CertificateStatus enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func ConfidenceLevel_Values added in v1.36.9 

func ConfidenceLevel_Values() []string

ConfidenceLevel_Values returns all elements of the ConfidenceLevel enum

func CustomMetricType_Values added in v1.36.9 

func CustomMetricType_Values() []string

CustomMetricType_Values returns all elements of the CustomMetricType enum

func DayOfWeek_Values added in v1.34.3 

func DayOfWeek_Values() []string

DayOfWeek_Values returns all elements of the DayOfWeek enum

func DetectMitigationActionExecutionStatus_Values added in v1.36.9 

func DetectMitigationActionExecutionStatus_Values() []string

DetectMitigationActionExecutionStatus_Values returns all elements of the DetectMitigationActionExecutionStatus enum

func DetectMitigationActionsTaskStatus_Values added in v1.36.9 

func DetectMitigationActionsTaskStatus_Values() []string

DetectMitigationActionsTaskStatus_Values returns all elements of the DetectMitigationActionsTaskStatus enum

func DeviceCertificateUpdateAction_Values added in v1.34.3 

func DeviceCertificateUpdateAction_Values() []string

DeviceCertificateUpdateAction_Values returns all elements of the DeviceCertificateUpdateAction enum

func DeviceDefenderIndexingMode_Values added in v1.42.16 

func DeviceDefenderIndexingMode_Values() []string

DeviceDefenderIndexingMode_Values returns all elements of the DeviceDefenderIndexingMode enum

func DimensionType_Values added in v1.34.3 

func DimensionType_Values() []string

DimensionType_Values returns all elements of the DimensionType enum

func DimensionValueOperator_Values added in v1.34.3 

func DimensionValueOperator_Values() []string

DimensionValueOperator_Values returns all elements of the DimensionValueOperator enum

func DomainConfigurationStatus_Values added in v1.34.3 

func DomainConfigurationStatus_Values() []string

DomainConfigurationStatus_Values returns all elements of the DomainConfigurationStatus enum

func DomainType_Values added in v1.34.3 

func DomainType_Values() []string

DomainType_Values returns all elements of the DomainType enum

func DynamicGroupStatus_Values added in v1.34.3 

func DynamicGroupStatus_Values() []string

DynamicGroupStatus_Values returns all elements of the DynamicGroupStatus enum

func DynamoKeyType_Values added in v1.34.3 

func DynamoKeyType_Values() []string

DynamoKeyType_Values returns all elements of the DynamoKeyType enum

func EventType_Values added in v1.34.3 

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func FieldType_Values added in v1.34.3 

func FieldType_Values() []string

FieldType_Values returns all elements of the FieldType enum

func FleetMetricUnit_Values added in v1.40.34 

func FleetMetricUnit_Values() []string

FleetMetricUnit_Values returns all elements of the FleetMetricUnit enum

func IndexStatus_Values added in v1.34.3 

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func JobExecutionFailureType_Values added in v1.34.3 

func JobExecutionFailureType_Values() []string

JobExecutionFailureType_Values returns all elements of the JobExecutionFailureType enum

func JobExecutionStatus_Values added in v1.34.3 

func JobExecutionStatus_Values() []string

JobExecutionStatus_Values returns all elements of the JobExecutionStatus enum

func JobStatus_Values added in v1.34.3 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func LogLevel_Values added in v1.34.3 

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func LogTargetType_Values added in v1.34.3 

func LogTargetType_Values() []string

LogTargetType_Values returns all elements of the LogTargetType enum

func MessageFormat_Values added in v1.34.3 

func MessageFormat_Values() []string

MessageFormat_Values returns all elements of the MessageFormat enum

func MitigationActionType_Values added in v1.34.3 

func MitigationActionType_Values() []string

MitigationActionType_Values returns all elements of the MitigationActionType enum

func ModelStatus_Values added in v1.36.9 

func ModelStatus_Values() []string

ModelStatus_Values returns all elements of the ModelStatus enum

func NamedShadowIndexingMode_Values added in v1.42.16 

func NamedShadowIndexingMode_Values() []string

NamedShadowIndexingMode_Values returns all elements of the NamedShadowIndexingMode enum

func OTAUpdateStatus_Values added in v1.34.3 

func OTAUpdateStatus_Values() []string

OTAUpdateStatus_Values returns all elements of the OTAUpdateStatus enum

func PolicyTemplateName_Values added in v1.34.3 

func PolicyTemplateName_Values() []string

PolicyTemplateName_Values returns all elements of the PolicyTemplateName enum

func Protocol_Values added in v1.34.3 

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

func ReportType_Values added in v1.34.3 

func ReportType_Values() []string

ReportType_Values returns all elements of the ReportType enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func RetryableFailureType_Values added in v1.42.28 

func RetryableFailureType_Values() []string

RetryableFailureType_Values returns all elements of the RetryableFailureType enum

func ServerCertificateStatus_Values added in v1.34.3 

func ServerCertificateStatus_Values() []string

ServerCertificateStatus_Values returns all elements of the ServerCertificateStatus enum

func ServiceType_Values added in v1.34.3 

func ServiceType_Values() []string

ServiceType_Values returns all elements of the ServiceType enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func TargetSelection_Values added in v1.34.3 

func TargetSelection_Values() []string

TargetSelection_Values returns all elements of the TargetSelection enum

func ThingConnectivityIndexingMode_Values added in v1.34.3 

func ThingConnectivityIndexingMode_Values() []string

ThingConnectivityIndexingMode_Values returns all elements of the ThingConnectivityIndexingMode enum

func ThingGroupIndexingMode_Values added in v1.34.3 

func ThingGroupIndexingMode_Values() []string

ThingGroupIndexingMode_Values returns all elements of the ThingGroupIndexingMode enum

func ThingIndexingMode_Values added in v1.34.3 

func ThingIndexingMode_Values() []string

ThingIndexingMode_Values returns all elements of the ThingIndexingMode enum

func TopicRuleDestinationStatus_Values added in v1.34.3 

func TopicRuleDestinationStatus_Values() []string

TopicRuleDestinationStatus_Values returns all elements of the TopicRuleDestinationStatus enum

func VerificationState_Values added in v1.40.46 

func VerificationState_Values() []string

VerificationState_Values returns all elements of the VerificationState enum

func ViolationEventType_Values added in v1.34.3 

func ViolationEventType_Values() []string

ViolationEventType_Values returns all elements of the ViolationEventType enum

Types

type AbortConfig added in v1.15.79 

type AbortConfig struct {

	// The list of criteria that determine when and how to abort the job.
	//
	// CriteriaList is a required field
	CriteriaList []*AbortCriteria `locationName:"criteriaList" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The criteria that determine when and how a job abort takes place.

func (AbortConfig) GoString added in v1.15.79 

func (s AbortConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortConfig) SetCriteriaList added in v1.15.79 

func (s *AbortConfig) SetCriteriaList(v []*AbortCriteria) *AbortConfig

SetCriteriaList sets the CriteriaList field's value.

func (AbortConfig) String added in v1.15.79 

func (s AbortConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortConfig) Validate added in v1.15.79 

func (s *AbortConfig) Validate() error

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

type AbortCriteria added in v1.15.79 

type AbortCriteria struct {

	// The type of job action to take to initiate the job abort.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"AbortAction"`

	// The type of job execution failures that can initiate a job abort.
	//
	// FailureType is a required field
	FailureType *string `locationName:"failureType" type:"string" required:"true" enum:"JobExecutionFailureType"`

	// The minimum number of things which must receive job execution notifications
	// before the job can be aborted.
	//
	// MinNumberOfExecutedThings is a required field
	MinNumberOfExecutedThings *int64 `locationName:"minNumberOfExecutedThings" min:"1" type:"integer" required:"true"`

	// The minimum percentage of job execution failures that must occur to initiate
	// the job abort.
	//
	// Amazon Web Services IoT Core supports up to two digits after the decimal
	// (for example, 10.9 and 10.99, but not 10.999).
	//
	// ThresholdPercentage is a required field
	ThresholdPercentage *float64 `locationName:"thresholdPercentage" type:"double" required:"true"`
	// contains filtered or unexported fields
}

The criteria that determine when and how a job abort takes place.

func (AbortCriteria) GoString added in v1.15.79 

func (s AbortCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortCriteria) SetAction added in v1.15.79 

func (s *AbortCriteria) SetAction(v string) *AbortCriteria

SetAction sets the Action field's value.

func (*AbortCriteria) SetFailureType added in v1.15.79 

func (s *AbortCriteria) SetFailureType(v string) *AbortCriteria

SetFailureType sets the FailureType field's value.

func (*AbortCriteria) SetMinNumberOfExecutedThings added in v1.15.79 

func (s *AbortCriteria) SetMinNumberOfExecutedThings(v int64) *AbortCriteria

SetMinNumberOfExecutedThings sets the MinNumberOfExecutedThings field's value.

func (*AbortCriteria) SetThresholdPercentage added in v1.15.79 

func (s *AbortCriteria) SetThresholdPercentage(v float64) *AbortCriteria

SetThresholdPercentage sets the ThresholdPercentage field's value.

func (AbortCriteria) String added in v1.15.79 

func (s AbortCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortCriteria) Validate added in v1.15.79 

func (s *AbortCriteria) Validate() error

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

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 

func (s AcceptCertificateTransferInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptCertificateTransferInput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (*AcceptCertificateTransferInput) SetSetAsActive added in v1.5.0 

func (s *AcceptCertificateTransferInput) SetSetAsActive(v bool) *AcceptCertificateTransferInput

SetSetAsActive sets the SetAsActive field's value.

func (AcceptCertificateTransferInput) String 

func (s AcceptCertificateTransferInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s AcceptCertificateTransferOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AcceptCertificateTransferOutput) String 

func (s AcceptCertificateTransferOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Action 

type Action struct {

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

	// Send data to CloudWatch Logs.
	CloudwatchLogs *CloudwatchLogsAction `locationName:"cloudwatchLogs" 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 OpenSearch Service domain.
	//
	// The Elasticsearch action can only be used by existing rule actions. To create
	// a new rule action or to update an existing rule action, use the OpenSearch
	// rule action instead. For more information, see OpenSearchAction (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html).
	Elasticsearch *ElasticsearchAction `locationName:"elasticsearch" type:"structure"`

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

	// Send data to an HTTPS endpoint.
	Http *HttpAction `locationName:"http" type:"structure"`

	// Sends message data to an IoT Analytics channel.
	IotAnalytics *IotAnalyticsAction `locationName:"iotAnalytics" type:"structure"`

	// Sends an input to an IoT Events detector.
	IotEvents *IotEventsAction `locationName:"iotEvents" type:"structure"`

	// Sends data from the MQTT message that triggered the rule to IoT SiteWise
	// asset properties.
	IotSiteWise *IotSiteWiseAction `locationName:"iotSiteWise" type:"structure"`

	// Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK)
	// or self-managed Apache Kafka cluster.
	Kafka *KafkaAction `locationName:"kafka" 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"`

	// Write data to an Amazon OpenSearch Service domain.
	OpenSearch *OpenSearchAction `locationName:"openSearch" 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"`

	// Starts execution of a Step Functions state machine.
	StepFunctions *StepFunctionsAction `locationName:"stepFunctions" type:"structure"`

	// The Timestream rule action writes attributes (measures) from an MQTT message
	// into an Amazon Timestream table. For more information, see the Timestream
	// (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html)
	// topic rule action documentation.
	Timestream *TimestreamAction `locationName:"timestream" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetCloudwatchAlarm added in v1.5.0 

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

SetCloudwatchAlarm sets the CloudwatchAlarm field's value.

func (*Action) SetCloudwatchLogs added in v1.29.23 

func (s *Action) SetCloudwatchLogs(v *CloudwatchLogsAction) *Action

SetCloudwatchLogs sets the CloudwatchLogs 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) SetHttp added in v1.25.38 

func (s *Action) SetHttp(v *HttpAction) *Action

SetHttp sets the Http 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) SetIotEvents added in v1.15.83 

func (s *Action) SetIotEvents(v *IotEventsAction) *Action

SetIotEvents sets the IotEvents field's value.

func (*Action) SetIotSiteWise added in v1.25.42 

func (s *Action) SetIotSiteWise(v *IotSiteWiseAction) *Action

SetIotSiteWise sets the IotSiteWise field's value.

func (*Action) SetKafka added in v1.36.9 

func (s *Action) SetKafka(v *KafkaAction) *Action

SetKafka sets the Kafka 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) SetOpenSearch added in v1.40.42 

func (s *Action) SetOpenSearch(v *OpenSearchAction) *Action

SetOpenSearch sets the OpenSearch 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) SetStepFunctions added in v1.15.2 

func (s *Action) SetStepFunctions(v *StepFunctionsAction) *Action

SetStepFunctions sets the StepFunctions field's value.

func (*Action) SetTimestream added in v1.35.0 

func (s *Action) SetTimestream(v *TimestreamAction) *Action

SetTimestream sets the Timestream field's value.

func (Action) String 

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

type ActiveViolation struct {

	// The behavior that is being violated.
	Behavior *Behavior `locationName:"behavior" type:"structure"`

	// The time the most recent violation occurred.
	LastViolationTime *time.Time `locationName:"lastViolationTime" type:"timestamp"`

	// The value of the metric (the measurement) that caused the most recent violation.
	LastViolationValue *MetricValue `locationName:"lastViolationValue" type:"structure"`

	// The security profile with the behavior is in violation.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The name of the thing responsible for the active violation.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`

	// The verification state of the violation (detect alarm).
	VerificationState *string `locationName:"verificationState" type:"string" enum:"VerificationState"`

	// The description of the verification state of the violation.
	VerificationStateDescription *string `locationName:"verificationStateDescription" type:"string"`

	// The details of a violation event.
	ViolationEventAdditionalInfo *ViolationEventAdditionalInfo `locationName:"violationEventAdditionalInfo" type:"structure"`

	// The ID of the active violation.
	ViolationId *string `locationName:"violationId" min:"1" type:"string"`

	// The time the violation started.
	ViolationStartTime *time.Time `locationName:"violationStartTime" type:"timestamp"`
	// contains filtered or unexported fields
}

Information about an active Device Defender security profile behavior violation.

func (ActiveViolation) GoString added in v1.15.2 

func (s ActiveViolation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveViolation) SetBehavior added in v1.15.2 

func (s *ActiveViolation) SetBehavior(v *Behavior) *ActiveViolation

SetBehavior sets the Behavior field's value.

func (*ActiveViolation) SetLastViolationTime added in v1.15.2 

func (s *ActiveViolation) SetLastViolationTime(v time.Time) *ActiveViolation

SetLastViolationTime sets the LastViolationTime field's value.

func (*ActiveViolation) SetLastViolationValue added in v1.15.2 

func (s *ActiveViolation) SetLastViolationValue(v *MetricValue) *ActiveViolation

SetLastViolationValue sets the LastViolationValue field's value.

func (*ActiveViolation) SetSecurityProfileName added in v1.15.2 

func (s *ActiveViolation) SetSecurityProfileName(v string) *ActiveViolation

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*ActiveViolation) SetThingName added in v1.15.2 

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

SetThingName sets the ThingName field's value.

func (*ActiveViolation) SetVerificationState added in v1.40.46 

func (s *ActiveViolation) SetVerificationState(v string) *ActiveViolation

SetVerificationState sets the VerificationState field's value.

func (*ActiveViolation) SetVerificationStateDescription added in v1.40.46 

func (s *ActiveViolation) SetVerificationStateDescription(v string) *ActiveViolation

SetVerificationStateDescription sets the VerificationStateDescription field's value.

func (*ActiveViolation) SetViolationEventAdditionalInfo added in v1.36.9 

func (s *ActiveViolation) SetViolationEventAdditionalInfo(v *ViolationEventAdditionalInfo) *ActiveViolation

SetViolationEventAdditionalInfo sets the ViolationEventAdditionalInfo field's value.

func (*ActiveViolation) SetViolationId added in v1.15.2 

func (s *ActiveViolation) SetViolationId(v string) *ActiveViolation

SetViolationId sets the ViolationId field's value.

func (*ActiveViolation) SetViolationStartTime added in v1.15.2 

func (s *ActiveViolation) SetViolationStartTime(v time.Time) *ActiveViolation

SetViolationStartTime sets the ViolationStartTime field's value.

func (ActiveViolation) String added in v1.15.2 

func (s ActiveViolation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddThingToBillingGroupInput added in v1.15.79 

type AddThingToBillingGroupInput struct {

	// The ARN of the billing group.
	BillingGroupArn *string `locationName:"billingGroupArn" type:"string"`

	// The name of the billing group.
	//
	// This call is asynchronous. It might take several seconds for the detachment
	// to propagate.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`

	// The ARN of the thing to be added to the billing group.
	ThingArn *string `locationName:"thingArn" type:"string"`

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

func (AddThingToBillingGroupInput) GoString added in v1.15.79 

func (s AddThingToBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddThingToBillingGroupInput) SetBillingGroupArn added in v1.15.79 

func (s *AddThingToBillingGroupInput) SetBillingGroupArn(v string) *AddThingToBillingGroupInput

SetBillingGroupArn sets the BillingGroupArn field's value.

func (*AddThingToBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *AddThingToBillingGroupInput) SetBillingGroupName(v string) *AddThingToBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*AddThingToBillingGroupInput) SetThingArn added in v1.15.79 

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

SetThingArn sets the ThingArn field's value.

func (*AddThingToBillingGroupInput) SetThingName added in v1.15.79 

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

SetThingName sets the ThingName field's value.

func (AddThingToBillingGroupInput) String added in v1.15.79 

func (s AddThingToBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddThingToBillingGroupInput) Validate added in v1.15.79 

func (s *AddThingToBillingGroupInput) Validate() error

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

type AddThingToBillingGroupOutput added in v1.15.79 

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

func (AddThingToBillingGroupOutput) GoString added in v1.15.79 

func (s AddThingToBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddThingToBillingGroupOutput) String added in v1.15.79 

func (s AddThingToBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddThingToThingGroupInput added in v1.12.36 

type AddThingToThingGroupInput struct {

	// Override dynamic thing groups with static thing groups when 10-group limit
	// is reached. If a thing belongs to 10 thing groups, and one or more of those
	// groups are dynamic thing groups, adding a thing to a static group removes
	// the thing from the last dynamic group.
	OverrideDynamicGroups *bool `locationName:"overrideDynamicGroups" type:"boolean"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddThingToThingGroupInput) SetOverrideDynamicGroups added in v1.15.79 

func (s *AddThingToThingGroupInput) SetOverrideDynamicGroups(v bool) *AddThingToThingGroupInput

SetOverrideDynamicGroups sets the OverrideDynamicGroups field's value.

func (*AddThingToThingGroupInput) SetThingArn added in v1.12.36 

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

SetThingArn sets the ThingArn field's value.

func (*AddThingToThingGroupInput) SetThingGroupArn added in v1.12.36 

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

SetThingGroupArn sets the ThingGroupArn field's value.

func (*AddThingToThingGroupInput) SetThingGroupName added in v1.12.36 

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

SetThingGroupName sets the ThingGroupName field's value.

func (*AddThingToThingGroupInput) SetThingName added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddThingToThingGroupOutput) String added in v1.12.36 

func (s AddThingToThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddThingsToThingGroupParams added in v1.21.10 

type AddThingsToThingGroupParams struct {

	// Specifies if this mitigation action can move the things that triggered the
	// mitigation action even if they are part of one or more dynamic thing groups.
	OverrideDynamicGroups *bool `locationName:"overrideDynamicGroups" type:"boolean"`

	// The list of groups to which you want to add the things that triggered the
	// mitigation action. You can add a thing to a maximum of 10 groups, but you
	// can't add a thing to more than one group in the same hierarchy.
	//
	// ThingGroupNames is a required field
	ThingGroupNames []*string `locationName:"thingGroupNames" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Parameters used when defining a mitigation action that move a set of things to a thing group.

func (AddThingsToThingGroupParams) GoString added in v1.21.10 

func (s AddThingsToThingGroupParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddThingsToThingGroupParams) SetOverrideDynamicGroups added in v1.21.10 

func (s *AddThingsToThingGroupParams) SetOverrideDynamicGroups(v bool) *AddThingsToThingGroupParams

SetOverrideDynamicGroups sets the OverrideDynamicGroups field's value.

func (*AddThingsToThingGroupParams) SetThingGroupNames added in v1.21.10 

func (s *AddThingsToThingGroupParams) SetThingGroupNames(v []*string) *AddThingsToThingGroupParams

SetThingGroupNames sets the ThingGroupNames field's value.

func (AddThingsToThingGroupParams) String added in v1.21.10 

func (s AddThingsToThingGroupParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddThingsToThingGroupParams) Validate added in v1.21.10 

func (s *AddThingsToThingGroupParams) Validate() error

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

type AggregationType added in v1.40.34 

type AggregationType struct {

	// The name of the aggregation type.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" enum:"AggregationTypeName"`

	// A list of the values of aggregation types.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

The type of aggregation queries.

func (AggregationType) GoString added in v1.40.34 

func (s AggregationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AggregationType) SetName added in v1.40.34 

func (s *AggregationType) SetName(v string) *AggregationType

SetName sets the Name field's value.

func (*AggregationType) SetValues added in v1.40.34 

func (s *AggregationType) SetValues(v []*string) *AggregationType

SetValues sets the Values field's value.

func (AggregationType) String added in v1.40.34 

func (s AggregationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AggregationType) Validate added in v1.40.34 

func (s *AggregationType) Validate() error

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

type AlertTarget added in v1.15.2 

type AlertTarget struct {

	// The Amazon Resource Name (ARN) of the notification target to which alerts
	// are sent.
	//
	// AlertTargetArn is a required field
	AlertTargetArn *string `locationName:"alertTargetArn" type:"string" required:"true"`

	// The ARN of the role that grants permission to send alerts to the notification
	// target.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure containing the alert target ARN and the role ARN.

func (AlertTarget) GoString added in v1.15.2 

func (s AlertTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlertTarget) SetAlertTargetArn added in v1.15.2 

func (s *AlertTarget) SetAlertTargetArn(v string) *AlertTarget

SetAlertTargetArn sets the AlertTargetArn field's value.

func (*AlertTarget) SetRoleArn added in v1.15.2 

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

SetRoleArn sets the RoleArn field's value.

func (AlertTarget) String added in v1.15.2 

func (s AlertTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlertTarget) Validate added in v1.15.2 

func (s *AlertTarget) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetPropertyTimestamp added in v1.25.42 

type AssetPropertyTimestamp struct {

	// Optional. A string that contains the nanosecond time offset. Accepts substitution
	// templates.
	OffsetInNanos *string `locationName:"offsetInNanos" type:"string"`

	// A string that contains the time in seconds since epoch. Accepts substitution
	// templates.
	//
	// TimeInSeconds is a required field
	TimeInSeconds *string `locationName:"timeInSeconds" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An asset property timestamp entry containing the following information.

func (AssetPropertyTimestamp) GoString added in v1.25.42 

func (s AssetPropertyTimestamp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyTimestamp) SetOffsetInNanos added in v1.25.42 

func (s *AssetPropertyTimestamp) SetOffsetInNanos(v string) *AssetPropertyTimestamp

SetOffsetInNanos sets the OffsetInNanos field's value.

func (*AssetPropertyTimestamp) SetTimeInSeconds added in v1.25.42 

func (s *AssetPropertyTimestamp) SetTimeInSeconds(v string) *AssetPropertyTimestamp

SetTimeInSeconds sets the TimeInSeconds field's value.

func (AssetPropertyTimestamp) String added in v1.25.42 

func (s AssetPropertyTimestamp) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyTimestamp) Validate added in v1.25.42 

func (s *AssetPropertyTimestamp) Validate() error

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

type AssetPropertyValue added in v1.25.42 

type AssetPropertyValue struct {

	// Optional. A string that describes the quality of the value. Accepts substitution
	// templates. Must be GOOD, BAD, or UNCERTAIN.
	Quality *string `locationName:"quality" type:"string"`

	// The asset property value timestamp.
	//
	// Timestamp is a required field
	Timestamp *AssetPropertyTimestamp `locationName:"timestamp" type:"structure" required:"true"`

	// The value of the asset property.
	//
	// Value is a required field
	Value *AssetPropertyVariant `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

An asset property value entry containing the following information.

func (AssetPropertyValue) GoString added in v1.25.42 

func (s AssetPropertyValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) SetQuality added in v1.25.42 

func (s *AssetPropertyValue) SetQuality(v string) *AssetPropertyValue

SetQuality sets the Quality field's value.

func (*AssetPropertyValue) SetTimestamp added in v1.25.42 

func (s *AssetPropertyValue) SetTimestamp(v *AssetPropertyTimestamp) *AssetPropertyValue

SetTimestamp sets the Timestamp field's value.

func (*AssetPropertyValue) SetValue added in v1.25.42 

func (s *AssetPropertyValue) SetValue(v *AssetPropertyVariant) *AssetPropertyValue

SetValue sets the Value field's value.

func (AssetPropertyValue) String added in v1.25.42 

func (s AssetPropertyValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) Validate added in v1.25.42 

func (s *AssetPropertyValue) Validate() error

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

type AssetPropertyVariant added in v1.25.42 

type AssetPropertyVariant struct {

	// Optional. A string that contains the boolean value (true or false) of the
	// value entry. Accepts substitution templates.
	BooleanValue *string `locationName:"booleanValue" type:"string"`

	// Optional. A string that contains the double value of the value entry. Accepts
	// substitution templates.
	DoubleValue *string `locationName:"doubleValue" type:"string"`

	// Optional. A string that contains the integer value of the value entry. Accepts
	// substitution templates.
	IntegerValue *string `locationName:"integerValue" type:"string"`

	// Optional. The string value of the value entry. Accepts substitution templates.
	StringValue *string `locationName:"stringValue" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains an asset property value (of a single type).

func (AssetPropertyVariant) GoString added in v1.25.42 

func (s AssetPropertyVariant) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyVariant) SetBooleanValue added in v1.25.42 

func (s *AssetPropertyVariant) SetBooleanValue(v string) *AssetPropertyVariant

SetBooleanValue sets the BooleanValue field's value.

func (*AssetPropertyVariant) SetDoubleValue added in v1.25.42 

func (s *AssetPropertyVariant) SetDoubleValue(v string) *AssetPropertyVariant

SetDoubleValue sets the DoubleValue field's value.

func (*AssetPropertyVariant) SetIntegerValue added in v1.25.42 

func (s *AssetPropertyVariant) SetIntegerValue(v string) *AssetPropertyVariant

SetIntegerValue sets the IntegerValue field's value.

func (*AssetPropertyVariant) SetStringValue added in v1.25.42 

func (s *AssetPropertyVariant) SetStringValue(v string) *AssetPropertyVariant

SetStringValue sets the StringValue field's value.

func (AssetPropertyVariant) String added in v1.25.42 

func (s AssetPropertyVariant) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyVariant) Validate added in v1.25.42 

func (s *AssetPropertyVariant) Validate() error

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

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

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTargetsWithJobInput) SetComment added in v1.12.36 

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

SetComment sets the Comment field's value.

func (*AssociateTargetsWithJobInput) SetJobId added in v1.12.36 

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

SetJobId sets the JobId field's value.

func (*AssociateTargetsWithJobInput) SetNamespaceId added in v1.35.17 

func (s *AssociateTargetsWithJobInput) SetNamespaceId(v string) *AssociateTargetsWithJobInput

SetNamespaceId sets the NamespaceId field's value.

func (*AssociateTargetsWithJobInput) SetTargets added in v1.12.36 

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

SetTargets sets the Targets field's value.

func (AssociateTargetsWithJobInput) String added in v1.12.36 

func (s AssociateTargetsWithJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s AssociateTargetsWithJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTargetsWithJobOutput) SetDescription added in v1.12.36 

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

SetDescription sets the Description field's value.

func (*AssociateTargetsWithJobOutput) SetJobArn added in v1.12.36 

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

SetJobArn sets the JobArn field's value.

func (*AssociateTargetsWithJobOutput) SetJobId added in v1.12.36 

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

SetJobId sets the JobId field's value.

func (AssociateTargetsWithJobOutput) String added in v1.12.36 

func (s AssociateTargetsWithJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html)
	// to which the policy is attached. For example, a thing group or a certificate.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachPolicyOutput) String added in v1.12.36 

func (s AttachPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachPrincipalPolicyInput) SetPolicyName added in v1.5.0 

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

SetPolicyName sets the PolicyName field's value.

func (*AttachPrincipalPolicyInput) SetPrincipal added in v1.5.0 

func (s *AttachPrincipalPolicyInput) SetPrincipal(v string) *AttachPrincipalPolicyInput

SetPrincipal sets the Principal field's value.

func (AttachPrincipalPolicyInput) String 

func (s AttachPrincipalPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachPrincipalPolicyOutput) String 

func (s AttachPrincipalPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachSecurityProfileInput added in v1.15.2 

type AttachSecurityProfileInput struct {

	// The security profile that is attached.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`

	// The ARN of the target (thing group) to which the security profile is attached.
	//
	// SecurityProfileTargetArn is a required field
	SecurityProfileTargetArn *string `location:"querystring" locationName:"securityProfileTargetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachSecurityProfileInput) GoString added in v1.15.2 

func (s AttachSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *AttachSecurityProfileInput) SetSecurityProfileName(v string) *AttachSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*AttachSecurityProfileInput) SetSecurityProfileTargetArn added in v1.15.2 

func (s *AttachSecurityProfileInput) SetSecurityProfileTargetArn(v string) *AttachSecurityProfileInput

SetSecurityProfileTargetArn sets the SecurityProfileTargetArn field's value.

func (AttachSecurityProfileInput) String added in v1.15.2 

func (s AttachSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachSecurityProfileInput) Validate added in v1.15.2 

func (s *AttachSecurityProfileInput) Validate() error

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

type AttachSecurityProfileOutput added in v1.15.2 

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

func (AttachSecurityProfileOutput) GoString added in v1.15.2 

func (s AttachSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachSecurityProfileOutput) String added in v1.15.2 

func (s AttachSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachThingPrincipalInput 

type AttachThingPrincipalInput struct {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachThingPrincipalInput) SetPrincipal added in v1.5.0 

func (s *AttachThingPrincipalInput) SetPrincipal(v string) *AttachThingPrincipalInput

SetPrincipal sets the Principal field's value.

func (*AttachThingPrincipalInput) SetThingName added in v1.5.0 

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

SetThingName sets the ThingName field's value.

func (AttachThingPrincipalInput) String 

func (s AttachThingPrincipalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachThingPrincipalOutput) String 

func (s AttachThingPrincipalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 or UpdateThingGroup.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditCheckConfiguration added in v1.15.2 

type AuditCheckConfiguration struct {

	// True if this audit check is enabled for this account.
	Enabled *bool `locationName:"enabled" type:"boolean"`
	// contains filtered or unexported fields
}

Which audit checks are enabled and disabled for this account.

func (AuditCheckConfiguration) GoString added in v1.15.2 

func (s AuditCheckConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditCheckConfiguration) SetEnabled added in v1.15.2 

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

SetEnabled sets the Enabled field's value.

func (AuditCheckConfiguration) String added in v1.15.2 

func (s AuditCheckConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditCheckDetails added in v1.15.2 

type AuditCheckDetails struct {

	// True if the check is complete and found all resources compliant.
	CheckCompliant *bool `locationName:"checkCompliant" type:"boolean"`

	// The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION",
	// "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
	CheckRunStatus *string `locationName:"checkRunStatus" type:"string" enum:"AuditCheckRunStatus"`

	// The code of any error encountered when this check is performed during this
	// audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The message associated with any error encountered when this check is performed
	// during this audit.
	Message *string `locationName:"message" type:"string"`

	// The number of resources that were found noncompliant during the check.
	NonCompliantResourcesCount *int64 `locationName:"nonCompliantResourcesCount" type:"long"`

	// Describes how many of the non-compliant resources created during the evaluation
	// of an audit check were marked as suppressed.
	SuppressedNonCompliantResourcesCount *int64 `locationName:"suppressedNonCompliantResourcesCount" type:"long"`

	// The number of resources on which the check was performed.
	TotalResourcesCount *int64 `locationName:"totalResourcesCount" type:"long"`
	// contains filtered or unexported fields
}

Information about the audit check.

func (AuditCheckDetails) GoString added in v1.15.2 

func (s AuditCheckDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditCheckDetails) SetCheckCompliant added in v1.15.2 

func (s *AuditCheckDetails) SetCheckCompliant(v bool) *AuditCheckDetails

SetCheckCompliant sets the CheckCompliant field's value.

func (*AuditCheckDetails) SetCheckRunStatus added in v1.15.2 

func (s *AuditCheckDetails) SetCheckRunStatus(v string) *AuditCheckDetails

SetCheckRunStatus sets the CheckRunStatus field's value.

func (*AuditCheckDetails) SetErrorCode added in v1.15.2 

func (s *AuditCheckDetails) SetErrorCode(v string) *AuditCheckDetails

SetErrorCode sets the ErrorCode field's value.

func (*AuditCheckDetails) SetMessage added in v1.15.2 

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

SetMessage sets the Message field's value.

func (*AuditCheckDetails) SetNonCompliantResourcesCount added in v1.15.2 

func (s *AuditCheckDetails) SetNonCompliantResourcesCount(v int64) *AuditCheckDetails

SetNonCompliantResourcesCount sets the NonCompliantResourcesCount field's value.

func (*AuditCheckDetails) SetSuppressedNonCompliantResourcesCount added in v1.34.3 

func (s *AuditCheckDetails) SetSuppressedNonCompliantResourcesCount(v int64) *AuditCheckDetails

SetSuppressedNonCompliantResourcesCount sets the SuppressedNonCompliantResourcesCount field's value.

func (*AuditCheckDetails) SetTotalResourcesCount added in v1.15.2 

func (s *AuditCheckDetails) SetTotalResourcesCount(v int64) *AuditCheckDetails

SetTotalResourcesCount sets the TotalResourcesCount field's value.

func (AuditCheckDetails) String added in v1.15.2 

func (s AuditCheckDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditFinding added in v1.15.2 

type AuditFinding struct {

	// The audit check that generated this result.
	CheckName *string `locationName:"checkName" type:"string"`

	// A unique identifier for this set of audit findings. This identifier is used
	// to apply mitigation tasks to one or more sets of findings.
	FindingId *string `locationName:"findingId" min:"1" type:"string"`

	// The time the result (finding) was discovered.
	FindingTime *time.Time `locationName:"findingTime" type:"timestamp"`

	// Indicates whether the audit finding was suppressed or not during reporting.
	IsSuppressed *bool `locationName:"isSuppressed" type:"boolean"`

	// The resource that was found to be noncompliant with the audit check.
	NonCompliantResource *NonCompliantResource `locationName:"nonCompliantResource" type:"structure"`

	// The reason the resource was noncompliant.
	ReasonForNonCompliance *string `locationName:"reasonForNonCompliance" type:"string"`

	// A code that indicates the reason that the resource was noncompliant.
	ReasonForNonComplianceCode *string `locationName:"reasonForNonComplianceCode" type:"string"`

	// The list of related resources.
	RelatedResources []*RelatedResource `locationName:"relatedResources" type:"list"`

	// The severity of the result (finding).
	Severity *string `locationName:"severity" type:"string" enum:"AuditFindingSeverity"`

	// The ID of the audit that generated this result (finding).
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

	// The time the audit started.
	TaskStartTime *time.Time `locationName:"taskStartTime" type:"timestamp"`
	// contains filtered or unexported fields
}

The findings (results) of the audit.

func (AuditFinding) GoString added in v1.15.2 

func (s AuditFinding) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditFinding) SetCheckName added in v1.15.2 

func (s *AuditFinding) SetCheckName(v string) *AuditFinding

SetCheckName sets the CheckName field's value.

func (*AuditFinding) SetFindingId added in v1.21.10 

func (s *AuditFinding) SetFindingId(v string) *AuditFinding

SetFindingId sets the FindingId field's value.

func (*AuditFinding) SetFindingTime added in v1.15.2 

func (s *AuditFinding) SetFindingTime(v time.Time) *AuditFinding

SetFindingTime sets the FindingTime field's value.

func (*AuditFinding) SetIsSuppressed added in v1.34.3 

func (s *AuditFinding) SetIsSuppressed(v bool) *AuditFinding

SetIsSuppressed sets the IsSuppressed field's value.

func (*AuditFinding) SetNonCompliantResource added in v1.15.2 

func (s *AuditFinding) SetNonCompliantResource(v *NonCompliantResource) *AuditFinding

SetNonCompliantResource sets the NonCompliantResource field's value.

func (*AuditFinding) SetReasonForNonCompliance added in v1.15.2 

func (s *AuditFinding) SetReasonForNonCompliance(v string) *AuditFinding

SetReasonForNonCompliance sets the ReasonForNonCompliance field's value.

func (*AuditFinding) SetReasonForNonComplianceCode added in v1.15.2 

func (s *AuditFinding) SetReasonForNonComplianceCode(v string) *AuditFinding

SetReasonForNonComplianceCode sets the ReasonForNonComplianceCode field's value.

func (*AuditFinding) SetRelatedResources added in v1.15.2 

func (s *AuditFinding) SetRelatedResources(v []*RelatedResource) *AuditFinding

SetRelatedResources sets the RelatedResources field's value.

func (*AuditFinding) SetSeverity added in v1.15.2 

func (s *AuditFinding) SetSeverity(v string) *AuditFinding

SetSeverity sets the Severity field's value.

func (*AuditFinding) SetTaskId added in v1.15.2 

func (s *AuditFinding) SetTaskId(v string) *AuditFinding

SetTaskId sets the TaskId field's value.

func (*AuditFinding) SetTaskStartTime added in v1.15.2 

func (s *AuditFinding) SetTaskStartTime(v time.Time) *AuditFinding

SetTaskStartTime sets the TaskStartTime field's value.

func (AuditFinding) String added in v1.15.2 

func (s AuditFinding) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditMitigationActionExecutionMetadata added in v1.21.10 

type AuditMitigationActionExecutionMetadata struct {

	// The unique identifier for the mitigation action being applied by the task.
	ActionId *string `locationName:"actionId" type:"string"`

	// The friendly name of the mitigation action being applied by the task.
	ActionName *string `locationName:"actionName" type:"string"`

	// The date and time when the task was completed or canceled. Blank if the task
	// is still running.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// If an error occurred, the code that indicates which type of error occurred.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The unique identifier for the findings to which the task and associated mitigation
	// action are applied.
	FindingId *string `locationName:"findingId" min:"1" type:"string"`

	// If an error occurred, a message that describes the error.
	Message *string `locationName:"message" type:"string"`

	// The date and time when the task was started.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The current status of the task being executed.
	Status *string `locationName:"status" type:"string" enum:"AuditMitigationActionsExecutionStatus"`

	// The unique identifier for the task that applies the mitigation action.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

func (AuditMitigationActionExecutionMetadata) GoString added in v1.21.10 

func (s AuditMitigationActionExecutionMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditMitigationActionExecutionMetadata) SetActionId added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetActionId(v string) *AuditMitigationActionExecutionMetadata

SetActionId sets the ActionId field's value.

func (*AuditMitigationActionExecutionMetadata) SetActionName added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetActionName(v string) *AuditMitigationActionExecutionMetadata

SetActionName sets the ActionName field's value.

func (*AuditMitigationActionExecutionMetadata) SetEndTime added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetEndTime(v time.Time) *AuditMitigationActionExecutionMetadata

SetEndTime sets the EndTime field's value.

func (*AuditMitigationActionExecutionMetadata) SetErrorCode added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetErrorCode(v string) *AuditMitigationActionExecutionMetadata

SetErrorCode sets the ErrorCode field's value.

func (*AuditMitigationActionExecutionMetadata) SetFindingId added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetFindingId(v string) *AuditMitigationActionExecutionMetadata

SetFindingId sets the FindingId field's value.

func (*AuditMitigationActionExecutionMetadata) SetMessage added in v1.21.10 

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

SetMessage sets the Message field's value.

func (*AuditMitigationActionExecutionMetadata) SetStartTime added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetStartTime(v time.Time) *AuditMitigationActionExecutionMetadata

SetStartTime sets the StartTime field's value.

func (*AuditMitigationActionExecutionMetadata) SetStatus added in v1.21.10 

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

SetStatus sets the Status field's value.

func (*AuditMitigationActionExecutionMetadata) SetTaskId added in v1.21.10 

func (s *AuditMitigationActionExecutionMetadata) SetTaskId(v string) *AuditMitigationActionExecutionMetadata

SetTaskId sets the TaskId field's value.

func (AuditMitigationActionExecutionMetadata) String added in v1.21.10 

func (s AuditMitigationActionExecutionMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditMitigationActionsTaskMetadata added in v1.21.10 

type AuditMitigationActionsTaskMetadata struct {

	// The time at which the audit mitigation actions task was started.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The unique identifier for the task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

	// The current state of the audit mitigation actions task.
	TaskStatus *string `locationName:"taskStatus" type:"string" enum:"AuditMitigationActionsTaskStatus"`
	// contains filtered or unexported fields
}

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.

func (AuditMitigationActionsTaskMetadata) GoString added in v1.21.10 

func (s AuditMitigationActionsTaskMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditMitigationActionsTaskMetadata) SetStartTime added in v1.21.10 

func (s *AuditMitigationActionsTaskMetadata) SetStartTime(v time.Time) *AuditMitigationActionsTaskMetadata

SetStartTime sets the StartTime field's value.

func (*AuditMitigationActionsTaskMetadata) SetTaskId added in v1.21.10 

func (s *AuditMitigationActionsTaskMetadata) SetTaskId(v string) *AuditMitigationActionsTaskMetadata

SetTaskId sets the TaskId field's value.

func (*AuditMitigationActionsTaskMetadata) SetTaskStatus added in v1.21.10 

func (s *AuditMitigationActionsTaskMetadata) SetTaskStatus(v string) *AuditMitigationActionsTaskMetadata

SetTaskStatus sets the TaskStatus field's value.

func (AuditMitigationActionsTaskMetadata) String added in v1.21.10 

func (s AuditMitigationActionsTaskMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditMitigationActionsTaskTarget added in v1.21.10 

type AuditMitigationActionsTaskTarget struct {

	// Specifies a filter in the form of an audit check and set of reason codes
	// that identify the findings from the audit to which the audit mitigation actions
	// task apply.
	AuditCheckToReasonCodeFilter map[string][]*string `locationName:"auditCheckToReasonCodeFilter" type:"map"`

	// If the task will apply a mitigation action to findings from a specific audit,
	// this value uniquely identifies the audit.
	AuditTaskId *string `locationName:"auditTaskId" min:"1" type:"string"`

	// If the task will apply a mitigation action to one or more listed findings,
	// this value uniquely identifies those findings.
	FindingIds []*string `locationName:"findingIds" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

func (AuditMitigationActionsTaskTarget) GoString added in v1.21.10 

func (s AuditMitigationActionsTaskTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditMitigationActionsTaskTarget) SetAuditCheckToReasonCodeFilter added in v1.21.10 

func (s *AuditMitigationActionsTaskTarget) SetAuditCheckToReasonCodeFilter(v map[string][]*string) *AuditMitigationActionsTaskTarget

SetAuditCheckToReasonCodeFilter sets the AuditCheckToReasonCodeFilter field's value.

func (*AuditMitigationActionsTaskTarget) SetAuditTaskId added in v1.21.10 

func (s *AuditMitigationActionsTaskTarget) SetAuditTaskId(v string) *AuditMitigationActionsTaskTarget

SetAuditTaskId sets the AuditTaskId field's value.

func (*AuditMitigationActionsTaskTarget) SetFindingIds added in v1.21.10 

func (s *AuditMitigationActionsTaskTarget) SetFindingIds(v []*string) *AuditMitigationActionsTaskTarget

SetFindingIds sets the FindingIds field's value.

func (AuditMitigationActionsTaskTarget) String added in v1.21.10 

func (s AuditMitigationActionsTaskTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditMitigationActionsTaskTarget) Validate added in v1.21.10 

func (s *AuditMitigationActionsTaskTarget) Validate() error

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

type AuditNotificationTarget added in v1.15.2 

type AuditNotificationTarget struct {

	// True if notifications to the target are enabled.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The ARN of the role that grants permission to send notifications to the target.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`

	// The ARN of the target (SNS topic) to which audit notifications are sent.
	TargetArn *string `locationName:"targetArn" type:"string"`
	// contains filtered or unexported fields
}

Information about the targets to which audit notifications are sent.

func (AuditNotificationTarget) GoString added in v1.15.2 

func (s AuditNotificationTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditNotificationTarget) SetEnabled added in v1.15.2 

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

SetEnabled sets the Enabled field's value.

func (*AuditNotificationTarget) SetRoleArn added in v1.15.2 

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

SetRoleArn sets the RoleArn field's value.

func (*AuditNotificationTarget) SetTargetArn added in v1.15.2 

func (s *AuditNotificationTarget) SetTargetArn(v string) *AuditNotificationTarget

SetTargetArn sets the TargetArn field's value.

func (AuditNotificationTarget) String added in v1.15.2 

func (s AuditNotificationTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditNotificationTarget) Validate added in v1.15.2 

func (s *AuditNotificationTarget) Validate() error

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

type AuditSuppression added in v1.34.3 

type AuditSuppression struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// CheckName is a required field
	CheckName *string `locationName:"checkName" type:"string" required:"true"`

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

	// The expiration date (epoch timestamp in seconds) that you want the suppression
	// to adhere to.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"`

	// Information that identifies the noncompliant resource.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure" required:"true"`

	// Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool `locationName:"suppressIndefinitely" type:"boolean"`
	// contains filtered or unexported fields
}

Filters out specific findings of a Device Defender audit.

func (AuditSuppression) GoString added in v1.34.3 

func (s AuditSuppression) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditSuppression) SetCheckName added in v1.34.3 

func (s *AuditSuppression) SetCheckName(v string) *AuditSuppression

SetCheckName sets the CheckName field's value.

func (*AuditSuppression) SetDescription added in v1.34.3 

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

SetDescription sets the Description field's value.

func (*AuditSuppression) SetExpirationDate added in v1.34.3 

func (s *AuditSuppression) SetExpirationDate(v time.Time) *AuditSuppression

SetExpirationDate sets the ExpirationDate field's value.

func (*AuditSuppression) SetResourceIdentifier added in v1.34.3 

func (s *AuditSuppression) SetResourceIdentifier(v *ResourceIdentifier) *AuditSuppression

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*AuditSuppression) SetSuppressIndefinitely added in v1.34.3 

func (s *AuditSuppression) SetSuppressIndefinitely(v bool) *AuditSuppression

SetSuppressIndefinitely sets the SuppressIndefinitely field's value.

func (AuditSuppression) String added in v1.34.3 

func (s AuditSuppression) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuditTaskMetadata added in v1.15.2 

type AuditTaskMetadata struct {

	// The ID of this audit.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

	// The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or
	// "CANCELED".
	TaskStatus *string `locationName:"taskStatus" type:"string" enum:"AuditTaskStatus"`

	// The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
	TaskType *string `locationName:"taskType" type:"string" enum:"AuditTaskType"`
	// contains filtered or unexported fields
}

The audits that were performed.

func (AuditTaskMetadata) GoString added in v1.15.2 

func (s AuditTaskMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuditTaskMetadata) SetTaskId added in v1.15.2 

func (s *AuditTaskMetadata) SetTaskId(v string) *AuditTaskMetadata

SetTaskId sets the TaskId field's value.

func (*AuditTaskMetadata) SetTaskStatus added in v1.15.2 

func (s *AuditTaskMetadata) SetTaskStatus(v string) *AuditTaskMetadata

SetTaskStatus sets the TaskStatus field's value.

func (*AuditTaskMetadata) SetTaskType added in v1.15.2 

func (s *AuditTaskMetadata) SetTaskType(v string) *AuditTaskMetadata

SetTaskType sets the TaskType field's value.

func (AuditTaskMetadata) String added in v1.15.2 

func (s AuditTaskMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a required field
	Resources []*string `locationName:"resources" type:"list" required:"true"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthInfo) Validate added in v1.30.18 

func (s *AuthInfo) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthorizerConfig added in v1.25.42 

type AuthorizerConfig struct {

	// A Boolean that specifies whether the domain configuration's authorization
	// service can be overridden.
	AllowAuthorizerOverride *bool `locationName:"allowAuthorizerOverride" type:"boolean"`

	// The name of the authorization service for a domain configuration.
	DefaultAuthorizerName *string `locationName:"defaultAuthorizerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that specifies the authorization service for a domain.

func (AuthorizerConfig) GoString added in v1.25.42 

func (s AuthorizerConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizerConfig) SetAllowAuthorizerOverride added in v1.25.42 

func (s *AuthorizerConfig) SetAllowAuthorizerOverride(v bool) *AuthorizerConfig

SetAllowAuthorizerOverride sets the AllowAuthorizerOverride field's value.

func (*AuthorizerConfig) SetDefaultAuthorizerName added in v1.25.42 

func (s *AuthorizerConfig) SetDefaultAuthorizerName(v string) *AuthorizerConfig

SetDefaultAuthorizerName sets the DefaultAuthorizerName field's value.

func (AuthorizerConfig) String added in v1.25.42 

func (s AuthorizerConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizerConfig) Validate added in v1.25.42 

func (s *AuthorizerConfig) Validate() error

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

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

	// When true, the result from the authorizer’s Lambda function is cached for
	// the time specified in refreshAfterInSeconds. The cached result is used while
	// the device reuses the same HTTP connection.
	EnableCachingForHttp *bool `locationName:"enableCachingForHttp" type:"boolean"`

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

	// Specifies whether IoT validates the token signature in an authorization request.
	SigningDisabled *bool `locationName:"signingDisabled" type:"boolean"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEnableCachingForHttp added in v1.42.21 

func (s *AuthorizerDescription) SetEnableCachingForHttp(v bool) *AuthorizerDescription

SetEnableCachingForHttp sets the EnableCachingForHttp 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) SetSigningDisabled added in v1.25.42 

func (s *AuthorizerDescription) SetSigningDisabled(v bool) *AuthorizerDescription

SetSigningDisabled sets the SigningDisabled field's value.

func (*AuthorizerDescription) SetStatus added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsJobAbortConfig added in v1.32.2 

type AwsJobAbortConfig struct {

	// The list of criteria that determine when and how to abort the job.
	//
	// AbortCriteriaList is a required field
	AbortCriteriaList []*AwsJobAbortCriteria `locationName:"abortCriteriaList" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The criteria that determine when and how a job abort takes place.

func (AwsJobAbortConfig) GoString added in v1.32.2 

func (s AwsJobAbortConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobAbortConfig) SetAbortCriteriaList added in v1.32.2 

func (s *AwsJobAbortConfig) SetAbortCriteriaList(v []*AwsJobAbortCriteria) *AwsJobAbortConfig

SetAbortCriteriaList sets the AbortCriteriaList field's value.

func (AwsJobAbortConfig) String added in v1.32.2 

func (s AwsJobAbortConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobAbortConfig) Validate added in v1.32.2 

func (s *AwsJobAbortConfig) Validate() error

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

type AwsJobAbortCriteria added in v1.32.2 

type AwsJobAbortCriteria struct {

	// The type of job action to take to initiate the job abort.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"AwsJobAbortCriteriaAbortAction"`

	// The type of job execution failures that can initiate a job abort.
	//
	// FailureType is a required field
	FailureType *string `locationName:"failureType" type:"string" required:"true" enum:"AwsJobAbortCriteriaFailureType"`

	// The minimum number of things which must receive job execution notifications
	// before the job can be aborted.
	//
	// MinNumberOfExecutedThings is a required field
	MinNumberOfExecutedThings *int64 `locationName:"minNumberOfExecutedThings" min:"1" type:"integer" required:"true"`

	// The minimum percentage of job execution failures that must occur to initiate
	// the job abort.
	//
	// Amazon Web Services IoT Core supports up to two digits after the decimal
	// (for example, 10.9 and 10.99, but not 10.999).
	//
	// ThresholdPercentage is a required field
	ThresholdPercentage *float64 `locationName:"thresholdPercentage" type:"double" required:"true"`
	// contains filtered or unexported fields
}

The criteria that determine when and how a job abort takes place.

func (AwsJobAbortCriteria) GoString added in v1.32.2 

func (s AwsJobAbortCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobAbortCriteria) SetAction added in v1.32.2 

func (s *AwsJobAbortCriteria) SetAction(v string) *AwsJobAbortCriteria

SetAction sets the Action field's value.

func (*AwsJobAbortCriteria) SetFailureType added in v1.32.2 

func (s *AwsJobAbortCriteria) SetFailureType(v string) *AwsJobAbortCriteria

SetFailureType sets the FailureType field's value.

func (*AwsJobAbortCriteria) SetMinNumberOfExecutedThings added in v1.32.2 

func (s *AwsJobAbortCriteria) SetMinNumberOfExecutedThings(v int64) *AwsJobAbortCriteria

SetMinNumberOfExecutedThings sets the MinNumberOfExecutedThings field's value.

func (*AwsJobAbortCriteria) SetThresholdPercentage added in v1.32.2 

func (s *AwsJobAbortCriteria) SetThresholdPercentage(v float64) *AwsJobAbortCriteria

SetThresholdPercentage sets the ThresholdPercentage field's value.

func (AwsJobAbortCriteria) String added in v1.32.2 

func (s AwsJobAbortCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobAbortCriteria) Validate added in v1.32.2 

func (s *AwsJobAbortCriteria) Validate() error

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

type AwsJobExecutionsRolloutConfig added in v1.15.22 

type AwsJobExecutionsRolloutConfig struct {

	// The rate of increase for a job rollout. This parameter allows you to define
	// an exponential rate increase for a job rollout.
	ExponentialRate *AwsJobExponentialRolloutRate `locationName:"exponentialRate" type:"structure"`

	// The maximum number of OTA update job executions started per minute.
	MaximumPerMinute *int64 `locationName:"maximumPerMinute" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Configuration for the rollout of OTA updates.

func (AwsJobExecutionsRolloutConfig) GoString added in v1.15.22 

func (s AwsJobExecutionsRolloutConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobExecutionsRolloutConfig) SetExponentialRate added in v1.32.2 

func (s *AwsJobExecutionsRolloutConfig) SetExponentialRate(v *AwsJobExponentialRolloutRate) *AwsJobExecutionsRolloutConfig

SetExponentialRate sets the ExponentialRate field's value.

func (*AwsJobExecutionsRolloutConfig) SetMaximumPerMinute added in v1.15.22 

func (s *AwsJobExecutionsRolloutConfig) SetMaximumPerMinute(v int64) *AwsJobExecutionsRolloutConfig

SetMaximumPerMinute sets the MaximumPerMinute field's value.

func (AwsJobExecutionsRolloutConfig) String added in v1.15.22 

func (s AwsJobExecutionsRolloutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobExecutionsRolloutConfig) Validate added in v1.15.22 

func (s *AwsJobExecutionsRolloutConfig) Validate() error

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

type AwsJobExponentialRolloutRate added in v1.32.2 

type AwsJobExponentialRolloutRate struct {

	// The minimum number of things that will be notified of a pending job, per
	// minute, at the start of the job rollout. This is the initial rate of the
	// rollout.
	//
	// BaseRatePerMinute is a required field
	BaseRatePerMinute *int64 `locationName:"baseRatePerMinute" min:"1" type:"integer" required:"true"`

	// The rate of increase for a job rollout. The number of things notified is
	// multiplied by this factor.
	//
	// IncrementFactor is a required field
	IncrementFactor *float64 `locationName:"incrementFactor" type:"double" required:"true"`

	// The criteria to initiate the increase in rate of rollout for a job.
	//
	// Amazon Web Services IoT Core supports up to one digit after the decimal (for
	// example, 1.5, but not 1.55).
	//
	// RateIncreaseCriteria is a required field
	RateIncreaseCriteria *AwsJobRateIncreaseCriteria `locationName:"rateIncreaseCriteria" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

func (AwsJobExponentialRolloutRate) GoString added in v1.32.2 

func (s AwsJobExponentialRolloutRate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobExponentialRolloutRate) SetBaseRatePerMinute added in v1.32.2 

func (s *AwsJobExponentialRolloutRate) SetBaseRatePerMinute(v int64) *AwsJobExponentialRolloutRate

SetBaseRatePerMinute sets the BaseRatePerMinute field's value.

func (*AwsJobExponentialRolloutRate) SetIncrementFactor added in v1.32.2 

func (s *AwsJobExponentialRolloutRate) SetIncrementFactor(v float64) *AwsJobExponentialRolloutRate

SetIncrementFactor sets the IncrementFactor field's value.

func (*AwsJobExponentialRolloutRate) SetRateIncreaseCriteria added in v1.32.2 

func (s *AwsJobExponentialRolloutRate) SetRateIncreaseCriteria(v *AwsJobRateIncreaseCriteria) *AwsJobExponentialRolloutRate

SetRateIncreaseCriteria sets the RateIncreaseCriteria field's value.

func (AwsJobExponentialRolloutRate) String added in v1.32.2 

func (s AwsJobExponentialRolloutRate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobExponentialRolloutRate) Validate added in v1.32.2 

func (s *AwsJobExponentialRolloutRate) Validate() error

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

type AwsJobPresignedUrlConfig added in v1.26.4 

type AwsJobPresignedUrlConfig struct {

	// How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600,
	// the default value is 1800 seconds. Pre-signed URLs are generated when a request
	// for the job document is received.
	ExpiresInSec *int64 `locationName:"expiresInSec" type:"long"`
	// contains filtered or unexported fields
}

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

func (AwsJobPresignedUrlConfig) GoString added in v1.26.4 

func (s AwsJobPresignedUrlConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobPresignedUrlConfig) SetExpiresInSec added in v1.26.4 

func (s *AwsJobPresignedUrlConfig) SetExpiresInSec(v int64) *AwsJobPresignedUrlConfig

SetExpiresInSec sets the ExpiresInSec field's value.

func (AwsJobPresignedUrlConfig) String added in v1.26.4 

func (s AwsJobPresignedUrlConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsJobRateIncreaseCriteria added in v1.32.2 

type AwsJobRateIncreaseCriteria struct {

	// When this number of things have been notified, it will initiate an increase
	// in the rollout rate.
	NumberOfNotifiedThings *int64 `locationName:"numberOfNotifiedThings" min:"1" type:"integer"`

	// When this number of things have succeeded in their job execution, it will
	// initiate an increase in the rollout rate.
	NumberOfSucceededThings *int64 `locationName:"numberOfSucceededThings" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The criteria to initiate the increase in rate of rollout for a job.

func (AwsJobRateIncreaseCriteria) GoString added in v1.32.2 

func (s AwsJobRateIncreaseCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobRateIncreaseCriteria) SetNumberOfNotifiedThings added in v1.32.2 

func (s *AwsJobRateIncreaseCriteria) SetNumberOfNotifiedThings(v int64) *AwsJobRateIncreaseCriteria

SetNumberOfNotifiedThings sets the NumberOfNotifiedThings field's value.

func (*AwsJobRateIncreaseCriteria) SetNumberOfSucceededThings added in v1.32.2 

func (s *AwsJobRateIncreaseCriteria) SetNumberOfSucceededThings(v int64) *AwsJobRateIncreaseCriteria

SetNumberOfSucceededThings sets the NumberOfSucceededThings field's value.

func (AwsJobRateIncreaseCriteria) String added in v1.32.2 

func (s AwsJobRateIncreaseCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobRateIncreaseCriteria) Validate added in v1.32.2 

func (s *AwsJobRateIncreaseCriteria) Validate() error

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

type AwsJobTimeoutConfig added in v1.32.2 

type AwsJobTimeoutConfig struct {

	// Specifies the amount of time, in minutes, this device has to finish execution
	// of this job. The timeout interval can be anywhere between 1 minute and 7
	// days (1 to 10080 minutes). The in progress timer can't be updated and will
	// apply to all job executions for the job. Whenever a job execution remains
	// in the IN_PROGRESS status for longer than this interval, the job execution
	// will fail and switch to the terminal TIMED_OUT status.
	InProgressTimeoutInMinutes *int64 `locationName:"inProgressTimeoutInMinutes" type:"long"`
	// contains filtered or unexported fields
}

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

func (AwsJobTimeoutConfig) GoString added in v1.32.2 

func (s AwsJobTimeoutConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsJobTimeoutConfig) SetInProgressTimeoutInMinutes added in v1.32.2 

func (s *AwsJobTimeoutConfig) SetInProgressTimeoutInMinutes(v int64) *AwsJobTimeoutConfig

SetInProgressTimeoutInMinutes sets the InProgressTimeoutInMinutes field's value.

func (AwsJobTimeoutConfig) String added in v1.32.2 

func (s AwsJobTimeoutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Behavior added in v1.15.2 

type Behavior struct {

	// The criteria that determine if a device is behaving normally in regard to
	// the metric.
	Criteria *BehaviorCriteria `locationName:"criteria" type:"structure"`

	// What is measured by the behavior.
	Metric *string `locationName:"metric" type:"string"`

	// The dimension for a metric in your behavior. For example, using a TOPIC_FILTER
	// dimension, you can narrow down the scope of the metric to only MQTT topics
	// where the name matches the pattern specified in the dimension. This can't
	// be used with custom metrics.
	MetricDimension *MetricDimension `locationName:"metricDimension" type:"structure"`

	// The name you've given to the behavior.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Suppresses alerts.
	SuppressAlerts *bool `locationName:"suppressAlerts" type:"boolean"`
	// contains filtered or unexported fields
}

A Device Defender security profile behavior.

func (Behavior) GoString added in v1.15.2 

func (s Behavior) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Behavior) SetCriteria added in v1.15.2 

func (s *Behavior) SetCriteria(v *BehaviorCriteria) *Behavior

SetCriteria sets the Criteria field's value.

func (*Behavior) SetMetric added in v1.15.2 

func (s *Behavior) SetMetric(v string) *Behavior

SetMetric sets the Metric field's value.

func (*Behavior) SetMetricDimension added in v1.30.2 

func (s *Behavior) SetMetricDimension(v *MetricDimension) *Behavior

SetMetricDimension sets the MetricDimension field's value.

func (*Behavior) SetName added in v1.15.2 

func (s *Behavior) SetName(v string) *Behavior

SetName sets the Name field's value.

func (*Behavior) SetSuppressAlerts added in v1.36.9 

func (s *Behavior) SetSuppressAlerts(v bool) *Behavior

SetSuppressAlerts sets the SuppressAlerts field's value.

func (Behavior) String added in v1.15.2 

func (s Behavior) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Behavior) Validate added in v1.15.2 

func (s *Behavior) Validate() error

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

type BehaviorCriteria added in v1.15.2 

type BehaviorCriteria struct {

	// The operator that relates the thing measured (metric) to the criteria (containing
	// a value or statisticalThreshold). Valid operators include:
	//
	//    * string-list: in-set and not-in-set
	//
	//    * number-list: in-set and not-in-set
	//
	//    * ip-address-list: in-cidr-set and not-in-cidr-set
	//
	//    * number: less-than, less-than-equals, greater-than, and greater-than-equals
	ComparisonOperator *string `locationName:"comparisonOperator" type:"string" enum:"ComparisonOperator"`

	// If a device is in violation of the behavior for the specified number of consecutive
	// datapoints, an alarm occurs. If not specified, the default is 1.
	ConsecutiveDatapointsToAlarm *int64 `locationName:"consecutiveDatapointsToAlarm" min:"1" type:"integer"`

	// If an alarm has occurred and the offending device is no longer in violation
	// of the behavior for the specified number of consecutive datapoints, the alarm
	// is cleared. If not specified, the default is 1.
	ConsecutiveDatapointsToClear *int64 `locationName:"consecutiveDatapointsToClear" min:"1" type:"integer"`

	// Use this to specify the time duration over which the behavior is evaluated,
	// for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT).
	// For a statisticalThreshhold metric comparison, measurements from all devices
	// are accumulated over this time duration before being used to calculate percentiles,
	// and later, measurements from an individual device are also accumulated over
	// this time duration before being given a percentile rank. Cannot be used with
	// list-based metric datatypes.
	DurationSeconds *int64 `locationName:"durationSeconds" type:"integer"`

	// The configuration of an ML Detect
	MlDetectionConfig *MachineLearningDetectionConfig `locationName:"mlDetectionConfig" type:"structure"`

	// A statistical ranking (percentile)that indicates a threshold value by which
	// a behavior is determined to be in compliance or in violation of the behavior.
	StatisticalThreshold *StatisticalThreshold `locationName:"statisticalThreshold" type:"structure"`

	// The value to be compared with the metric.
	Value *MetricValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

The criteria by which the behavior is determined to be normal.

func (BehaviorCriteria) GoString added in v1.15.2 

func (s BehaviorCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BehaviorCriteria) SetComparisonOperator added in v1.15.2 

func (s *BehaviorCriteria) SetComparisonOperator(v string) *BehaviorCriteria

SetComparisonOperator sets the ComparisonOperator field's value.

func (*BehaviorCriteria) SetConsecutiveDatapointsToAlarm added in v1.17.1 

func (s *BehaviorCriteria) SetConsecutiveDatapointsToAlarm(v int64) *BehaviorCriteria

SetConsecutiveDatapointsToAlarm sets the ConsecutiveDatapointsToAlarm field's value.

func (*BehaviorCriteria) SetConsecutiveDatapointsToClear added in v1.17.1 

func (s *BehaviorCriteria) SetConsecutiveDatapointsToClear(v int64) *BehaviorCriteria

SetConsecutiveDatapointsToClear sets the ConsecutiveDatapointsToClear field's value.

func (*BehaviorCriteria) SetDurationSeconds added in v1.15.2 

func (s *BehaviorCriteria) SetDurationSeconds(v int64) *BehaviorCriteria

SetDurationSeconds sets the DurationSeconds field's value.

func (*BehaviorCriteria) SetMlDetectionConfig added in v1.36.9 

func (s *BehaviorCriteria) SetMlDetectionConfig(v *MachineLearningDetectionConfig) *BehaviorCriteria

SetMlDetectionConfig sets the MlDetectionConfig field's value.

func (*BehaviorCriteria) SetStatisticalThreshold added in v1.17.1 

func (s *BehaviorCriteria) SetStatisticalThreshold(v *StatisticalThreshold) *BehaviorCriteria

SetStatisticalThreshold sets the StatisticalThreshold field's value.

func (*BehaviorCriteria) SetValue added in v1.15.2 

func (s *BehaviorCriteria) SetValue(v *MetricValue) *BehaviorCriteria

SetValue sets the Value field's value.

func (BehaviorCriteria) String added in v1.15.2 

func (s BehaviorCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BehaviorCriteria) Validate added in v1.17.1 

func (s *BehaviorCriteria) Validate() error

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

type BehaviorModelTrainingSummary added in v1.36.9 

type BehaviorModelTrainingSummary struct {

	// The name of the behavior.
	BehaviorName *string `locationName:"behaviorName" min:"1" type:"string"`

	// The percentage of datapoints collected.
	DatapointsCollectionPercentage *float64 `locationName:"datapointsCollectionPercentage" type:"double"`

	// The date the model was last refreshed.
	LastModelRefreshDate *time.Time `locationName:"lastModelRefreshDate" type:"timestamp"`

	// The status of the behavior model.
	ModelStatus *string `locationName:"modelStatus" type:"string" enum:"ModelStatus"`

	// The name of the security profile.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The date a training model started collecting data.
	TrainingDataCollectionStartDate *time.Time `locationName:"trainingDataCollectionStartDate" type:"timestamp"`
	// contains filtered or unexported fields
}

The summary of an ML Detect behavior model.

func (BehaviorModelTrainingSummary) GoString added in v1.36.9 

func (s BehaviorModelTrainingSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BehaviorModelTrainingSummary) SetBehaviorName added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetBehaviorName(v string) *BehaviorModelTrainingSummary

SetBehaviorName sets the BehaviorName field's value.

func (*BehaviorModelTrainingSummary) SetDatapointsCollectionPercentage added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetDatapointsCollectionPercentage(v float64) *BehaviorModelTrainingSummary

SetDatapointsCollectionPercentage sets the DatapointsCollectionPercentage field's value.

func (*BehaviorModelTrainingSummary) SetLastModelRefreshDate added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetLastModelRefreshDate(v time.Time) *BehaviorModelTrainingSummary

SetLastModelRefreshDate sets the LastModelRefreshDate field's value.

func (*BehaviorModelTrainingSummary) SetModelStatus added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetModelStatus(v string) *BehaviorModelTrainingSummary

SetModelStatus sets the ModelStatus field's value.

func (*BehaviorModelTrainingSummary) SetSecurityProfileName added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetSecurityProfileName(v string) *BehaviorModelTrainingSummary

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*BehaviorModelTrainingSummary) SetTrainingDataCollectionStartDate added in v1.36.9 

func (s *BehaviorModelTrainingSummary) SetTrainingDataCollectionStartDate(v time.Time) *BehaviorModelTrainingSummary

SetTrainingDataCollectionStartDate sets the TrainingDataCollectionStartDate field's value.

func (BehaviorModelTrainingSummary) String added in v1.36.9 

func (s BehaviorModelTrainingSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BillingGroupMetadata added in v1.15.79 

type BillingGroupMetadata struct {

	// The date the billing group was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`
	// contains filtered or unexported fields
}

Additional information about the billing group.

func (BillingGroupMetadata) GoString added in v1.15.79 

func (s BillingGroupMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BillingGroupMetadata) SetCreationDate added in v1.15.79 

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

SetCreationDate sets the CreationDate field's value.

func (BillingGroupMetadata) String added in v1.15.79 

func (s BillingGroupMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BillingGroupProperties added in v1.15.79 

type BillingGroupProperties struct {

	// The description of the billing group.
	BillingGroupDescription *string `locationName:"billingGroupDescription" type:"string"`
	// contains filtered or unexported fields
}

The properties of a billing group.

func (BillingGroupProperties) GoString added in v1.15.79 

func (s BillingGroupProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BillingGroupProperties) SetBillingGroupDescription added in v1.15.79 

func (s *BillingGroupProperties) SetBillingGroupDescription(v string) *BillingGroupProperties

SetBillingGroupDescription sets the BillingGroupDescription field's value.

func (BillingGroupProperties) String added in v1.15.79 

func (s BillingGroupProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Bucket added in v1.40.34 

type Bucket struct {

	// The number of documents that have the value counted for the particular bucket.
	Count *int64 `locationName:"count" type:"integer"`

	// The value counted for the particular bucket.
	KeyValue *string `locationName:"keyValue" type:"string"`
	// contains filtered or unexported fields
}

A count of documents that meets a specific aggregation criteria.

func (Bucket) GoString added in v1.40.34 

func (s Bucket) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Bucket) SetCount added in v1.40.34 

func (s *Bucket) SetCount(v int64) *Bucket

SetCount sets the Count field's value.

func (*Bucket) SetKeyValue added in v1.40.34 

func (s *Bucket) SetKeyValue(v string) *Bucket

SetKeyValue sets the KeyValue field's value.

func (Bucket) String added in v1.40.34 

func (s Bucket) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BucketsAggregationType added in v1.40.34 

type BucketsAggregationType struct {

	// Performs an aggregation that will return a list of buckets. The list of buckets
	// is a ranked list of the number of occurrences of an aggregation field value.
	TermsAggregation *TermsAggregation `locationName:"termsAggregation" type:"structure"`
	// contains filtered or unexported fields
}

The type of bucketed aggregation performed.

func (BucketsAggregationType) GoString added in v1.40.34 

func (s BucketsAggregationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketsAggregationType) SetTermsAggregation added in v1.40.34 

func (s *BucketsAggregationType) SetTermsAggregation(v *TermsAggregation) *BucketsAggregationType

SetTermsAggregation sets the TermsAggregation field's value.

func (BucketsAggregationType) String added in v1.40.34 

func (s BucketsAggregationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketsAggregationType) Validate added in v1.40.34 

func (s *BucketsAggregationType) Validate() error

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

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

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 mode of the CA.
	//
	// All the device certificates that are registered using this CA will be registered
	// in the same mode as the CA. For more information about certificate mode for
	// device certificates, see certificate mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode).
	CertificateMode *string `locationName:"certificateMode" type:"string" enum:"CertificateMode"`

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

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

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

	// The status of a CA certificate.
	Status *string `locationName:"status" type:"string" enum:"CACertificateStatus"`

	// When the CA certificate is valid.
	Validity *CertificateValidity `locationName:"validity" type:"structure"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetCertificateId sets the CertificateId field's value.

func (*CACertificateDescription) SetCertificateMode added in v1.44.50 

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

SetCertificateMode sets the CertificateMode 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 

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

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 

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

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 

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

SetOwnedBy sets the OwnedBy field's value.

func (*CACertificateDescription) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (*CACertificateDescription) SetValidity added in v1.15.2 

func (s *CACertificateDescription) SetValidity(v *CertificateValidity) *CACertificateDescription

SetValidity sets the Validity field's value.

func (CACertificateDescription) String added in v1.1.18 

func (s CACertificateDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelAuditMitigationActionsTaskInput added in v1.21.10 

type CancelAuditMitigationActionsTaskInput struct {

	// The unique identifier for the task that you want to cancel.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelAuditMitigationActionsTaskInput) GoString added in v1.21.10 

func (s CancelAuditMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelAuditMitigationActionsTaskInput) SetTaskId added in v1.21.10 

func (s *CancelAuditMitigationActionsTaskInput) SetTaskId(v string) *CancelAuditMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (CancelAuditMitigationActionsTaskInput) String added in v1.21.10 

func (s CancelAuditMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelAuditMitigationActionsTaskInput) Validate added in v1.21.10 

func (s *CancelAuditMitigationActionsTaskInput) Validate() error

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

type CancelAuditMitigationActionsTaskOutput added in v1.21.10 

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

func (CancelAuditMitigationActionsTaskOutput) GoString added in v1.21.10 

func (s CancelAuditMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelAuditMitigationActionsTaskOutput) String added in v1.21.10 

func (s CancelAuditMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelAuditTaskInput added in v1.15.2 

type CancelAuditTaskInput struct {

	// The ID of the audit you want to cancel. You can only cancel an audit that
	// is "IN_PROGRESS".
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelAuditTaskInput) GoString added in v1.15.2 

func (s CancelAuditTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelAuditTaskInput) SetTaskId added in v1.15.2 

func (s *CancelAuditTaskInput) SetTaskId(v string) *CancelAuditTaskInput

SetTaskId sets the TaskId field's value.

func (CancelAuditTaskInput) String added in v1.15.2 

func (s CancelAuditTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelAuditTaskInput) Validate added in v1.15.2 

func (s *CancelAuditTaskInput) Validate() error

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

type CancelAuditTaskOutput added in v1.15.2 

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

func (CancelAuditTaskOutput) GoString added in v1.15.2 

func (s CancelAuditTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelAuditTaskOutput) String added in v1.15.2 

func (s CancelAuditTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s CancelCertificateTransferInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelCertificateTransferInput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (CancelCertificateTransferInput) String 

func (s CancelCertificateTransferInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s CancelCertificateTransferOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelCertificateTransferOutput) String 

func (s CancelCertificateTransferOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelDetectMitigationActionsTaskInput added in v1.36.9 

type CancelDetectMitigationActionsTaskInput struct {

	// The unique identifier of the task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelDetectMitigationActionsTaskInput) GoString added in v1.36.9 

func (s CancelDetectMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDetectMitigationActionsTaskInput) SetTaskId added in v1.36.9 

func (s *CancelDetectMitigationActionsTaskInput) SetTaskId(v string) *CancelDetectMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (CancelDetectMitigationActionsTaskInput) String added in v1.36.9 

func (s CancelDetectMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDetectMitigationActionsTaskInput) Validate added in v1.36.9 

func (s *CancelDetectMitigationActionsTaskInput) Validate() error

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

type CancelDetectMitigationActionsTaskOutput added in v1.36.9 

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

func (CancelDetectMitigationActionsTaskOutput) GoString added in v1.36.9 

func (s CancelDetectMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelDetectMitigationActionsTaskOutput) String added in v1.36.9 

func (s CancelDetectMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetForce sets the Force field's value.

func (*CancelJobExecutionInput) SetJobId added in v1.13.60 

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

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelJobExecutionOutput) String added in v1.13.60 

func (s CancelJobExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// (Optional)A reason code string that explains why the job was canceled.
	ReasonCode *string `locationName:"reasonCode" type:"string"`
	// contains filtered or unexported fields
}

func (CancelJobInput) GoString added in v1.12.36 

func (s CancelJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetReasonCode added in v1.15.79 

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

SetReasonCode sets the ReasonCode field's value.

func (CancelJobInput) String added in v1.12.36 

func (s CancelJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 mode of the certificate.
	//
	// DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web
	// Services IoT Core or registered with an issuer certificate authority (CA)
	// in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required
	// to send the Server Name Indication (SNI) extension when connecting to Amazon
	// Web Services IoT Core. However, to use features such as custom domains and
	// VPC endpoints, we recommend that you use the SNI extension when connecting
	// to Amazon Web Services IoT Core.
	//
	// SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer
	// CA. Devices with certificates in SNI_ONLY mode must send the SNI extension
	// when connecting to Amazon Web Services IoT Core.
	CertificateMode *string `locationName:"certificateMode" type:"string" enum:"CertificateMode"`

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

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCertificateMode added in v1.30.18 

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

SetCertificateMode sets the CertificateMode 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateConflictException added in v1.28.0 

type CertificateConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*CertificateConflictException) Code added in v1.28.0 

func (s *CertificateConflictException) Code() string

Code returns the exception type name.

func (*CertificateConflictException) Error added in v1.28.0 

func (s *CertificateConflictException) Error() string

func (CertificateConflictException) GoString added in v1.28.0 

func (s CertificateConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateConflictException) Message added in v1.28.0 

func (s *CertificateConflictException) Message() string

Message returns the exception's message.

func (*CertificateConflictException) OrigErr added in v1.28.0 

func (s *CertificateConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CertificateConflictException) RequestID added in v1.28.0 

func (s *CertificateConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CertificateConflictException) StatusCode added in v1.28.0 

func (s *CertificateConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CertificateConflictException) String added in v1.28.0 

func (s CertificateConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 mode of the certificate.
	//
	// DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web
	// Services IoT Core or registered with an issuer certificate authority (CA)
	// in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required
	// to send the Server Name Indication (SNI) extension when connecting to Amazon
	// Web Services IoT Core. However, to use features such as custom domains and
	// VPC endpoints, we recommend that you use the SNI extension when connecting
	// to Amazon Web Services IoT Core.
	//
	// SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer
	// CA. Devices with certificates in SNI_ONLY mode must send the SNI extension
	// when connecting to Amazon Web Services IoT Core.
	//
	// For more information about the value for SNI extension, see Transport security
	// in IoT (https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html).
	CertificateMode *string `locationName:"certificateMode" type:"string" enum:"CertificateMode"`

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

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

	// The ID of the Amazon Web Services account that owns the certificate.
	OwnedBy *string `locationName:"ownedBy" min:"12" type:"string"`

	// The ID of the Amazon Web Services account of the previous owner of the certificate.
	PreviousOwnedBy *string `locationName:"previousOwnedBy" min:"12" type:"string"`

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

	// The transfer data.
	TransferData *TransferData `locationName:"transferData" type:"structure"`

	// When the certificate is valid.
	Validity *CertificateValidity `locationName:"validity" type:"structure"`
	// contains filtered or unexported fields
}

Describes a certificate.

func (CertificateDescription) GoString 

func (s CertificateDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCertificateMode added in v1.30.18 

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

SetCertificateMode sets the CertificateMode 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 

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

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 

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

SetStatus sets the Status field's value.

func (*CertificateDescription) SetTransferData added in v1.5.0 

func (s *CertificateDescription) SetTransferData(v *TransferData) *CertificateDescription

SetTransferData sets the TransferData field's value.

func (*CertificateDescription) SetValidity added in v1.15.2 

func (s *CertificateDescription) SetValidity(v *CertificateValidity) *CertificateDescription

SetValidity sets the Validity field's value.

func (CertificateDescription) String 

func (s CertificateDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateStateException added in v1.28.0 

type CertificateStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The certificate operation is not allowed.

func (*CertificateStateException) Code added in v1.28.0 

func (s *CertificateStateException) Code() string

Code returns the exception type name.

func (*CertificateStateException) Error added in v1.28.0 

func (s *CertificateStateException) Error() string

func (CertificateStateException) GoString added in v1.28.0 

func (s CertificateStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateStateException) Message added in v1.28.0 

func (s *CertificateStateException) Message() string

Message returns the exception's message.

func (*CertificateStateException) OrigErr added in v1.28.0 

func (s *CertificateStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CertificateStateException) RequestID added in v1.28.0 

func (s *CertificateStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CertificateStateException) StatusCode added in v1.28.0 

func (s *CertificateStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CertificateStateException) String added in v1.28.0 

func (s CertificateStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateValidationException added in v1.28.0 

type CertificateValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Additional information about the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The certificate is invalid.

func (*CertificateValidationException) Code added in v1.28.0 

func (s *CertificateValidationException) Code() string

Code returns the exception type name.

func (*CertificateValidationException) Error added in v1.28.0 

func (s *CertificateValidationException) Error() string

func (CertificateValidationException) GoString added in v1.28.0 

func (s CertificateValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateValidationException) Message added in v1.28.0 

func (s *CertificateValidationException) Message() string

Message returns the exception's message.

func (*CertificateValidationException) OrigErr added in v1.28.0 

func (s *CertificateValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CertificateValidationException) RequestID added in v1.28.0 

func (s *CertificateValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CertificateValidationException) StatusCode added in v1.28.0 

func (s *CertificateValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CertificateValidationException) String added in v1.28.0 

func (s CertificateValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateValidity added in v1.15.2 

type CertificateValidity struct {

	// The certificate is not valid after this date.
	NotAfter *time.Time `locationName:"notAfter" type:"timestamp"`

	// The certificate is not valid before this date.
	NotBefore *time.Time `locationName:"notBefore" type:"timestamp"`
	// contains filtered or unexported fields
}

When the certificate is valid.

func (CertificateValidity) GoString added in v1.15.2 

func (s CertificateValidity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateValidity) SetNotAfter added in v1.15.2 

func (s *CertificateValidity) SetNotAfter(v time.Time) *CertificateValidity

SetNotAfter sets the NotAfter field's value.

func (*CertificateValidity) SetNotBefore added in v1.15.2 

func (s *CertificateValidity) SetNotBefore(v time.Time) *CertificateValidity

SetNotBefore sets the NotBefore field's value.

func (CertificateValidity) String added in v1.15.2 

func (s CertificateValidity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ClearDefaultAuthorizerInput) String added in v1.12.36 

func (s ClearDefaultAuthorizerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ClearDefaultAuthorizerOutput) String added in v1.12.36 

func (s ClearDefaultAuthorizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudwatchAlarmAction) SetAlarmName added in v1.5.0 

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

SetAlarmName sets the AlarmName field's value.

func (*CloudwatchAlarmAction) SetRoleArn added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

type CloudwatchLogsAction struct {

	// The CloudWatch log group to which the action sends data.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`

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

Describes an action that sends data to CloudWatch Logs.

func (CloudwatchLogsAction) GoString added in v1.29.23 

func (s CloudwatchLogsAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudwatchLogsAction) SetLogGroupName added in v1.29.23 

func (s *CloudwatchLogsAction) SetLogGroupName(v string) *CloudwatchLogsAction

SetLogGroupName sets the LogGroupName field's value.

func (*CloudwatchLogsAction) SetRoleArn added in v1.29.23 

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

SetRoleArn sets the RoleArn field's value.

func (CloudwatchLogsAction) String added in v1.29.23 

func (s CloudwatchLogsAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudwatchLogsAction) Validate added in v1.29.23 

func (s *CloudwatchLogsAction) 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
	MetricTimestamp *string `locationName:"metricTimestamp" type:"string"`

	// The metric unit (https://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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudwatchMetricAction) SetMetricName added in v1.5.0 

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

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 

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

SetMetricUnit sets the MetricUnit field's value.

func (*CloudwatchMetricAction) SetMetricValue added in v1.5.0 

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

SetMetricValue sets the MetricValue field's value.

func (*CloudwatchMetricAction) SetRoleArn added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Describes the code-signing job.
	StartSigningJobParameter *StartSigningJobParameter `locationName:"startSigningJobParameter" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetStartSigningJobParameter added in v1.15.22 

func (s *CodeSigning) SetStartSigningJobParameter(v *StartSigningJobParameter) *CodeSigning

SetStartSigningJobParameter sets the StartSigningJobParameter field's value.

func (CodeSigning) String added in v1.12.51 

func (s CodeSigning) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeSigningCertificateChain) SetCertificateName added in v1.12.51 

func (s *CodeSigningCertificateChain) SetCertificateName(v string) *CodeSigningCertificateChain

SetCertificateName sets the CertificateName field's value.

func (*CodeSigningCertificateChain) SetInlineDocument added in v1.12.51 

func (s *CodeSigningCertificateChain) SetInlineDocument(v string) *CodeSigningCertificateChain

SetInlineDocument sets the InlineDocument field's value.

func (CodeSigningCertificateChain) String added in v1.12.51 

func (s CodeSigningCertificateChain) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeSigningSignature) SetInlineDocument added in v1.12.51 

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

SetInlineDocument sets the InlineDocument field's value.

func (CodeSigningSignature) String added in v1.12.51 

func (s CodeSigningSignature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfirmTopicRuleDestinationInput added in v1.25.38 

type ConfirmTopicRuleDestinationInput struct {

	// The token used to confirm ownership or access to the topic rule confirmation
	// URL.
	//
	// ConfirmationToken is a required field
	ConfirmationToken *string `location:"uri" locationName:"confirmationToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ConfirmTopicRuleDestinationInput) GoString added in v1.25.38 

func (s ConfirmTopicRuleDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfirmTopicRuleDestinationInput) SetConfirmationToken added in v1.25.38 

func (s *ConfirmTopicRuleDestinationInput) SetConfirmationToken(v string) *ConfirmTopicRuleDestinationInput

SetConfirmationToken sets the ConfirmationToken field's value.

func (ConfirmTopicRuleDestinationInput) String added in v1.25.38 

func (s ConfirmTopicRuleDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfirmTopicRuleDestinationInput) Validate added in v1.25.38 

func (s *ConfirmTopicRuleDestinationInput) Validate() error

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

type ConfirmTopicRuleDestinationOutput added in v1.25.38 

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

func (ConfirmTopicRuleDestinationOutput) GoString added in v1.25.38 

func (s ConfirmTopicRuleDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ConfirmTopicRuleDestinationOutput) String added in v1.25.38 

func (s ConfirmTopicRuleDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.38.47 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A resource with the same name already exists.

func (*ConflictException) Code added in v1.38.47 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.38.47 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.38.47 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.38.47 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.38.47 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.38.47 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.38.47 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.38.47 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictingResourceUpdateException added in v1.28.0 

type ConflictingResourceUpdateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*ConflictingResourceUpdateException) Code added in v1.28.0 

func (s *ConflictingResourceUpdateException) Code() string

Code returns the exception type name.

func (*ConflictingResourceUpdateException) Error added in v1.28.0 

func (s *ConflictingResourceUpdateException) Error() string

func (ConflictingResourceUpdateException) GoString added in v1.28.0 

func (s ConflictingResourceUpdateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictingResourceUpdateException) Message added in v1.28.0 

func (s *ConflictingResourceUpdateException) Message() string

Message returns the exception's message.

func (*ConflictingResourceUpdateException) OrigErr added in v1.28.0 

func (s *ConflictingResourceUpdateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictingResourceUpdateException) RequestID added in v1.28.0 

func (s *ConflictingResourceUpdateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictingResourceUpdateException) StatusCode added in v1.28.0 

func (s *ConflictingResourceUpdateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictingResourceUpdateException) String added in v1.28.0 

func (s ConflictingResourceUpdateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAuditSuppressionInput added in v1.34.3 

type CreateAuditSuppressionInput struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// CheckName is a required field
	CheckName *string `locationName:"checkName" type:"string" required:"true"`

	// Each audit supression must have a unique client request token. If you try
	// to create a new audit suppression with the same token as one that already
	// exists, an exception occurs. If you omit this value, Amazon Web Services
	// SDKs will automatically generate a unique client request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"`

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

	// The epoch timestamp in seconds at which this suppression expires.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"`

	// Information that identifies the noncompliant resource.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure" required:"true"`

	// Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool `locationName:"suppressIndefinitely" type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateAuditSuppressionInput) GoString added in v1.34.3 

func (s CreateAuditSuppressionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAuditSuppressionInput) SetCheckName added in v1.34.3 

func (s *CreateAuditSuppressionInput) SetCheckName(v string) *CreateAuditSuppressionInput

SetCheckName sets the CheckName field's value.

func (*CreateAuditSuppressionInput) SetClientRequestToken added in v1.34.3 

func (s *CreateAuditSuppressionInput) SetClientRequestToken(v string) *CreateAuditSuppressionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateAuditSuppressionInput) SetDescription added in v1.34.3 

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

SetDescription sets the Description field's value.

func (*CreateAuditSuppressionInput) SetExpirationDate added in v1.34.3 

func (s *CreateAuditSuppressionInput) SetExpirationDate(v time.Time) *CreateAuditSuppressionInput

SetExpirationDate sets the ExpirationDate field's value.

func (*CreateAuditSuppressionInput) SetResourceIdentifier added in v1.34.3 

func (s *CreateAuditSuppressionInput) SetResourceIdentifier(v *ResourceIdentifier) *CreateAuditSuppressionInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*CreateAuditSuppressionInput) SetSuppressIndefinitely added in v1.34.3 

func (s *CreateAuditSuppressionInput) SetSuppressIndefinitely(v bool) *CreateAuditSuppressionInput

SetSuppressIndefinitely sets the SuppressIndefinitely field's value.

func (CreateAuditSuppressionInput) String added in v1.34.3 

func (s CreateAuditSuppressionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAuditSuppressionInput) Validate added in v1.34.3 

func (s *CreateAuditSuppressionInput) Validate() error

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

type CreateAuditSuppressionOutput added in v1.34.3 

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

func (CreateAuditSuppressionOutput) GoString added in v1.34.3 

func (s CreateAuditSuppressionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateAuditSuppressionOutput) String added in v1.34.3 

func (s CreateAuditSuppressionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// When true, the result from the authorizer’s Lambda function is cached for
	// clients that use persistent HTTP connections. The results are cached for
	// the time specified by the Lambda function in refreshAfterInSeconds. This
	// value does not affect authorization of clients that use MQTT connections.
	//
	// The default value is false.
	EnableCachingForHttp *bool `locationName:"enableCachingForHttp" type:"boolean"`

	// Specifies whether IoT validates the token signature in an authorization request.
	SigningDisabled *bool `locationName:"signingDisabled" type:"boolean"`

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

	// Metadata which can be used to manage the custom authorizer.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`

	// The name of the token 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 digital signature returned by your custom
	// authentication service.
	TokenSigningPublicKeys map[string]*string `locationName:"tokenSigningPublicKeys" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAuthorizerInput) GoString added in v1.12.36 

func (s CreateAuthorizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEnableCachingForHttp added in v1.42.21 

func (s *CreateAuthorizerInput) SetEnableCachingForHttp(v bool) *CreateAuthorizerInput

SetEnableCachingForHttp sets the EnableCachingForHttp field's value.

func (*CreateAuthorizerInput) SetSigningDisabled added in v1.25.42 

func (s *CreateAuthorizerInput) SetSigningDisabled(v bool) *CreateAuthorizerInput

SetSigningDisabled sets the SigningDisabled field's value.

func (*CreateAuthorizerInput) SetStatus added in v1.12.36 

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

SetStatus sets the Status field's value.

func (*CreateAuthorizerInput) SetTags added in v1.30.18 

func (s *CreateAuthorizerInput) SetTags(v []*Tag) *CreateAuthorizerInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBillingGroupInput added in v1.15.79 

type CreateBillingGroupInput struct {

	// The name you wish to give to the billing group.
	//
	// BillingGroupName is a required field
	BillingGroupName *string `location:"uri" locationName:"billingGroupName" min:"1" type:"string" required:"true"`

	// The properties of the billing group.
	BillingGroupProperties *BillingGroupProperties `locationName:"billingGroupProperties" type:"structure"`

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

func (CreateBillingGroupInput) GoString added in v1.15.79 

func (s CreateBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *CreateBillingGroupInput) SetBillingGroupName(v string) *CreateBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*CreateBillingGroupInput) SetBillingGroupProperties added in v1.15.79 

func (s *CreateBillingGroupInput) SetBillingGroupProperties(v *BillingGroupProperties) *CreateBillingGroupInput

SetBillingGroupProperties sets the BillingGroupProperties field's value.

func (*CreateBillingGroupInput) SetTags added in v1.15.79 

func (s *CreateBillingGroupInput) SetTags(v []*Tag) *CreateBillingGroupInput

SetTags sets the Tags field's value.

func (CreateBillingGroupInput) String added in v1.15.79 

func (s CreateBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBillingGroupInput) Validate added in v1.15.79 

func (s *CreateBillingGroupInput) Validate() error

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

type CreateBillingGroupOutput added in v1.15.79 

type CreateBillingGroupOutput struct {

	// The ARN of the billing group.
	BillingGroupArn *string `locationName:"billingGroupArn" type:"string"`

	// The ID of the billing group.
	BillingGroupId *string `locationName:"billingGroupId" min:"1" type:"string"`

	// The name you gave to the billing group.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBillingGroupOutput) GoString added in v1.15.79 

func (s CreateBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBillingGroupOutput) SetBillingGroupArn added in v1.15.79 

func (s *CreateBillingGroupOutput) SetBillingGroupArn(v string) *CreateBillingGroupOutput

SetBillingGroupArn sets the BillingGroupArn field's value.

func (*CreateBillingGroupOutput) SetBillingGroupId added in v1.15.79 

func (s *CreateBillingGroupOutput) SetBillingGroupId(v string) *CreateBillingGroupOutput

SetBillingGroupId sets the BillingGroupId field's value.

func (*CreateBillingGroupOutput) SetBillingGroupName added in v1.15.79 

func (s *CreateBillingGroupOutput) SetBillingGroupName(v string) *CreateBillingGroupOutput

SetBillingGroupName sets the BillingGroupName field's value.

func (CreateBillingGroupOutput) String added in v1.15.79 

func (s CreateBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s CreateCertificateFromCsrInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *CreateCertificateFromCsrInput) SetSetAsActive(v bool) *CreateCertificateFromCsrInput

SetSetAsActive sets the SetAsActive field's value.

func (CreateCertificateFromCsrInput) String 

func (s CreateCertificateFromCsrInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s CreateCertificateFromCsrOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCertificateFromCsrOutput) SetCertificateArn added in v1.5.0 

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

SetCertificateArn sets the CertificateArn field's value.

func (*CreateCertificateFromCsrOutput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (*CreateCertificateFromCsrOutput) SetCertificatePem added in v1.5.0 

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

SetCertificatePem sets the CertificatePem field's value.

func (CreateCertificateFromCsrOutput) String 

func (s CreateCertificateFromCsrOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCustomMetricInput added in v1.36.9 

type CreateCustomMetricInput struct {

	// Each custom metric must have a unique client request token. If you try to
	// create a new custom metric that already exists with a different token, an
	// exception occurs. If you omit this value, Amazon Web Services SDKs will automatically
	// generate a unique client request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"`

	// The friendly name in the console for the custom metric. This name doesn't
	// have to be unique. Don't use this name as the metric identifier in the device
	// metric report. You can update the friendly name after you define it.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The name of the custom metric. This will be used in the metric report submitted
	// from the device/thing. The name can't begin with aws:. You can't change the
	// name after you define it.
	//
	// MetricName is a required field
	MetricName *string `location:"uri" locationName:"metricName" min:"1" type:"string" required:"true"`

	// The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but when you
	// submit the metrics value in the DeviceMetrics report, you must pass it as
	// an array with a single value.
	//
	// MetricType is a required field
	MetricType *string `locationName:"metricType" type:"string" required:"true" enum:"CustomMetricType"`

	// Metadata that can be used to manage the custom metric.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCustomMetricInput) GoString added in v1.36.9 

func (s CreateCustomMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomMetricInput) SetClientRequestToken added in v1.36.9 

func (s *CreateCustomMetricInput) SetClientRequestToken(v string) *CreateCustomMetricInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateCustomMetricInput) SetDisplayName added in v1.36.9 

func (s *CreateCustomMetricInput) SetDisplayName(v string) *CreateCustomMetricInput

SetDisplayName sets the DisplayName field's value.

func (*CreateCustomMetricInput) SetMetricName added in v1.36.9 

func (s *CreateCustomMetricInput) SetMetricName(v string) *CreateCustomMetricInput

SetMetricName sets the MetricName field's value.

func (*CreateCustomMetricInput) SetMetricType added in v1.36.9 

func (s *CreateCustomMetricInput) SetMetricType(v string) *CreateCustomMetricInput

SetMetricType sets the MetricType field's value.

func (*CreateCustomMetricInput) SetTags added in v1.36.9 

func (s *CreateCustomMetricInput) SetTags(v []*Tag) *CreateCustomMetricInput

SetTags sets the Tags field's value.

func (CreateCustomMetricInput) String added in v1.36.9 

func (s CreateCustomMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomMetricInput) Validate added in v1.36.9 

func (s *CreateCustomMetricInput) Validate() error

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

type CreateCustomMetricOutput added in v1.36.9 

type CreateCustomMetricOutput struct {

	// The Amazon Resource Number (ARN) of the custom metric. For example, arn:aws-partition:iot:region:accountId:custommetric/metricName
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The name of the custom metric to be used in the metric report.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCustomMetricOutput) GoString added in v1.36.9 

func (s CreateCustomMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomMetricOutput) SetMetricArn added in v1.36.9 

func (s *CreateCustomMetricOutput) SetMetricArn(v string) *CreateCustomMetricOutput

SetMetricArn sets the MetricArn field's value.

func (*CreateCustomMetricOutput) SetMetricName added in v1.36.9 

func (s *CreateCustomMetricOutput) SetMetricName(v string) *CreateCustomMetricOutput

SetMetricName sets the MetricName field's value.

func (CreateCustomMetricOutput) String added in v1.36.9 

func (s CreateCustomMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDimensionInput added in v1.30.2 

type CreateDimensionInput struct {

	// Each dimension must have a unique client request token. If you try to create
	// a new dimension with the same token as a dimension that already exists, an
	// exception occurs. If you omit this value, Amazon Web Services SDKs will automatically
	// generate a unique client request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"`

	// A unique identifier for the dimension. Choose something that describes the
	// type and value to make it easy to remember what it does.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

	// Specifies the value or list of values for the dimension. For TOPIC_FILTER
	// dimensions, this is a pattern used to match the MQTT topic (for example,
	// "admin/#").
	//
	// StringValues is a required field
	StringValues []*string `locationName:"stringValues" min:"1" type:"list" required:"true"`

	// Metadata that can be used to manage the dimension.
	Tags []*Tag `locationName:"tags" type:"list"`

	// Specifies the type of dimension. Supported types: TOPIC_FILTER.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DimensionType"`
	// contains filtered or unexported fields
}

func (CreateDimensionInput) GoString added in v1.30.2 

func (s CreateDimensionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDimensionInput) SetClientRequestToken added in v1.30.2 

func (s *CreateDimensionInput) SetClientRequestToken(v string) *CreateDimensionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDimensionInput) SetName added in v1.30.2 

func (s *CreateDimensionInput) SetName(v string) *CreateDimensionInput

SetName sets the Name field's value.

func (*CreateDimensionInput) SetStringValues added in v1.30.2 

func (s *CreateDimensionInput) SetStringValues(v []*string) *CreateDimensionInput

SetStringValues sets the StringValues field's value.

func (*CreateDimensionInput) SetTags added in v1.30.2 

func (s *CreateDimensionInput) SetTags(v []*Tag) *CreateDimensionInput

SetTags sets the Tags field's value.

func (*CreateDimensionInput) SetType added in v1.30.2 

func (s *CreateDimensionInput) SetType(v string) *CreateDimensionInput

SetType sets the Type field's value.

func (CreateDimensionInput) String added in v1.30.2 

func (s CreateDimensionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDimensionInput) Validate added in v1.30.2 

func (s *CreateDimensionInput) Validate() error

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

type CreateDimensionOutput added in v1.30.2 

type CreateDimensionOutput struct {

	// The Amazon Resource Name (ARN) of the created dimension.
	Arn *string `locationName:"arn" type:"string"`

	// A unique identifier for the dimension.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDimensionOutput) GoString added in v1.30.2 

func (s CreateDimensionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDimensionOutput) SetArn added in v1.30.2 

func (s *CreateDimensionOutput) SetArn(v string) *CreateDimensionOutput

SetArn sets the Arn field's value.

func (*CreateDimensionOutput) SetName added in v1.30.2 

func (s *CreateDimensionOutput) SetName(v string) *CreateDimensionOutput

SetName sets the Name field's value.

func (CreateDimensionOutput) String added in v1.30.2 

func (s CreateDimensionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainConfigurationInput added in v1.25.42 

type CreateDomainConfigurationInput struct {

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *AuthorizerConfig `locationName:"authorizerConfig" type:"structure"`

	// The name of the domain configuration. This value must be unique to a region.
	//
	// DomainConfigurationName is a required field
	DomainConfigurationName *string `location:"uri" locationName:"domainConfigurationName" min:"1" type:"string" required:"true"`

	// The name of the domain.
	DomainName *string `locationName:"domainName" min:"1" type:"string"`

	// The ARNs of the certificates that IoT passes to the device during the TLS
	// handshake. Currently you can specify only one certificate ARN. This value
	// is not required for Amazon Web Services-managed domains.
	ServerCertificateArns []*string `locationName:"serverCertificateArns" type:"list"`

	// The type of service delivered by the endpoint.
	//
	// Amazon Web Services IoT Core currently supports only the DATA service type.
	ServiceType *string `locationName:"serviceType" type:"string" enum:"ServiceType"`

	// Metadata which can be used to manage the domain configuration.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`

	// The certificate used to validate the server certificate and prove domain
	// name ownership. This certificate must be signed by a public certificate authority.
	// This value is not required for Amazon Web Services-managed domains.
	ValidationCertificateArn *string `locationName:"validationCertificateArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDomainConfigurationInput) GoString added in v1.25.42 

func (s CreateDomainConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainConfigurationInput) SetAuthorizerConfig added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetAuthorizerConfig(v *AuthorizerConfig) *CreateDomainConfigurationInput

SetAuthorizerConfig sets the AuthorizerConfig field's value.

func (*CreateDomainConfigurationInput) SetDomainConfigurationName added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetDomainConfigurationName(v string) *CreateDomainConfigurationInput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (*CreateDomainConfigurationInput) SetDomainName added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetDomainName(v string) *CreateDomainConfigurationInput

SetDomainName sets the DomainName field's value.

func (*CreateDomainConfigurationInput) SetServerCertificateArns added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetServerCertificateArns(v []*string) *CreateDomainConfigurationInput

SetServerCertificateArns sets the ServerCertificateArns field's value.

func (*CreateDomainConfigurationInput) SetServiceType added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetServiceType(v string) *CreateDomainConfigurationInput

SetServiceType sets the ServiceType field's value.

func (*CreateDomainConfigurationInput) SetTags added in v1.30.18 

func (s *CreateDomainConfigurationInput) SetTags(v []*Tag) *CreateDomainConfigurationInput

SetTags sets the Tags field's value.

func (*CreateDomainConfigurationInput) SetValidationCertificateArn added in v1.25.42 

func (s *CreateDomainConfigurationInput) SetValidationCertificateArn(v string) *CreateDomainConfigurationInput

SetValidationCertificateArn sets the ValidationCertificateArn field's value.

func (CreateDomainConfigurationInput) String added in v1.25.42 

func (s CreateDomainConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainConfigurationInput) Validate added in v1.25.42 

func (s *CreateDomainConfigurationInput) Validate() error

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

type CreateDomainConfigurationOutput added in v1.25.42 

type CreateDomainConfigurationOutput struct {

	// The ARN of the domain configuration.
	DomainConfigurationArn *string `locationName:"domainConfigurationArn" type:"string"`

	// The name of the domain configuration.
	DomainConfigurationName *string `locationName:"domainConfigurationName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDomainConfigurationOutput) GoString added in v1.25.42 

func (s CreateDomainConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainConfigurationOutput) SetDomainConfigurationArn added in v1.25.42 

func (s *CreateDomainConfigurationOutput) SetDomainConfigurationArn(v string) *CreateDomainConfigurationOutput

SetDomainConfigurationArn sets the DomainConfigurationArn field's value.

func (*CreateDomainConfigurationOutput) SetDomainConfigurationName added in v1.25.42 

func (s *CreateDomainConfigurationOutput) SetDomainConfigurationName(v string) *CreateDomainConfigurationOutput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (CreateDomainConfigurationOutput) String added in v1.25.42 

func (s CreateDomainConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDynamicThingGroupInput added in v1.15.79 

type CreateDynamicThingGroupInput struct {

	// The dynamic thing group index name.
	//
	// Currently one index is supported: AWS_Things.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

	// The dynamic thing group search query string.
	//
	// See Query Syntax (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html)
	// for information about query string syntax.
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" min:"1" type:"string" required:"true"`

	// The dynamic thing group query version.
	//
	// Currently one query version is supported: "2017-09-30". If not specified,
	// the query version defaults to this value.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

	// Metadata which can be used to manage the dynamic thing group.
	Tags []*Tag `locationName:"tags" type:"list"`

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

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

func (CreateDynamicThingGroupInput) GoString added in v1.15.79 

func (s CreateDynamicThingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDynamicThingGroupInput) SetIndexName added in v1.15.79 

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

SetIndexName sets the IndexName field's value.

func (*CreateDynamicThingGroupInput) SetQueryString added in v1.15.79 

func (s *CreateDynamicThingGroupInput) SetQueryString(v string) *CreateDynamicThingGroupInput

SetQueryString sets the QueryString field's value.

func (*CreateDynamicThingGroupInput) SetQueryVersion added in v1.15.79 

func (s *CreateDynamicThingGroupInput) SetQueryVersion(v string) *CreateDynamicThingGroupInput

SetQueryVersion sets the QueryVersion field's value.

func (*CreateDynamicThingGroupInput) SetTags added in v1.15.79 

func (s *CreateDynamicThingGroupInput) SetTags(v []*Tag) *CreateDynamicThingGroupInput

SetTags sets the Tags field's value.

func (*CreateDynamicThingGroupInput) SetThingGroupName added in v1.15.79 

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

SetThingGroupName sets the ThingGroupName field's value.

func (*CreateDynamicThingGroupInput) SetThingGroupProperties added in v1.15.79 

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

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (CreateDynamicThingGroupInput) String added in v1.15.79 

func (s CreateDynamicThingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDynamicThingGroupInput) Validate added in v1.15.79 

func (s *CreateDynamicThingGroupInput) Validate() error

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

type CreateDynamicThingGroupOutput added in v1.15.79 

type CreateDynamicThingGroupOutput struct {

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

	// The dynamic thing group search query string.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`

	// The dynamic thing group query version.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

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

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

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

func (CreateDynamicThingGroupOutput) GoString added in v1.15.79 

func (s CreateDynamicThingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDynamicThingGroupOutput) SetIndexName added in v1.15.79 

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

SetIndexName sets the IndexName field's value.

func (*CreateDynamicThingGroupOutput) SetQueryString added in v1.15.79 

func (s *CreateDynamicThingGroupOutput) SetQueryString(v string) *CreateDynamicThingGroupOutput

SetQueryString sets the QueryString field's value.

func (*CreateDynamicThingGroupOutput) SetQueryVersion added in v1.15.79 

func (s *CreateDynamicThingGroupOutput) SetQueryVersion(v string) *CreateDynamicThingGroupOutput

SetQueryVersion sets the QueryVersion field's value.

func (*CreateDynamicThingGroupOutput) SetThingGroupArn added in v1.15.79 

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

SetThingGroupArn sets the ThingGroupArn field's value.

func (*CreateDynamicThingGroupOutput) SetThingGroupId added in v1.15.79 

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

SetThingGroupId sets the ThingGroupId field's value.

func (*CreateDynamicThingGroupOutput) SetThingGroupName added in v1.15.79 

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

SetThingGroupName sets the ThingGroupName field's value.

func (CreateDynamicThingGroupOutput) String added in v1.15.79 

func (s CreateDynamicThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFleetMetricInput added in v1.40.34 

type CreateFleetMetricInput struct {

	// The field to aggregate.
	//
	// AggregationField is a required field
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string" required:"true"`

	// The type of the aggregation query.
	//
	// AggregationType is a required field
	AggregationType *AggregationType `locationName:"aggregationType" type:"structure" required:"true"`

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

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

	// The name of the fleet metric to create.
	//
	// MetricName is a required field
	MetricName *string `location:"uri" locationName:"metricName" min:"1" type:"string" required:"true"`

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

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

	// Metadata, which can be used to manage the fleet metric.
	Tags []*Tag `locationName:"tags" type:"list"`

	// Used to support unit transformation such as milliseconds to seconds. The
	// unit must be supported by CW metric (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html).
	// Default to null.
	Unit *string `locationName:"unit" type:"string" enum:"FleetMetricUnit"`
	// contains filtered or unexported fields
}

func (CreateFleetMetricInput) GoString added in v1.40.34 

func (s CreateFleetMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetMetricInput) SetAggregationField added in v1.40.34 

func (s *CreateFleetMetricInput) SetAggregationField(v string) *CreateFleetMetricInput

SetAggregationField sets the AggregationField field's value.

func (*CreateFleetMetricInput) SetAggregationType added in v1.40.34 

func (s *CreateFleetMetricInput) SetAggregationType(v *AggregationType) *CreateFleetMetricInput

SetAggregationType sets the AggregationType field's value.

func (*CreateFleetMetricInput) SetDescription added in v1.40.34 

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

SetDescription sets the Description field's value.

func (*CreateFleetMetricInput) SetIndexName added in v1.40.34 

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

SetIndexName sets the IndexName field's value.

func (*CreateFleetMetricInput) SetMetricName added in v1.40.34 

func (s *CreateFleetMetricInput) SetMetricName(v string) *CreateFleetMetricInput

SetMetricName sets the MetricName field's value.

func (*CreateFleetMetricInput) SetPeriod added in v1.40.34 

func (s *CreateFleetMetricInput) SetPeriod(v int64) *CreateFleetMetricInput

SetPeriod sets the Period field's value.

func (*CreateFleetMetricInput) SetQueryString added in v1.40.34 

func (s *CreateFleetMetricInput) SetQueryString(v string) *CreateFleetMetricInput

SetQueryString sets the QueryString field's value.

func (*CreateFleetMetricInput) SetQueryVersion added in v1.40.34 

func (s *CreateFleetMetricInput) SetQueryVersion(v string) *CreateFleetMetricInput

SetQueryVersion sets the QueryVersion field's value.

func (*CreateFleetMetricInput) SetTags added in v1.40.34 

func (s *CreateFleetMetricInput) SetTags(v []*Tag) *CreateFleetMetricInput

SetTags sets the Tags field's value.

func (*CreateFleetMetricInput) SetUnit added in v1.40.34 

func (s *CreateFleetMetricInput) SetUnit(v string) *CreateFleetMetricInput

SetUnit sets the Unit field's value.

func (CreateFleetMetricInput) String added in v1.40.34 

func (s CreateFleetMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetMetricInput) Validate added in v1.40.34 

func (s *CreateFleetMetricInput) Validate() error

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

type CreateFleetMetricOutput added in v1.40.34 

type CreateFleetMetricOutput struct {

	// The Amazon Resource Name (ARN) of the new fleet metric.
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The name of the fleet metric to create.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateFleetMetricOutput) GoString added in v1.40.34 

func (s CreateFleetMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFleetMetricOutput) SetMetricArn added in v1.40.34 

func (s *CreateFleetMetricOutput) SetMetricArn(v string) *CreateFleetMetricOutput

SetMetricArn sets the MetricArn field's value.

func (*CreateFleetMetricOutput) SetMetricName added in v1.40.34 

func (s *CreateFleetMetricOutput) SetMetricName(v string) *CreateFleetMetricOutput

SetMetricName sets the MetricName field's value.

func (CreateFleetMetricOutput) String added in v1.40.34 

func (s CreateFleetMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateJobInput added in v1.12.36 

type CreateJobInput struct {

	// Allows you to create the criteria to abort a job.
	AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"`

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

	// The job document. Required if you don't specify a value for documentSource.
	Document *string `locationName:"document" type:"string"`

	// Parameters of an Amazon Web Services managed template that you can specify
	// to create the job document.
	//
	// documentParameters can only be used when creating jobs from Amazon Web Services
	// managed templates. This parameter can't be used with custom job templates
	// or to create jobs from them.
	DocumentParameters map[string]*string `locationName:"documentParameters" type:"map"`

	// An S3 link to the job document. Required if you don't specify a value for
	// document.
	//
	// If the job document resides in an S3 bucket, you must use a placeholder link
	// when specifying the document.
	//
	// The placeholder link is of the following form:
	//
	// ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
	//
	// where bucket is your bucket name and key is the object in the bucket to which
	// you are linking.
	DocumentSource *string `locationName:"documentSource" min:"1" type:"string"`

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig `locationName:"jobExecutionsRetryConfig" type:"structure"`

	// 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 Amazon Web Services 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"`

	// The ARN of the job template used to create the job.
	JobTemplateArn *string `locationName:"jobTemplateArn" min:"1" type:"string"`

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `locationName:"namespaceId" min:"1" type:"string"`

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

	// Metadata which can be used to manage the job.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	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"`

	// Specifies the amount of time each device has to finish its execution of the
	// job. The timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// time expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateJobInput) GoString added in v1.12.36 

func (s CreateJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobInput) SetAbortConfig added in v1.15.79 

func (s *CreateJobInput) SetAbortConfig(v *AbortConfig) *CreateJobInput

SetAbortConfig sets the AbortConfig field's value.

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) SetJobExecutionsRetryConfig added in v1.42.28 

func (s *CreateJobInput) SetJobExecutionsRetryConfig(v *JobExecutionsRetryConfig) *CreateJobInput

SetJobExecutionsRetryConfig sets the JobExecutionsRetryConfig 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) SetJobTemplateArn added in v1.38.47 

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

SetJobTemplateArn sets the JobTemplateArn field's value.

func (*CreateJobInput) SetNamespaceId added in v1.35.17 

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

SetNamespaceId sets the NamespaceId 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) SetTags added in v1.15.79 

func (s *CreateJobInput) SetTags(v []*Tag) *CreateJobInput

SetTags sets the Tags 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) SetTimeoutConfig added in v1.15.50 

func (s *CreateJobInput) SetTimeoutConfig(v *TimeoutConfig) *CreateJobInput

SetTimeoutConfig sets the TimeoutConfig field's value.

func (CreateJobInput) String added in v1.12.36 

func (s CreateJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateJobTemplateInput added in v1.38.47 

type CreateJobTemplateInput struct {

	// The criteria that determine when and how a job abort takes place.
	AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"`

	// A description of the job document.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// The job document. Required if you don't specify a value for documentSource.
	Document *string `locationName:"document" type:"string"`

	// An S3 link to the job document to use in the template. Required if you don't
	// specify a value for document.
	//
	// If the job document resides in an S3 bucket, you must use a placeholder link
	// when specifying the document.
	//
	// The placeholder link is of the following form:
	//
	// ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
	//
	// where bucket is your bucket name and key is the object in the bucket to which
	// you are linking.
	DocumentSource *string `locationName:"documentSource" min:"1" type:"string"`

	// The ARN of the job to use as the basis for the job template.
	JobArn *string `locationName:"jobArn" type:"string"`

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig `locationName:"jobExecutionsRetryConfig" type:"structure"`

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

	// A unique identifier for the job template. We recommend using a UUID. Alpha-numeric
	// characters, "-", and "_" are valid for use here.
	//
	// JobTemplateId is a required field
	JobTemplateId *string `location:"uri" locationName:"jobTemplateId" min:"1" type:"string" required:"true"`

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

	// Metadata that can be used to manage the job template.
	Tags []*Tag `locationName:"tags" type:"list"`

	// Specifies the amount of time each device has to finish its execution of the
	// job. A timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// timer expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateJobTemplateInput) GoString added in v1.38.47 

func (s CreateJobTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobTemplateInput) SetAbortConfig added in v1.38.47 

func (s *CreateJobTemplateInput) SetAbortConfig(v *AbortConfig) *CreateJobTemplateInput

SetAbortConfig sets the AbortConfig field's value.

func (*CreateJobTemplateInput) SetDescription added in v1.38.47 

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

SetDescription sets the Description field's value.

func (*CreateJobTemplateInput) SetDocument added in v1.38.47 

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

SetDocument sets the Document field's value.

func (*CreateJobTemplateInput) SetDocumentSource added in v1.38.47 

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

SetDocumentSource sets the DocumentSource field's value.

func (*CreateJobTemplateInput) SetJobArn added in v1.38.47 

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

SetJobArn sets the JobArn field's value.

func (*CreateJobTemplateInput) SetJobExecutionsRetryConfig added in v1.42.28 

func (s *CreateJobTemplateInput) SetJobExecutionsRetryConfig(v *JobExecutionsRetryConfig) *CreateJobTemplateInput

SetJobExecutionsRetryConfig sets the JobExecutionsRetryConfig field's value.

func (*CreateJobTemplateInput) SetJobExecutionsRolloutConfig added in v1.38.47 

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

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*CreateJobTemplateInput) SetJobTemplateId added in v1.38.47 

func (s *CreateJobTemplateInput) SetJobTemplateId(v string) *CreateJobTemplateInput

SetJobTemplateId sets the JobTemplateId field's value.

func (*CreateJobTemplateInput) SetPresignedUrlConfig added in v1.38.47 

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

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

func (*CreateJobTemplateInput) SetTags added in v1.38.47 

func (s *CreateJobTemplateInput) SetTags(v []*Tag) *CreateJobTemplateInput

SetTags sets the Tags field's value.

func (*CreateJobTemplateInput) SetTimeoutConfig added in v1.38.47 

func (s *CreateJobTemplateInput) SetTimeoutConfig(v *TimeoutConfig) *CreateJobTemplateInput

SetTimeoutConfig sets the TimeoutConfig field's value.

func (CreateJobTemplateInput) String added in v1.38.47 

func (s CreateJobTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobTemplateInput) Validate added in v1.38.47 

func (s *CreateJobTemplateInput) Validate() error

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

type CreateJobTemplateOutput added in v1.38.47 

type CreateJobTemplateOutput struct {

	// The ARN of the job template.
	JobTemplateArn *string `locationName:"jobTemplateArn" min:"1" type:"string"`

	// The unique identifier of the job template.
	JobTemplateId *string `locationName:"jobTemplateId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateJobTemplateOutput) GoString added in v1.38.47 

func (s CreateJobTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJobTemplateOutput) SetJobTemplateArn added in v1.38.47 

func (s *CreateJobTemplateOutput) SetJobTemplateArn(v string) *CreateJobTemplateOutput

SetJobTemplateArn sets the JobTemplateArn field's value.

func (*CreateJobTemplateOutput) SetJobTemplateId added in v1.38.47 

func (s *CreateJobTemplateOutput) SetJobTemplateId(v string) *CreateJobTemplateOutput

SetJobTemplateId sets the JobTemplateId field's value.

func (CreateJobTemplateOutput) String added in v1.38.47 

func (s CreateJobTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

Requires permission to access the CreateKeysAndCertificateRequest (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

func (CreateKeysAndCertificateInput) GoString 

func (s CreateKeysAndCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeysAndCertificateInput) SetSetAsActive added in v1.5.0 

func (s *CreateKeysAndCertificateInput) SetSetAsActive(v bool) *CreateKeysAndCertificateInput

SetSetAsActive sets the SetAsActive field's value.

func (CreateKeysAndCertificateInput) String 

func (s CreateKeysAndCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateKeysAndCertificateOutput 

type CreateKeysAndCertificateOutput struct {

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

	// The ID of the certificate. IoT issues a default subject name for the certificate
	// (for example, 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 

func (s CreateKeysAndCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeysAndCertificateOutput) SetCertificateArn added in v1.5.0 

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

SetCertificateArn sets the CertificateArn field's value.

func (*CreateKeysAndCertificateOutput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (*CreateKeysAndCertificateOutput) SetCertificatePem added in v1.5.0 

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

SetCertificatePem sets the CertificatePem field's value.

func (*CreateKeysAndCertificateOutput) SetKeyPair added in v1.5.0 

func (s *CreateKeysAndCertificateOutput) SetKeyPair(v *KeyPair) *CreateKeysAndCertificateOutput

SetKeyPair sets the KeyPair field's value.

func (CreateKeysAndCertificateOutput) String 

func (s CreateKeysAndCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMitigationActionInput added in v1.21.10 

type CreateMitigationActionInput struct {

	// A friendly name for the action. Choose a friendly name that accurately describes
	// the action (for example, EnableLoggingAction).
	//
	// ActionName is a required field
	ActionName *string `location:"uri" locationName:"actionName" type:"string" required:"true"`

	// Defines the type of action and the parameters for that action.
	//
	// ActionParams is a required field
	ActionParams *MitigationActionParams `locationName:"actionParams" type:"structure" required:"true"`

	// The ARN of the IAM role that is used to apply the mitigation action.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// Metadata that can be used to manage the mitigation action.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateMitigationActionInput) GoString added in v1.21.10 

func (s CreateMitigationActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMitigationActionInput) SetActionName added in v1.21.10 

func (s *CreateMitigationActionInput) SetActionName(v string) *CreateMitigationActionInput

SetActionName sets the ActionName field's value.

func (*CreateMitigationActionInput) SetActionParams added in v1.21.10 

func (s *CreateMitigationActionInput) SetActionParams(v *MitigationActionParams) *CreateMitigationActionInput

SetActionParams sets the ActionParams field's value.

func (*CreateMitigationActionInput) SetRoleArn added in v1.21.10 

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

SetRoleArn sets the RoleArn field's value.

func (*CreateMitigationActionInput) SetTags added in v1.21.10 

func (s *CreateMitigationActionInput) SetTags(v []*Tag) *CreateMitigationActionInput

SetTags sets the Tags field's value.

func (CreateMitigationActionInput) String added in v1.21.10 

func (s CreateMitigationActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMitigationActionInput) Validate added in v1.21.10 

func (s *CreateMitigationActionInput) Validate() error

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

type CreateMitigationActionOutput added in v1.21.10 

type CreateMitigationActionOutput struct {

	// The ARN for the new mitigation action.
	ActionArn *string `locationName:"actionArn" type:"string"`

	// A unique identifier for the new mitigation action.
	ActionId *string `locationName:"actionId" type:"string"`
	// contains filtered or unexported fields
}

func (CreateMitigationActionOutput) GoString added in v1.21.10 

func (s CreateMitigationActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMitigationActionOutput) SetActionArn added in v1.21.10 

func (s *CreateMitigationActionOutput) SetActionArn(v string) *CreateMitigationActionOutput

SetActionArn sets the ActionArn field's value.

func (*CreateMitigationActionOutput) SetActionId added in v1.21.10 

func (s *CreateMitigationActionOutput) SetActionId(v string) *CreateMitigationActionOutput

SetActionId sets the ActionId field's value.

func (CreateMitigationActionOutput) String added in v1.21.10 

func (s CreateMitigationActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 criteria that determine when and how a job abort takes place.
	AwsJobAbortConfig *AwsJobAbortConfig `locationName:"awsJobAbortConfig" type:"structure"`

	// Configuration for the rollout of OTA updates.
	AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig `locationName:"awsJobExecutionsRolloutConfig" type:"structure"`

	// Configuration information for pre-signed URLs.
	AwsJobPresignedUrlConfig *AwsJobPresignedUrlConfig `locationName:"awsJobPresignedUrlConfig" type:"structure"`

	// Specifies the amount of time each device has to finish its execution of the
	// job. A timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// timer expires, it will be automatically set to TIMED_OUT.
	AwsJobTimeoutConfig *AwsJobTimeoutConfig `locationName:"awsJobTimeoutConfig" type:"structure"`

	// 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 protocol used to transfer the OTA update image. Valid values are [HTTP],
	// [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device
	// can choose the protocol.
	Protocols []*string `locationName:"protocols" min:"1" type:"list" enum:"Protocol"`

	// The IAM role that grants Amazon Web Services IoT Core access to the Amazon
	// S3, IoT jobs and Amazon Web Services Code Signing resources to create an
	// OTA update job.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// Metadata which can be used to manage updates.
	Tags []*Tag `locationName:"tags" type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetAwsJobAbortConfig added in v1.32.2 

func (s *CreateOTAUpdateInput) SetAwsJobAbortConfig(v *AwsJobAbortConfig) *CreateOTAUpdateInput

SetAwsJobAbortConfig sets the AwsJobAbortConfig field's value.

func (*CreateOTAUpdateInput) SetAwsJobExecutionsRolloutConfig added in v1.15.22 

func (s *CreateOTAUpdateInput) SetAwsJobExecutionsRolloutConfig(v *AwsJobExecutionsRolloutConfig) *CreateOTAUpdateInput

SetAwsJobExecutionsRolloutConfig sets the AwsJobExecutionsRolloutConfig field's value.

func (*CreateOTAUpdateInput) SetAwsJobPresignedUrlConfig added in v1.26.4 

func (s *CreateOTAUpdateInput) SetAwsJobPresignedUrlConfig(v *AwsJobPresignedUrlConfig) *CreateOTAUpdateInput

SetAwsJobPresignedUrlConfig sets the AwsJobPresignedUrlConfig field's value.

func (*CreateOTAUpdateInput) SetAwsJobTimeoutConfig added in v1.32.2 

func (s *CreateOTAUpdateInput) SetAwsJobTimeoutConfig(v *AwsJobTimeoutConfig) *CreateOTAUpdateInput

SetAwsJobTimeoutConfig sets the AwsJobTimeoutConfig 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 

func (s *CreateOTAUpdateInput) SetFiles(v []*OTAUpdateFile) *CreateOTAUpdateInput

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) SetProtocols added in v1.26.4 

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

SetProtocols sets the Protocols field's value.

func (*CreateOTAUpdateInput) SetRoleArn added in v1.12.51 

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

SetRoleArn sets the RoleArn field's value.

func (*CreateOTAUpdateInput) SetTags added in v1.18.3 

func (s *CreateOTAUpdateInput) SetTags(v []*Tag) *CreateOTAUpdateInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IoT job ARN associated with the OTA update.
	AwsIotJobArn *string `locationName:"awsIotJobArn" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Metadata which can be used to manage the policy.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The input for the CreatePolicy operation.

func (CreatePolicyInput) GoString 

func (s CreatePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTags added in v1.30.18 

func (s *CreatePolicyInput) SetTags(v []*Tag) *CreatePolicyInput

SetTags sets the Tags field's value.

func (CreatePolicyInput) String 

func (s CreatePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetPolicyName sets the PolicyName field's value.

func (*CreatePolicyVersionInput) SetSetAsDefault added in v1.5.0 

func (s *CreatePolicyVersionInput) SetSetAsDefault(v bool) *CreatePolicyVersionInput

SetSetAsDefault sets the SetAsDefault field's value.

func (CreatePolicyVersionInput) String 

func (s CreatePolicyVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetPolicyArn sets the PolicyArn field's value.

func (*CreatePolicyVersionOutput) SetPolicyDocument added in v1.5.0 

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

SetPolicyDocument sets the PolicyDocument field's value.

func (*CreatePolicyVersionOutput) SetPolicyVersionId added in v1.5.0 

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

SetPolicyVersionId sets the PolicyVersionId field's value.

func (CreatePolicyVersionOutput) String 

func (s CreatePolicyVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProvisioningClaimInput added in v1.25.42 

type CreateProvisioningClaimInput struct {

	// The name of the provisioning template to use.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProvisioningClaimInput) GoString added in v1.25.42 

func (s CreateProvisioningClaimInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningClaimInput) SetTemplateName added in v1.25.42 

func (s *CreateProvisioningClaimInput) SetTemplateName(v string) *CreateProvisioningClaimInput

SetTemplateName sets the TemplateName field's value.

func (CreateProvisioningClaimInput) String added in v1.25.42 

func (s CreateProvisioningClaimInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningClaimInput) Validate added in v1.25.42 

func (s *CreateProvisioningClaimInput) Validate() error

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

type CreateProvisioningClaimOutput added in v1.25.42 

type CreateProvisioningClaimOutput struct {

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

	// The provisioning claim certificate.
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string"`

	// The provisioning claim expiration time.
	Expiration *time.Time `locationName:"expiration" type:"timestamp"`

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

func (CreateProvisioningClaimOutput) GoString added in v1.25.42 

func (s CreateProvisioningClaimOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningClaimOutput) SetCertificateId added in v1.25.42 

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

SetCertificateId sets the CertificateId field's value.

func (*CreateProvisioningClaimOutput) SetCertificatePem added in v1.25.42 

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

SetCertificatePem sets the CertificatePem field's value.

func (*CreateProvisioningClaimOutput) SetExpiration added in v1.25.42 

func (s *CreateProvisioningClaimOutput) SetExpiration(v time.Time) *CreateProvisioningClaimOutput

SetExpiration sets the Expiration field's value.

func (*CreateProvisioningClaimOutput) SetKeyPair added in v1.25.42 

func (s *CreateProvisioningClaimOutput) SetKeyPair(v *KeyPair) *CreateProvisioningClaimOutput

SetKeyPair sets the KeyPair field's value.

func (CreateProvisioningClaimOutput) String added in v1.25.42 

func (s CreateProvisioningClaimOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProvisioningTemplateInput added in v1.25.42 

type CreateProvisioningTemplateInput struct {

	// The description of the fleet provisioning template.
	Description *string `locationName:"description" type:"string"`

	// True to enable the fleet provisioning template, otherwise false.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// Creates a pre-provisioning hook template.
	PreProvisioningHook *ProvisioningHook `locationName:"preProvisioningHook" type:"structure"`

	// The role ARN for the role associated with the fleet provisioning template.
	// This IoT role grants permission to provision a device.
	//
	// ProvisioningRoleArn is a required field
	ProvisioningRoleArn *string `locationName:"provisioningRoleArn" min:"20" type:"string" required:"true"`

	// Metadata which can be used to manage the fleet provisioning template.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`

	// The JSON formatted contents of the fleet provisioning template.
	//
	// TemplateBody is a required field
	TemplateBody *string `locationName:"templateBody" type:"string" required:"true"`

	// The name of the fleet provisioning template.
	//
	// TemplateName is a required field
	TemplateName *string `locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProvisioningTemplateInput) GoString added in v1.25.42 

func (s CreateProvisioningTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateInput) SetDescription added in v1.25.42 

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

SetDescription sets the Description field's value.

func (*CreateProvisioningTemplateInput) SetEnabled added in v1.25.42 

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

SetEnabled sets the Enabled field's value.

func (*CreateProvisioningTemplateInput) SetPreProvisioningHook added in v1.30.18 

func (s *CreateProvisioningTemplateInput) SetPreProvisioningHook(v *ProvisioningHook) *CreateProvisioningTemplateInput

SetPreProvisioningHook sets the PreProvisioningHook field's value.

func (*CreateProvisioningTemplateInput) SetProvisioningRoleArn added in v1.25.42 

func (s *CreateProvisioningTemplateInput) SetProvisioningRoleArn(v string) *CreateProvisioningTemplateInput

SetProvisioningRoleArn sets the ProvisioningRoleArn field's value.

func (*CreateProvisioningTemplateInput) SetTags added in v1.25.42 

func (s *CreateProvisioningTemplateInput) SetTags(v []*Tag) *CreateProvisioningTemplateInput

SetTags sets the Tags field's value.

func (*CreateProvisioningTemplateInput) SetTemplateBody added in v1.25.42 

func (s *CreateProvisioningTemplateInput) SetTemplateBody(v string) *CreateProvisioningTemplateInput

SetTemplateBody sets the TemplateBody field's value.

func (*CreateProvisioningTemplateInput) SetTemplateName added in v1.25.42 

func (s *CreateProvisioningTemplateInput) SetTemplateName(v string) *CreateProvisioningTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreateProvisioningTemplateInput) String added in v1.25.42 

func (s CreateProvisioningTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateInput) Validate added in v1.25.42 

func (s *CreateProvisioningTemplateInput) Validate() error

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

type CreateProvisioningTemplateOutput added in v1.25.42 

type CreateProvisioningTemplateOutput struct {

	// The default version of the fleet provisioning template.
	DefaultVersionId *int64 `locationName:"defaultVersionId" type:"integer"`

	// The ARN that identifies the provisioning template.
	TemplateArn *string `locationName:"templateArn" type:"string"`

	// The name of the fleet provisioning template.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProvisioningTemplateOutput) GoString added in v1.25.42 

func (s CreateProvisioningTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateOutput) SetDefaultVersionId added in v1.25.42 

func (s *CreateProvisioningTemplateOutput) SetDefaultVersionId(v int64) *CreateProvisioningTemplateOutput

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*CreateProvisioningTemplateOutput) SetTemplateArn added in v1.25.42 

func (s *CreateProvisioningTemplateOutput) SetTemplateArn(v string) *CreateProvisioningTemplateOutput

SetTemplateArn sets the TemplateArn field's value.

func (*CreateProvisioningTemplateOutput) SetTemplateName added in v1.25.42 

func (s *CreateProvisioningTemplateOutput) SetTemplateName(v string) *CreateProvisioningTemplateOutput

SetTemplateName sets the TemplateName field's value.

func (CreateProvisioningTemplateOutput) String added in v1.25.42 

func (s CreateProvisioningTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProvisioningTemplateVersionInput added in v1.25.42 

type CreateProvisioningTemplateVersionInput struct {

	// Sets a fleet provision template version as the default version.
	SetAsDefault *bool `location:"querystring" locationName:"setAsDefault" type:"boolean"`

	// The JSON formatted contents of the fleet provisioning template.
	//
	// TemplateBody is a required field
	TemplateBody *string `locationName:"templateBody" type:"string" required:"true"`

	// The name of the fleet provisioning template.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProvisioningTemplateVersionInput) GoString added in v1.25.42 

func (s CreateProvisioningTemplateVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateVersionInput) SetSetAsDefault added in v1.25.42 

func (s *CreateProvisioningTemplateVersionInput) SetSetAsDefault(v bool) *CreateProvisioningTemplateVersionInput

SetSetAsDefault sets the SetAsDefault field's value.

func (*CreateProvisioningTemplateVersionInput) SetTemplateBody added in v1.25.42 

func (s *CreateProvisioningTemplateVersionInput) SetTemplateBody(v string) *CreateProvisioningTemplateVersionInput

SetTemplateBody sets the TemplateBody field's value.

func (*CreateProvisioningTemplateVersionInput) SetTemplateName added in v1.25.42 

func (s *CreateProvisioningTemplateVersionInput) SetTemplateName(v string) *CreateProvisioningTemplateVersionInput

SetTemplateName sets the TemplateName field's value.

func (CreateProvisioningTemplateVersionInput) String added in v1.25.42 

func (s CreateProvisioningTemplateVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateVersionInput) Validate added in v1.25.42 

func (s *CreateProvisioningTemplateVersionInput) Validate() error

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

type CreateProvisioningTemplateVersionOutput added in v1.25.42 

type CreateProvisioningTemplateVersionOutput struct {

	// True if the fleet provisioning template version is the default version, otherwise
	// false.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The ARN that identifies the provisioning template.
	TemplateArn *string `locationName:"templateArn" type:"string"`

	// The name of the fleet provisioning template.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`

	// The version of the fleet provisioning template.
	VersionId *int64 `locationName:"versionId" type:"integer"`
	// contains filtered or unexported fields
}

func (CreateProvisioningTemplateVersionOutput) GoString added in v1.25.42 

func (s CreateProvisioningTemplateVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProvisioningTemplateVersionOutput) SetIsDefaultVersion added in v1.25.42 

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

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*CreateProvisioningTemplateVersionOutput) SetTemplateArn added in v1.25.42 

func (s *CreateProvisioningTemplateVersionOutput) SetTemplateArn(v string) *CreateProvisioningTemplateVersionOutput

SetTemplateArn sets the TemplateArn field's value.

func (*CreateProvisioningTemplateVersionOutput) SetTemplateName added in v1.25.42 

func (s *CreateProvisioningTemplateVersionOutput) SetTemplateName(v string) *CreateProvisioningTemplateVersionOutput

SetTemplateName sets the TemplateName field's value.

func (*CreateProvisioningTemplateVersionOutput) SetVersionId added in v1.25.42 

func (s *CreateProvisioningTemplateVersionOutput) SetVersionId(v int64) *CreateProvisioningTemplateVersionOutput

SetVersionId sets the VersionId field's value.

func (CreateProvisioningTemplateVersionOutput) String added in v1.25.42 

func (s CreateProvisioningTemplateVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRoleAliasInput added in v1.12.36 

type CreateRoleAliasInput struct {

	// How long (in seconds) the credentials will be valid. The default value is
	// 3,600 seconds.
	//
	// This value must be less than or equal to the maximum session duration of
	// the IAM role that the role alias references.
	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"`

	// Metadata which can be used to manage the role alias.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRoleAliasInput) GoString added in v1.12.36 

func (s CreateRoleAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetRoleArn sets the RoleArn field's value.

func (*CreateRoleAliasInput) SetTags added in v1.30.18 

func (s *CreateRoleAliasInput) SetTags(v []*Tag) *CreateRoleAliasInput

SetTags sets the Tags field's value.

func (CreateRoleAliasInput) String added in v1.12.36 

func (s CreateRoleAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"1" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRoleAliasOutput) SetRoleAlias added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateScheduledAuditInput added in v1.15.2 

type CreateScheduledAuditInput struct {

	// The day of the month on which the scheduled audit takes place. This can be
	// "1" through "31" or "LAST". This field is required if the "frequency" parameter
	// is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't
	// have that many days, the audit takes place on the LAST day of the month.
	DayOfMonth *string `locationName:"dayOfMonth" type:"string"`

	// The day of the week on which the scheduled audit takes place, either SUN,
	// MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency
	// parameter is set to WEEKLY or BIWEEKLY.
	DayOfWeek *string `locationName:"dayOfWeek" type:"string" enum:"DayOfWeek"`

	// How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY
	// or MONTHLY. The start time of each audit is determined by the system.
	//
	// Frequency is a required field
	Frequency *string `locationName:"frequency" type:"string" required:"true" enum:"AuditFrequency"`

	// The name you want to give to the scheduled audit. (Max. 128 chars)
	//
	// ScheduledAuditName is a required field
	ScheduledAuditName *string `location:"uri" locationName:"scheduledAuditName" min:"1" type:"string" required:"true"`

	// Metadata that can be used to manage the scheduled audit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list
	// of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// TargetCheckNames is a required field
	TargetCheckNames []*string `locationName:"targetCheckNames" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateScheduledAuditInput) GoString added in v1.15.2 

func (s CreateScheduledAuditInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScheduledAuditInput) SetDayOfMonth added in v1.15.2 

func (s *CreateScheduledAuditInput) SetDayOfMonth(v string) *CreateScheduledAuditInput

SetDayOfMonth sets the DayOfMonth field's value.

func (*CreateScheduledAuditInput) SetDayOfWeek added in v1.15.2 

func (s *CreateScheduledAuditInput) SetDayOfWeek(v string) *CreateScheduledAuditInput

SetDayOfWeek sets the DayOfWeek field's value.

func (*CreateScheduledAuditInput) SetFrequency added in v1.15.2 

func (s *CreateScheduledAuditInput) SetFrequency(v string) *CreateScheduledAuditInput

SetFrequency sets the Frequency field's value.

func (*CreateScheduledAuditInput) SetScheduledAuditName added in v1.15.2 

func (s *CreateScheduledAuditInput) SetScheduledAuditName(v string) *CreateScheduledAuditInput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (*CreateScheduledAuditInput) SetTags added in v1.16.36 

func (s *CreateScheduledAuditInput) SetTags(v []*Tag) *CreateScheduledAuditInput

SetTags sets the Tags field's value.

func (*CreateScheduledAuditInput) SetTargetCheckNames added in v1.15.2 

func (s *CreateScheduledAuditInput) SetTargetCheckNames(v []*string) *CreateScheduledAuditInput

SetTargetCheckNames sets the TargetCheckNames field's value.

func (CreateScheduledAuditInput) String added in v1.15.2 

func (s CreateScheduledAuditInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScheduledAuditInput) Validate added in v1.15.2 

func (s *CreateScheduledAuditInput) Validate() error

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

type CreateScheduledAuditOutput added in v1.15.2 

type CreateScheduledAuditOutput struct {

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string `locationName:"scheduledAuditArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateScheduledAuditOutput) GoString added in v1.15.2 

func (s CreateScheduledAuditOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScheduledAuditOutput) SetScheduledAuditArn added in v1.15.2 

func (s *CreateScheduledAuditOutput) SetScheduledAuditArn(v string) *CreateScheduledAuditOutput

SetScheduledAuditArn sets the ScheduledAuditArn field's value.

func (CreateScheduledAuditOutput) String added in v1.15.2 

func (s CreateScheduledAuditOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSecurityProfileInput added in v1.15.2 

type CreateSecurityProfileInput struct {

	// Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
	//
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here. Can be used with custom metrics; cannot be used
	// with dimensions.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []*string `locationName:"additionalMetricsToRetain" deprecated:"true" type:"list"`

	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here. Can be used with custom metrics; cannot be used
	// with dimensions.
	AdditionalMetricsToRetainV2 []*MetricToRetain `locationName:"additionalMetricsToRetainV2" type:"list"`

	// Specifies the destinations to which alerts are sent. (Alerts are always sent
	// to the console.) Alerts are generated when a device (thing) violates a behavior.
	AlertTargets map[string]*AlertTarget `locationName:"alertTargets" type:"map"`

	// Specifies the behaviors that, when violated by a device (thing), cause an
	// alert.
	Behaviors []*Behavior `locationName:"behaviors" type:"list"`

	// A description of the security profile.
	SecurityProfileDescription *string `locationName:"securityProfileDescription" type:"string"`

	// The name you are giving to the security profile.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`

	// Metadata that can be used to manage the security profile.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateSecurityProfileInput) GoString added in v1.15.2 

func (s CreateSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSecurityProfileInput) SetAdditionalMetricsToRetain added in v1.17.1 

func (s *CreateSecurityProfileInput) SetAdditionalMetricsToRetain(v []*string) *CreateSecurityProfileInput

SetAdditionalMetricsToRetain sets the AdditionalMetricsToRetain field's value.

func (*CreateSecurityProfileInput) SetAdditionalMetricsToRetainV2 added in v1.30.2 

func (s *CreateSecurityProfileInput) SetAdditionalMetricsToRetainV2(v []*MetricToRetain) *CreateSecurityProfileInput

SetAdditionalMetricsToRetainV2 sets the AdditionalMetricsToRetainV2 field's value.

func (*CreateSecurityProfileInput) SetAlertTargets added in v1.15.2 

func (s *CreateSecurityProfileInput) SetAlertTargets(v map[string]*AlertTarget) *CreateSecurityProfileInput

SetAlertTargets sets the AlertTargets field's value.

func (*CreateSecurityProfileInput) SetBehaviors added in v1.15.2 

func (s *CreateSecurityProfileInput) SetBehaviors(v []*Behavior) *CreateSecurityProfileInput

SetBehaviors sets the Behaviors field's value.

func (*CreateSecurityProfileInput) SetSecurityProfileDescription added in v1.15.2 

func (s *CreateSecurityProfileInput) SetSecurityProfileDescription(v string) *CreateSecurityProfileInput

SetSecurityProfileDescription sets the SecurityProfileDescription field's value.

func (*CreateSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *CreateSecurityProfileInput) SetSecurityProfileName(v string) *CreateSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*CreateSecurityProfileInput) SetTags added in v1.15.79 

func (s *CreateSecurityProfileInput) SetTags(v []*Tag) *CreateSecurityProfileInput

SetTags sets the Tags field's value.

func (CreateSecurityProfileInput) String added in v1.15.2 

func (s CreateSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSecurityProfileInput) Validate added in v1.15.2 

func (s *CreateSecurityProfileInput) Validate() error

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

type CreateSecurityProfileOutput added in v1.15.2 

type CreateSecurityProfileOutput struct {

	// The ARN of the security profile.
	SecurityProfileArn *string `locationName:"securityProfileArn" type:"string"`

	// The name you gave to the security profile.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSecurityProfileOutput) GoString added in v1.15.2 

func (s CreateSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSecurityProfileOutput) SetSecurityProfileArn added in v1.15.2 

func (s *CreateSecurityProfileOutput) SetSecurityProfileArn(v string) *CreateSecurityProfileOutput

SetSecurityProfileArn sets the SecurityProfileArn field's value.

func (*CreateSecurityProfileOutput) SetSecurityProfileName added in v1.15.2 

func (s *CreateSecurityProfileOutput) SetSecurityProfileName(v string) *CreateSecurityProfileOutput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (CreateSecurityProfileOutput) String added in v1.15.2 

func (s CreateSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

func (CreateStreamInput) GoString added in v1.12.51 

func (s CreateStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTags added in v1.18.3 

func (s *CreateStreamInput) SetTags(v []*Tag) *CreateStreamInput

SetTags sets the Tags field's value.

func (CreateStreamInput) String added in v1.12.51 

func (s CreateStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Metadata which can be used to manage the thing group.
	Tags []*Tag `locationName:"tags" type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThingGroupInput) SetParentGroupName added in v1.12.36 

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

SetParentGroupName sets the ParentGroupName field's value.

func (*CreateThingGroupInput) SetTags added in v1.15.79 

func (s *CreateThingGroupInput) SetTags(v []*Tag) *CreateThingGroupInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 billing group the thing will be added to.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`

	// The name of the thing to create.
	//
	// You can't change a thing's name after you create it. To change a thing's
	// name, you must create a new thing, give it the new name, and then delete
	// the old thing.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThingInput) SetAttributePayload added in v1.5.0 

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

SetAttributePayload sets the AttributePayload field's value.

func (*CreateThingInput) SetBillingGroupName added in v1.15.79 

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

SetBillingGroupName sets the BillingGroupName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateThingTypeInput added in v1.2.8 

type CreateThingTypeInput struct {

	// Metadata which can be used to manage the thing type.
	Tags []*Tag `locationName:"tags" type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThingTypeInput) SetTags added in v1.15.79 

func (s *CreateThingTypeInput) SetTags(v []*Tag) *CreateThingTypeInput

SetTags sets the Tags field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTopicRuleDestinationInput added in v1.25.38 

type CreateTopicRuleDestinationInput struct {

	// The topic rule destination configuration.
	//
	// DestinationConfiguration is a required field
	DestinationConfiguration *TopicRuleDestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTopicRuleDestinationInput) GoString added in v1.25.38 

func (s CreateTopicRuleDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTopicRuleDestinationInput) SetDestinationConfiguration added in v1.25.38 

func (s *CreateTopicRuleDestinationInput) SetDestinationConfiguration(v *TopicRuleDestinationConfiguration) *CreateTopicRuleDestinationInput

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (CreateTopicRuleDestinationInput) String added in v1.25.38 

func (s CreateTopicRuleDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTopicRuleDestinationInput) Validate added in v1.25.38 

func (s *CreateTopicRuleDestinationInput) Validate() error

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

type CreateTopicRuleDestinationOutput added in v1.25.38 

type CreateTopicRuleDestinationOutput struct {

	// The topic rule destination.
	TopicRuleDestination *TopicRuleDestination `locationName:"topicRuleDestination" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateTopicRuleDestinationOutput) GoString added in v1.25.38 

func (s CreateTopicRuleDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTopicRuleDestinationOutput) SetTopicRuleDestination added in v1.25.38 

func (s *CreateTopicRuleDestinationOutput) SetTopicRuleDestination(v *TopicRuleDestination) *CreateTopicRuleDestinationOutput

SetTopicRuleDestination sets the TopicRuleDestination field's value.

func (CreateTopicRuleDestinationOutput) String added in v1.25.38 

func (s CreateTopicRuleDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Metadata which can be used to manage the topic rule.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags *string `location:"header" locationName:"x-amz-tagging" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTopicRuleInput) SetRuleName added in v1.5.0 

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

SetRuleName sets the RuleName field's value.

func (*CreateTopicRuleInput) SetTags added in v1.16.17 

func (s *CreateTopicRuleInput) SetTags(v string) *CreateTopicRuleInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateTopicRuleOutput) String 

func (s CreateTopicRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. You can use a string as the
	// algorithm name if the target over-the-air (OTA) update devices are able to
	// verify the signature that was generated using the same signature algorithm.
	// For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them
	// based on which was used for generating the signature.
	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. You can use a string
	// as the algorithm name if the target over-the-air (OTA) update devices are
	// able to verify the signature that was generated using the same signature
	// algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either
	// of them based on which was used for generating the signature.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomCodeSigning) SetCertificateChain added in v1.12.51 

func (s *CustomCodeSigning) SetCertificateChain(v *CodeSigningCertificateChain) *CustomCodeSigning

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 

func (s *CustomCodeSigning) SetSignature(v *CodeSigningSignature) *CustomCodeSigning

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAccountAuditConfigurationInput added in v1.15.2 

type DeleteAccountAuditConfigurationInput struct {

	// If true, all scheduled audits are deleted.
	DeleteScheduledAudits *bool `location:"querystring" locationName:"deleteScheduledAudits" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteAccountAuditConfigurationInput) GoString added in v1.15.2 

func (s DeleteAccountAuditConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountAuditConfigurationInput) SetDeleteScheduledAudits added in v1.15.2 

func (s *DeleteAccountAuditConfigurationInput) SetDeleteScheduledAudits(v bool) *DeleteAccountAuditConfigurationInput

SetDeleteScheduledAudits sets the DeleteScheduledAudits field's value.

func (DeleteAccountAuditConfigurationInput) String added in v1.15.2 

func (s DeleteAccountAuditConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAccountAuditConfigurationOutput added in v1.15.2 

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

func (DeleteAccountAuditConfigurationOutput) GoString added in v1.15.2 

func (s DeleteAccountAuditConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccountAuditConfigurationOutput) String added in v1.15.2 

func (s DeleteAccountAuditConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAuditSuppressionInput added in v1.34.3 

type DeleteAuditSuppressionInput struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// CheckName is a required field
	CheckName *string `locationName:"checkName" type:"string" required:"true"`

	// Information that identifies the noncompliant resource.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAuditSuppressionInput) GoString added in v1.34.3 

func (s DeleteAuditSuppressionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAuditSuppressionInput) SetCheckName added in v1.34.3 

func (s *DeleteAuditSuppressionInput) SetCheckName(v string) *DeleteAuditSuppressionInput

SetCheckName sets the CheckName field's value.

func (*DeleteAuditSuppressionInput) SetResourceIdentifier added in v1.34.3 

func (s *DeleteAuditSuppressionInput) SetResourceIdentifier(v *ResourceIdentifier) *DeleteAuditSuppressionInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DeleteAuditSuppressionInput) String added in v1.34.3 

func (s DeleteAuditSuppressionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAuditSuppressionInput) Validate added in v1.34.3 

func (s *DeleteAuditSuppressionInput) Validate() error

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

type DeleteAuditSuppressionOutput added in v1.34.3 

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

func (DeleteAuditSuppressionOutput) GoString added in v1.34.3 

func (s DeleteAuditSuppressionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAuditSuppressionOutput) String added in v1.34.3 

func (s DeleteAuditSuppressionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAuthorizerOutput) String added in v1.12.36 

func (s DeleteAuthorizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBillingGroupInput added in v1.15.79 

type DeleteBillingGroupInput struct {

	// The name of the billing group.
	//
	// BillingGroupName is a required field
	BillingGroupName *string `location:"uri" locationName:"billingGroupName" min:"1" type:"string" required:"true"`

	// The expected version of the billing group. If the version of the billing
	// group does not match the expected version specified in the request, the DeleteBillingGroup
	// request is rejected with a VersionConflictException.
	ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"`
	// contains filtered or unexported fields
}

func (DeleteBillingGroupInput) GoString added in v1.15.79 

func (s DeleteBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *DeleteBillingGroupInput) SetBillingGroupName(v string) *DeleteBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*DeleteBillingGroupInput) SetExpectedVersion added in v1.15.79 

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (DeleteBillingGroupInput) String added in v1.15.79 

func (s DeleteBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBillingGroupInput) Validate added in v1.15.79 

func (s *DeleteBillingGroupInput) Validate() error

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

type DeleteBillingGroupOutput added in v1.15.79 

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

func (DeleteBillingGroupOutput) GoString added in v1.15.79 

func (s DeleteBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBillingGroupOutput) String added in v1.15.79 

func (s DeleteBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCACertificateInput) SetCertificateId added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCACertificateOutput) String added in v1.1.18 

func (s DeleteCACertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 the deletion of a certificate if it is inactive and is not attached
	// to an IoT thing.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCertificateOutput) String 

func (s DeleteCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConflictException added in v1.28.0 

type DeleteConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*DeleteConflictException) Code added in v1.28.0 

func (s *DeleteConflictException) Code() string

Code returns the exception type name.

func (*DeleteConflictException) Error added in v1.28.0 

func (s *DeleteConflictException) Error() string

func (DeleteConflictException) GoString added in v1.28.0 

func (s DeleteConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConflictException) Message added in v1.28.0 

func (s *DeleteConflictException) Message() string

Message returns the exception's message.

func (*DeleteConflictException) OrigErr added in v1.28.0 

func (s *DeleteConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeleteConflictException) RequestID added in v1.28.0 

func (s *DeleteConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeleteConflictException) StatusCode added in v1.28.0 

func (s *DeleteConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DeleteConflictException) String added in v1.28.0 

func (s DeleteConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCustomMetricInput added in v1.36.9 

type DeleteCustomMetricInput struct {

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

func (DeleteCustomMetricInput) GoString added in v1.36.9 

func (s DeleteCustomMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomMetricInput) SetMetricName added in v1.36.9 

func (s *DeleteCustomMetricInput) SetMetricName(v string) *DeleteCustomMetricInput

SetMetricName sets the MetricName field's value.

func (DeleteCustomMetricInput) String added in v1.36.9 

func (s DeleteCustomMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomMetricInput) Validate added in v1.36.9 

func (s *DeleteCustomMetricInput) Validate() error

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

type DeleteCustomMetricOutput added in v1.36.9 

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

func (DeleteCustomMetricOutput) GoString added in v1.36.9 

func (s DeleteCustomMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCustomMetricOutput) String added in v1.36.9 

func (s DeleteCustomMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDimensionInput added in v1.30.2 

type DeleteDimensionInput struct {

	// The unique identifier for the dimension that you want to delete.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDimensionInput) GoString added in v1.30.2 

func (s DeleteDimensionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDimensionInput) SetName added in v1.30.2 

func (s *DeleteDimensionInput) SetName(v string) *DeleteDimensionInput

SetName sets the Name field's value.

func (DeleteDimensionInput) String added in v1.30.2 

func (s DeleteDimensionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDimensionInput) Validate added in v1.30.2 

func (s *DeleteDimensionInput) Validate() error

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

type DeleteDimensionOutput added in v1.30.2 

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

func (DeleteDimensionOutput) GoString added in v1.30.2 

func (s DeleteDimensionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDimensionOutput) String added in v1.30.2 

func (s DeleteDimensionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDomainConfigurationInput added in v1.25.42 

type DeleteDomainConfigurationInput struct {

	// The name of the domain configuration to be deleted.
	//
	// DomainConfigurationName is a required field
	DomainConfigurationName *string `location:"uri" locationName:"domainConfigurationName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainConfigurationInput) GoString added in v1.25.42 

func (s DeleteDomainConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainConfigurationInput) SetDomainConfigurationName added in v1.25.42 

func (s *DeleteDomainConfigurationInput) SetDomainConfigurationName(v string) *DeleteDomainConfigurationInput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (DeleteDomainConfigurationInput) String added in v1.25.42 

func (s DeleteDomainConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainConfigurationInput) Validate added in v1.25.42 

func (s *DeleteDomainConfigurationInput) Validate() error

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

type DeleteDomainConfigurationOutput added in v1.25.42 

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

func (DeleteDomainConfigurationOutput) GoString added in v1.25.42 

func (s DeleteDomainConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDomainConfigurationOutput) String added in v1.25.42 

func (s DeleteDomainConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDynamicThingGroupInput added in v1.15.79 

type DeleteDynamicThingGroupInput struct {

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

	// The name of the dynamic 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 (DeleteDynamicThingGroupInput) GoString added in v1.15.79 

func (s DeleteDynamicThingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDynamicThingGroupInput) SetExpectedVersion added in v1.15.79 

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*DeleteDynamicThingGroupInput) SetThingGroupName added in v1.15.79 

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

SetThingGroupName sets the ThingGroupName field's value.

func (DeleteDynamicThingGroupInput) String added in v1.15.79 

func (s DeleteDynamicThingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDynamicThingGroupInput) Validate added in v1.15.79 

func (s *DeleteDynamicThingGroupInput) Validate() error

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

type DeleteDynamicThingGroupOutput added in v1.15.79 

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

func (DeleteDynamicThingGroupOutput) GoString added in v1.15.79 

func (s DeleteDynamicThingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDynamicThingGroupOutput) String added in v1.15.79 

func (s DeleteDynamicThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFleetMetricInput added in v1.40.34 

type DeleteFleetMetricInput struct {

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

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

func (DeleteFleetMetricInput) GoString added in v1.40.34 

func (s DeleteFleetMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFleetMetricInput) SetExpectedVersion added in v1.40.34 

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*DeleteFleetMetricInput) SetMetricName added in v1.40.34 

func (s *DeleteFleetMetricInput) SetMetricName(v string) *DeleteFleetMetricInput

SetMetricName sets the MetricName field's value.

func (DeleteFleetMetricInput) String added in v1.40.34 

func (s DeleteFleetMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFleetMetricInput) Validate added in v1.40.34 

func (s *DeleteFleetMetricInput) Validate() error

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

type DeleteFleetMetricOutput added in v1.40.34 

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

func (DeleteFleetMetricOutput) GoString added in v1.40.34 

func (s DeleteFleetMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFleetMetricOutput) String added in v1.40.34 

func (s DeleteFleetMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetForce sets the Force field's value.

func (*DeleteJobExecutionInput) SetJobId added in v1.13.52 

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

SetJobId sets the JobId field's value.

func (*DeleteJobExecutionInput) SetNamespaceId added in v1.35.17 

func (s *DeleteJobExecutionInput) SetNamespaceId(v string) *DeleteJobExecutionInput

SetNamespaceId sets the NamespaceId field's value.

func (*DeleteJobExecutionInput) SetThingName added in v1.13.52 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteJobExecutionOutput) String added in v1.13.52 

func (s DeleteJobExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteJobInput) GoString added in v1.13.52 

func (s DeleteJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetNamespaceId added in v1.35.17 

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

SetNamespaceId sets the NamespaceId field's value.

func (DeleteJobInput) String added in v1.13.52 

func (s DeleteJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteJobOutput) String added in v1.13.52 

func (s DeleteJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteJobTemplateInput added in v1.38.47 

type DeleteJobTemplateInput struct {

	// The unique identifier of the job template to delete.
	//
	// JobTemplateId is a required field
	JobTemplateId *string `location:"uri" locationName:"jobTemplateId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJobTemplateInput) GoString added in v1.38.47 

func (s DeleteJobTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJobTemplateInput) SetJobTemplateId added in v1.38.47 

func (s *DeleteJobTemplateInput) SetJobTemplateId(v string) *DeleteJobTemplateInput

SetJobTemplateId sets the JobTemplateId field's value.

func (DeleteJobTemplateInput) String added in v1.38.47 

func (s DeleteJobTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJobTemplateInput) Validate added in v1.38.47 

func (s *DeleteJobTemplateInput) Validate() error

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

type DeleteJobTemplateOutput added in v1.38.47 

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

func (DeleteJobTemplateOutput) GoString added in v1.38.47 

func (s DeleteJobTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteJobTemplateOutput) String added in v1.38.47 

func (s DeleteJobTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMitigationActionInput added in v1.21.10 

type DeleteMitigationActionInput struct {

	// The name of the mitigation action that you want to delete.
	//
	// ActionName is a required field
	ActionName *string `location:"uri" locationName:"actionName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMitigationActionInput) GoString added in v1.21.10 

func (s DeleteMitigationActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMitigationActionInput) SetActionName added in v1.21.10 

func (s *DeleteMitigationActionInput) SetActionName(v string) *DeleteMitigationActionInput

SetActionName sets the ActionName field's value.

func (DeleteMitigationActionInput) String added in v1.21.10 

func (s DeleteMitigationActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMitigationActionInput) Validate added in v1.21.10 

func (s *DeleteMitigationActionInput) Validate() error

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

type DeleteMitigationActionOutput added in v1.21.10 

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

func (DeleteMitigationActionOutput) GoString added in v1.21.10 

func (s DeleteMitigationActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMitigationActionOutput) String added in v1.21.10 

func (s DeleteMitigationActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteOTAUpdateInput added in v1.12.51 

type DeleteOTAUpdateInput struct {

	// When true, the stream created by the OTAUpdate process is deleted when the
	// OTA update is deleted. Ignored if the stream specified in the OTAUpdate is
	// supplied by the user.
	DeleteStream *bool `location:"querystring" locationName:"deleteStream" type:"boolean"`

	// When true, deletes the IoT job created by the OTAUpdate process even if it
	// is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED"
	// or "CANCELED") an exception will occur. The default is false.
	ForceDeleteAWSJob *bool `location:"querystring" locationName:"forceDeleteAWSJob" type:"boolean"`

	// The ID of the OTA update 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOTAUpdateInput) SetDeleteStream added in v1.15.22 

func (s *DeleteOTAUpdateInput) SetDeleteStream(v bool) *DeleteOTAUpdateInput

SetDeleteStream sets the DeleteStream field's value.

func (*DeleteOTAUpdateInput) SetForceDeleteAWSJob added in v1.15.22 

func (s *DeleteOTAUpdateInput) SetForceDeleteAWSJob(v bool) *DeleteOTAUpdateInput

SetForceDeleteAWSJob sets the ForceDeleteAWSJob field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteOTAUpdateOutput) String added in v1.12.51 

func (s DeleteOTAUpdateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePolicyOutput) String 

func (s DeletePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePolicyVersionInput) SetPolicyName added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePolicyVersionOutput) String 

func (s DeletePolicyVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProvisioningTemplateInput added in v1.25.42 

type DeleteProvisioningTemplateInput struct {

	// The name of the fleet provision template to delete.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProvisioningTemplateInput) GoString added in v1.25.42 

func (s DeleteProvisioningTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProvisioningTemplateInput) SetTemplateName added in v1.25.42 

func (s *DeleteProvisioningTemplateInput) SetTemplateName(v string) *DeleteProvisioningTemplateInput

SetTemplateName sets the TemplateName field's value.

func (DeleteProvisioningTemplateInput) String added in v1.25.42 

func (s DeleteProvisioningTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProvisioningTemplateInput) Validate added in v1.25.42 

func (s *DeleteProvisioningTemplateInput) Validate() error

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

type DeleteProvisioningTemplateOutput added in v1.25.42 

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

func (DeleteProvisioningTemplateOutput) GoString added in v1.25.42 

func (s DeleteProvisioningTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteProvisioningTemplateOutput) String added in v1.25.42 

func (s DeleteProvisioningTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProvisioningTemplateVersionInput added in v1.25.42 

type DeleteProvisioningTemplateVersionInput struct {

	// The name of the fleet provisioning template version to delete.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`

	// The fleet provisioning template version ID to delete.
	//
	// VersionId is a required field
	VersionId *int64 `location:"uri" locationName:"versionId" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProvisioningTemplateVersionInput) GoString added in v1.25.42 

func (s DeleteProvisioningTemplateVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProvisioningTemplateVersionInput) SetTemplateName added in v1.25.42 

func (s *DeleteProvisioningTemplateVersionInput) SetTemplateName(v string) *DeleteProvisioningTemplateVersionInput

SetTemplateName sets the TemplateName field's value.

func (*DeleteProvisioningTemplateVersionInput) SetVersionId added in v1.25.42 

func (s *DeleteProvisioningTemplateVersionInput) SetVersionId(v int64) *DeleteProvisioningTemplateVersionInput

SetVersionId sets the VersionId field's value.

func (DeleteProvisioningTemplateVersionInput) String added in v1.25.42 

func (s DeleteProvisioningTemplateVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProvisioningTemplateVersionInput) Validate added in v1.25.42 

func (s *DeleteProvisioningTemplateVersionInput) Validate() error

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

type DeleteProvisioningTemplateVersionOutput added in v1.25.42 

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

func (DeleteProvisioningTemplateVersionOutput) GoString added in v1.25.42 

func (s DeleteProvisioningTemplateVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteProvisioningTemplateVersionOutput) String added in v1.25.42 

func (s DeleteProvisioningTemplateVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRegistrationCodeInput) String added in v1.1.18 

func (s DeleteRegistrationCodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRegistrationCodeOutput) String added in v1.1.18 

func (s DeleteRegistrationCodeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRoleAliasOutput) String added in v1.12.36 

func (s DeleteRoleAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScheduledAuditInput added in v1.15.2 

type DeleteScheduledAuditInput struct {

	// The name of the scheduled audit you want to delete.
	//
	// ScheduledAuditName is a required field
	ScheduledAuditName *string `location:"uri" locationName:"scheduledAuditName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteScheduledAuditInput) GoString added in v1.15.2 

func (s DeleteScheduledAuditInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledAuditInput) SetScheduledAuditName added in v1.15.2 

func (s *DeleteScheduledAuditInput) SetScheduledAuditName(v string) *DeleteScheduledAuditInput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (DeleteScheduledAuditInput) String added in v1.15.2 

func (s DeleteScheduledAuditInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledAuditInput) Validate added in v1.15.2 

func (s *DeleteScheduledAuditInput) Validate() error

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

type DeleteScheduledAuditOutput added in v1.15.2 

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

func (DeleteScheduledAuditOutput) GoString added in v1.15.2 

func (s DeleteScheduledAuditOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScheduledAuditOutput) String added in v1.15.2 

func (s DeleteScheduledAuditOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSecurityProfileInput added in v1.15.2 

type DeleteSecurityProfileInput struct {

	// The expected version of the security profile. A new version is generated
	// whenever the security profile is updated. If you specify a value that is
	// different from the actual version, a VersionConflictException is thrown.
	ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"`

	// The name of the security profile to be deleted.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSecurityProfileInput) GoString added in v1.15.2 

func (s DeleteSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSecurityProfileInput) SetExpectedVersion added in v1.15.2 

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

SetExpectedVersion sets the ExpectedVersion field's value.

func (*DeleteSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *DeleteSecurityProfileInput) SetSecurityProfileName(v string) *DeleteSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (DeleteSecurityProfileInput) String added in v1.15.2 

func (s DeleteSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSecurityProfileInput) Validate added in v1.15.2 

func (s *DeleteSecurityProfileInput) Validate() error

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

type DeleteSecurityProfileOutput added in v1.15.2 

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

func (DeleteSecurityProfileOutput) GoString added in v1.15.2 

func (s DeleteSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSecurityProfileOutput) String added in v1.15.2 

func (s DeleteSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStreamOutput) String added in v1.12.51 

func (s DeleteStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThingGroupOutput) String added in v1.12.36 

func (s DeleteThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThingOutput) String 

func (s DeleteThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThingTypeOutput) String added in v1.2.8 

func (s DeleteThingTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTopicRuleDestinationInput added in v1.25.38 

type DeleteTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination to delete.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTopicRuleDestinationInput) GoString added in v1.25.38 

func (s DeleteTopicRuleDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTopicRuleDestinationInput) SetArn added in v1.25.38 

func (s *DeleteTopicRuleDestinationInput) SetArn(v string) *DeleteTopicRuleDestinationInput

SetArn sets the Arn field's value.

func (DeleteTopicRuleDestinationInput) String added in v1.25.38 

func (s DeleteTopicRuleDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTopicRuleDestinationInput) Validate added in v1.25.38 

func (s *DeleteTopicRuleDestinationInput) Validate() error

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

type DeleteTopicRuleDestinationOutput added in v1.25.38 

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

func (DeleteTopicRuleDestinationOutput) GoString added in v1.25.38 

func (s DeleteTopicRuleDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTopicRuleDestinationOutput) String added in v1.25.38 

func (s DeleteTopicRuleDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTopicRuleInput) SetRuleName added in v1.5.0 

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

SetRuleName sets the RuleName field's value.

func (DeleteTopicRuleInput) String 

func (s DeleteTopicRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTopicRuleOutput) String 

func (s DeleteTopicRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteV2LoggingLevelInput) SetTargetName added in v1.12.36 

func (s *DeleteV2LoggingLevelInput) SetTargetName(v string) *DeleteV2LoggingLevelInput

SetTargetName sets the TargetName field's value.

func (*DeleteV2LoggingLevelInput) SetTargetType added in v1.12.36 

func (s *DeleteV2LoggingLevelInput) SetTargetType(v string) *DeleteV2LoggingLevelInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteV2LoggingLevelOutput) String added in v1.12.36 

func (s DeleteV2LoggingLevelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeprecateThingTypeOutput) String added in v1.2.8 

func (s DeprecateThingTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountAuditConfigurationInput added in v1.15.2 

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

func (DescribeAccountAuditConfigurationInput) GoString added in v1.15.2 

func (s DescribeAccountAuditConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAccountAuditConfigurationInput) String added in v1.15.2 

func (s DescribeAccountAuditConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountAuditConfigurationOutput added in v1.15.2 

type DescribeAccountAuditConfigurationOutput struct {

	// Which audit checks are enabled and disabled for this account.
	AuditCheckConfigurations map[string]*AuditCheckConfiguration `locationName:"auditCheckConfigurations" type:"map"`

	// Information about the targets to which audit notifications are sent for this
	// account.
	AuditNotificationTargetConfigurations map[string]*AuditNotificationTarget `locationName:"auditNotificationTargetConfigurations" type:"map"`

	// The ARN of the role that grants permission to IoT to access information about
	// your devices, policies, certificates, and other items as required when performing
	// an audit.
	//
	// On the first call to UpdateAccountAuditConfiguration, this parameter is required.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountAuditConfigurationOutput) GoString added in v1.15.2 

func (s DescribeAccountAuditConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountAuditConfigurationOutput) SetAuditCheckConfigurations added in v1.15.2 

func (s *DescribeAccountAuditConfigurationOutput) SetAuditCheckConfigurations(v map[string]*AuditCheckConfiguration) *DescribeAccountAuditConfigurationOutput

SetAuditCheckConfigurations sets the AuditCheckConfigurations field's value.

func (*DescribeAccountAuditConfigurationOutput) SetAuditNotificationTargetConfigurations added in v1.15.2 

func (s *DescribeAccountAuditConfigurationOutput) SetAuditNotificationTargetConfigurations(v map[string]*AuditNotificationTarget) *DescribeAccountAuditConfigurationOutput

SetAuditNotificationTargetConfigurations sets the AuditNotificationTargetConfigurations field's value.

func (*DescribeAccountAuditConfigurationOutput) SetRoleArn added in v1.15.2 

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

SetRoleArn sets the RoleArn field's value.

func (DescribeAccountAuditConfigurationOutput) String added in v1.15.2 

func (s DescribeAccountAuditConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAuditFindingInput added in v1.21.10 

type DescribeAuditFindingInput struct {

	// A unique identifier for a single audit finding. You can use this identifier
	// to apply mitigation actions to the finding.
	//
	// FindingId is a required field
	FindingId *string `location:"uri" locationName:"findingId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAuditFindingInput) GoString added in v1.21.10 

func (s DescribeAuditFindingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditFindingInput) SetFindingId added in v1.21.10 

func (s *DescribeAuditFindingInput) SetFindingId(v string) *DescribeAuditFindingInput

SetFindingId sets the FindingId field's value.

func (DescribeAuditFindingInput) String added in v1.21.10 

func (s DescribeAuditFindingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditFindingInput) Validate added in v1.21.10 

func (s *DescribeAuditFindingInput) Validate() error

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

type DescribeAuditFindingOutput added in v1.21.10 

type DescribeAuditFindingOutput struct {

	// The findings (results) of the audit.
	Finding *AuditFinding `locationName:"finding" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAuditFindingOutput) GoString added in v1.21.10 

func (s DescribeAuditFindingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditFindingOutput) SetFinding added in v1.21.10 

func (s *DescribeAuditFindingOutput) SetFinding(v *AuditFinding) *DescribeAuditFindingOutput

SetFinding sets the Finding field's value.

func (DescribeAuditFindingOutput) String added in v1.21.10 

func (s DescribeAuditFindingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAuditMitigationActionsTaskInput added in v1.21.10 

type DescribeAuditMitigationActionsTaskInput struct {

	// The unique identifier for the audit mitigation task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAuditMitigationActionsTaskInput) GoString added in v1.21.10 

func (s DescribeAuditMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditMitigationActionsTaskInput) SetTaskId added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskInput) SetTaskId(v string) *DescribeAuditMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (DescribeAuditMitigationActionsTaskInput) String added in v1.21.10 

func (s DescribeAuditMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditMitigationActionsTaskInput) Validate added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskInput) Validate() error

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

type DescribeAuditMitigationActionsTaskOutput added in v1.21.10 

type DescribeAuditMitigationActionsTaskOutput struct {

	// Specifies the mitigation actions and their parameters that are applied as
	// part of this task.
	ActionsDefinition []*MitigationAction `locationName:"actionsDefinition" type:"list"`

	// Specifies the mitigation actions that should be applied to specific audit
	// checks.
	AuditCheckToActionsMapping map[string][]*string `locationName:"auditCheckToActionsMapping" type:"map"`

	// The date and time when the task was completed or canceled.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The date and time when the task was started.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// Identifies the findings to which the mitigation actions are applied. This
	// can be by audit checks, by audit task, or a set of findings.
	Target *AuditMitigationActionsTaskTarget `locationName:"target" type:"structure"`

	// Aggregate counts of the results when the mitigation tasks were applied to
	// the findings for this audit mitigation actions task.
	TaskStatistics map[string]*TaskStatisticsForAuditCheck `locationName:"taskStatistics" type:"map"`

	// The current status of the task.
	TaskStatus *string `locationName:"taskStatus" type:"string" enum:"AuditMitigationActionsTaskStatus"`
	// contains filtered or unexported fields
}

func (DescribeAuditMitigationActionsTaskOutput) GoString added in v1.21.10 

func (s DescribeAuditMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditMitigationActionsTaskOutput) SetActionsDefinition added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetActionsDefinition(v []*MitigationAction) *DescribeAuditMitigationActionsTaskOutput

SetActionsDefinition sets the ActionsDefinition field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetAuditCheckToActionsMapping added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetAuditCheckToActionsMapping(v map[string][]*string) *DescribeAuditMitigationActionsTaskOutput

SetAuditCheckToActionsMapping sets the AuditCheckToActionsMapping field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetEndTime added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetEndTime(v time.Time) *DescribeAuditMitigationActionsTaskOutput

SetEndTime sets the EndTime field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetStartTime added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetStartTime(v time.Time) *DescribeAuditMitigationActionsTaskOutput

SetStartTime sets the StartTime field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetTarget added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetTarget(v *AuditMitigationActionsTaskTarget) *DescribeAuditMitigationActionsTaskOutput

SetTarget sets the Target field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetTaskStatistics added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetTaskStatistics(v map[string]*TaskStatisticsForAuditCheck) *DescribeAuditMitigationActionsTaskOutput

SetTaskStatistics sets the TaskStatistics field's value.

func (*DescribeAuditMitigationActionsTaskOutput) SetTaskStatus added in v1.21.10 

func (s *DescribeAuditMitigationActionsTaskOutput) SetTaskStatus(v string) *DescribeAuditMitigationActionsTaskOutput

SetTaskStatus sets the TaskStatus field's value.

func (DescribeAuditMitigationActionsTaskOutput) String added in v1.21.10 

func (s DescribeAuditMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAuditSuppressionInput added in v1.34.3 

type DescribeAuditSuppressionInput struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// CheckName is a required field
	CheckName *string `locationName:"checkName" type:"string" required:"true"`

	// Information that identifies the noncompliant resource.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAuditSuppressionInput) GoString added in v1.34.3 

func (s DescribeAuditSuppressionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditSuppressionInput) SetCheckName added in v1.34.3 

func (s *DescribeAuditSuppressionInput) SetCheckName(v string) *DescribeAuditSuppressionInput

SetCheckName sets the CheckName field's value.

func (*DescribeAuditSuppressionInput) SetResourceIdentifier added in v1.34.3 

func (s *DescribeAuditSuppressionInput) SetResourceIdentifier(v *ResourceIdentifier) *DescribeAuditSuppressionInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DescribeAuditSuppressionInput) String added in v1.34.3 

func (s DescribeAuditSuppressionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditSuppressionInput) Validate added in v1.34.3 

func (s *DescribeAuditSuppressionInput) Validate() error

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

type DescribeAuditSuppressionOutput added in v1.34.3 

type DescribeAuditSuppressionOutput struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	CheckName *string `locationName:"checkName" type:"string"`

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

	// The epoch timestamp in seconds at which this suppression expires.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"`

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure"`

	// Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool `locationName:"suppressIndefinitely" type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeAuditSuppressionOutput) GoString added in v1.34.3 

func (s DescribeAuditSuppressionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditSuppressionOutput) SetCheckName added in v1.34.3 

func (s *DescribeAuditSuppressionOutput) SetCheckName(v string) *DescribeAuditSuppressionOutput

SetCheckName sets the CheckName field's value.

func (*DescribeAuditSuppressionOutput) SetDescription added in v1.34.3 

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

SetDescription sets the Description field's value.

func (*DescribeAuditSuppressionOutput) SetExpirationDate added in v1.34.3 

func (s *DescribeAuditSuppressionOutput) SetExpirationDate(v time.Time) *DescribeAuditSuppressionOutput

SetExpirationDate sets the ExpirationDate field's value.

func (*DescribeAuditSuppressionOutput) SetResourceIdentifier added in v1.34.3 

func (s *DescribeAuditSuppressionOutput) SetResourceIdentifier(v *ResourceIdentifier) *DescribeAuditSuppressionOutput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*DescribeAuditSuppressionOutput) SetSuppressIndefinitely added in v1.34.3 

func (s *DescribeAuditSuppressionOutput) SetSuppressIndefinitely(v bool) *DescribeAuditSuppressionOutput

SetSuppressIndefinitely sets the SuppressIndefinitely field's value.

func (DescribeAuditSuppressionOutput) String added in v1.34.3 

func (s DescribeAuditSuppressionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAuditTaskInput added in v1.15.2 

type DescribeAuditTaskInput struct {

	// The ID of the audit whose information you want to get.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAuditTaskInput) GoString added in v1.15.2 

func (s DescribeAuditTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditTaskInput) SetTaskId added in v1.15.2 

func (s *DescribeAuditTaskInput) SetTaskId(v string) *DescribeAuditTaskInput

SetTaskId sets the TaskId field's value.

func (DescribeAuditTaskInput) String added in v1.15.2 

func (s DescribeAuditTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditTaskInput) Validate added in v1.15.2 

func (s *DescribeAuditTaskInput) Validate() error

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

type DescribeAuditTaskOutput added in v1.15.2 

type DescribeAuditTaskOutput struct {

	// Detailed information about each check performed during this audit.
	AuditDetails map[string]*AuditCheckDetails `locationName:"auditDetails" type:"map"`

	// The name of the scheduled audit (only if the audit was a scheduled audit).
	ScheduledAuditName *string `locationName:"scheduledAuditName" min:"1" type:"string"`

	// The time the audit started.
	TaskStartTime *time.Time `locationName:"taskStartTime" type:"timestamp"`

	// Statistical information about the audit.
	TaskStatistics *TaskStatistics `locationName:"taskStatistics" type:"structure"`

	// The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or
	// "CANCELED".
	TaskStatus *string `locationName:"taskStatus" type:"string" enum:"AuditTaskStatus"`

	// The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
	TaskType *string `locationName:"taskType" type:"string" enum:"AuditTaskType"`
	// contains filtered or unexported fields
}

func (DescribeAuditTaskOutput) GoString added in v1.15.2 

func (s DescribeAuditTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuditTaskOutput) SetAuditDetails added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetAuditDetails(v map[string]*AuditCheckDetails) *DescribeAuditTaskOutput

SetAuditDetails sets the AuditDetails field's value.

func (*DescribeAuditTaskOutput) SetScheduledAuditName added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetScheduledAuditName(v string) *DescribeAuditTaskOutput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (*DescribeAuditTaskOutput) SetTaskStartTime added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetTaskStartTime(v time.Time) *DescribeAuditTaskOutput

SetTaskStartTime sets the TaskStartTime field's value.

func (*DescribeAuditTaskOutput) SetTaskStatistics added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetTaskStatistics(v *TaskStatistics) *DescribeAuditTaskOutput

SetTaskStatistics sets the TaskStatistics field's value.

func (*DescribeAuditTaskOutput) SetTaskStatus added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetTaskStatus(v string) *DescribeAuditTaskOutput

SetTaskStatus sets the TaskStatus field's value.

func (*DescribeAuditTaskOutput) SetTaskType added in v1.15.2 

func (s *DescribeAuditTaskOutput) SetTaskType(v string) *DescribeAuditTaskOutput

SetTaskType sets the TaskType field's value.

func (DescribeAuditTaskOutput) String added in v1.15.2 

func (s DescribeAuditTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAuthorizerOutput) SetAuthorizerDescription added in v1.12.36 

func (s *DescribeAuthorizerOutput) SetAuthorizerDescription(v *AuthorizerDescription) *DescribeAuthorizerOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBillingGroupInput added in v1.15.79 

type DescribeBillingGroupInput struct {

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

func (DescribeBillingGroupInput) GoString added in v1.15.79 

func (s DescribeBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *DescribeBillingGroupInput) SetBillingGroupName(v string) *DescribeBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (DescribeBillingGroupInput) String added in v1.15.79 

func (s DescribeBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBillingGroupInput) Validate added in v1.15.79 

func (s *DescribeBillingGroupInput) Validate() error

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

type DescribeBillingGroupOutput added in v1.15.79 

type DescribeBillingGroupOutput struct {

	// The ARN of the billing group.
	BillingGroupArn *string `locationName:"billingGroupArn" type:"string"`

	// The ID of the billing group.
	BillingGroupId *string `locationName:"billingGroupId" min:"1" type:"string"`

	// Additional information about the billing group.
	BillingGroupMetadata *BillingGroupMetadata `locationName:"billingGroupMetadata" type:"structure"`

	// The name of the billing group.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`

	// The properties of the billing group.
	BillingGroupProperties *BillingGroupProperties `locationName:"billingGroupProperties" type:"structure"`

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

func (DescribeBillingGroupOutput) GoString added in v1.15.79 

func (s DescribeBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBillingGroupOutput) SetBillingGroupArn added in v1.15.79 

func (s *DescribeBillingGroupOutput) SetBillingGroupArn(v string) *DescribeBillingGroupOutput

SetBillingGroupArn sets the BillingGroupArn field's value.

func (*DescribeBillingGroupOutput) SetBillingGroupId added in v1.15.79 

func (s *DescribeBillingGroupOutput) SetBillingGroupId(v string) *DescribeBillingGroupOutput

SetBillingGroupId sets the BillingGroupId field's value.

func (*DescribeBillingGroupOutput) SetBillingGroupMetadata added in v1.15.79 

func (s *DescribeBillingGroupOutput) SetBillingGroupMetadata(v *BillingGroupMetadata) *DescribeBillingGroupOutput

SetBillingGroupMetadata sets the BillingGroupMetadata field's value.

func (*DescribeBillingGroupOutput) SetBillingGroupName added in v1.15.79 

func (s *DescribeBillingGroupOutput) SetBillingGroupName(v string) *DescribeBillingGroupOutput

SetBillingGroupName sets the BillingGroupName field's value.

func (*DescribeBillingGroupOutput) SetBillingGroupProperties added in v1.15.79 

func (s *DescribeBillingGroupOutput) SetBillingGroupProperties(v *BillingGroupProperties) *DescribeBillingGroupOutput

SetBillingGroupProperties sets the BillingGroupProperties field's value.

func (*DescribeBillingGroupOutput) SetVersion added in v1.15.79 

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

SetVersion sets the Version field's value.

func (DescribeBillingGroupOutput) String added in v1.15.79 

func (s DescribeBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCACertificateInput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (DescribeCACertificateInput) String added in v1.1.18 

func (s DescribeCACertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCACertificateOutput) SetCertificateDescription added in v1.5.0 

func (s *DescribeCACertificateOutput) SetCertificateDescription(v *CACertificateDescription) *DescribeCACertificateOutput

SetCertificateDescription sets the CertificateDescription field's value.

func (*DescribeCACertificateOutput) SetRegistrationConfig added in v1.12.36 

func (s *DescribeCACertificateOutput) SetRegistrationConfig(v *RegistrationConfig) *DescribeCACertificateOutput

SetRegistrationConfig sets the RegistrationConfig field's value.

func (DescribeCACertificateOutput) String added in v1.1.18 

func (s DescribeCACertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificateInput) SetCertificateId added in v1.5.0 

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

SetCertificateId sets the CertificateId field's value.

func (DescribeCertificateInput) String 

func (s DescribeCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificateOutput) SetCertificateDescription added in v1.5.0 

func (s *DescribeCertificateOutput) SetCertificateDescription(v *CertificateDescription) *DescribeCertificateOutput

SetCertificateDescription sets the CertificateDescription field's value.

func (DescribeCertificateOutput) String 

func (s DescribeCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCustomMetricInput added in v1.36.9 

type DescribeCustomMetricInput struct {

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

func (DescribeCustomMetricInput) GoString added in v1.36.9 

func (s DescribeCustomMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCustomMetricInput) SetMetricName added in v1.36.9 

func (s *DescribeCustomMetricInput) SetMetricName(v string) *DescribeCustomMetricInput

SetMetricName sets the MetricName field's value.

func (DescribeCustomMetricInput) String added in v1.36.9 

func (s DescribeCustomMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCustomMetricInput) Validate added in v1.36.9 

func (s *DescribeCustomMetricInput) Validate() error

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

type DescribeCustomMetricOutput added in v1.36.9 

type DescribeCustomMetricOutput struct {

	// The creation date of the custom metric in milliseconds since epoch.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// Field represents a friendly name in the console for the custom metric; doesn't
	// have to be unique. Don't use this name as the metric identifier in the device
	// metric report. Can be updated.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The time the custom metric was last modified in milliseconds since epoch.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The Amazon Resource Number (ARN) of the custom metric.
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The name of the custom metric.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`

	// The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but while submitting
	// the metrics value in the DeviceMetrics report, it must be passed as an array
	// with a single value.
	MetricType *string `locationName:"metricType" type:"string" enum:"CustomMetricType"`
	// contains filtered or unexported fields
}

func (DescribeCustomMetricOutput) GoString added in v1.36.9 

func (s DescribeCustomMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCustomMetricOutput) SetCreationDate added in v1.36.9 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeCustomMetricOutput) SetDisplayName added in v1.36.9 

func (s *DescribeCustomMetricOutput) SetDisplayName(v string) *DescribeCustomMetricOutput

SetDisplayName sets the DisplayName field's value.

func (*DescribeCustomMetricOutput) SetLastModifiedDate added in v1.36.9 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeCustomMetricOutput) SetMetricArn added in v1.36.9 

func (s *DescribeCustomMetricOutput) SetMetricArn(v string) *DescribeCustomMetricOutput

SetMetricArn sets the MetricArn field's value.

func (*DescribeCustomMetricOutput) SetMetricName added in v1.36.9 

func (s *DescribeCustomMetricOutput) SetMetricName(v string) *DescribeCustomMetricOutput

SetMetricName sets the MetricName field's value.

func (*DescribeCustomMetricOutput) SetMetricType added in v1.36.9 

func (s *DescribeCustomMetricOutput) SetMetricType(v string) *DescribeCustomMetricOutput

SetMetricType sets the MetricType field's value.

func (DescribeCustomMetricOutput) String added in v1.36.9 

func (s DescribeCustomMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDefaultAuthorizerInput added in v1.12.36 

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

func (DescribeDefaultAuthorizerInput) GoString added in v1.12.36 

func (s DescribeDefaultAuthorizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeDefaultAuthorizerInput) String added in v1.12.36 

func (s DescribeDefaultAuthorizerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DescribeDefaultAuthorizerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDefaultAuthorizerOutput) SetAuthorizerDescription added in v1.12.36 

func (s *DescribeDefaultAuthorizerOutput) SetAuthorizerDescription(v *AuthorizerDescription) *DescribeDefaultAuthorizerOutput

SetAuthorizerDescription sets the AuthorizerDescription field's value.

func (DescribeDefaultAuthorizerOutput) String added in v1.12.36 

func (s DescribeDefaultAuthorizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDetectMitigationActionsTaskInput added in v1.36.9 

type DescribeDetectMitigationActionsTaskInput struct {

	// The unique identifier of the task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDetectMitigationActionsTaskInput) GoString added in v1.36.9 

func (s DescribeDetectMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectMitigationActionsTaskInput) SetTaskId added in v1.36.9 

func (s *DescribeDetectMitigationActionsTaskInput) SetTaskId(v string) *DescribeDetectMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (DescribeDetectMitigationActionsTaskInput) String added in v1.36.9 

func (s DescribeDetectMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectMitigationActionsTaskInput) Validate added in v1.36.9 

func (s *DescribeDetectMitigationActionsTaskInput) Validate() error

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

type DescribeDetectMitigationActionsTaskOutput added in v1.36.9 

type DescribeDetectMitigationActionsTaskOutput struct {

	// The description of a task.
	TaskSummary *DetectMitigationActionsTaskSummary `locationName:"taskSummary" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDetectMitigationActionsTaskOutput) GoString added in v1.36.9 

func (s DescribeDetectMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectMitigationActionsTaskOutput) SetTaskSummary added in v1.36.9 

func (s *DescribeDetectMitigationActionsTaskOutput) SetTaskSummary(v *DetectMitigationActionsTaskSummary) *DescribeDetectMitigationActionsTaskOutput

SetTaskSummary sets the TaskSummary field's value.

func (DescribeDetectMitigationActionsTaskOutput) String added in v1.36.9 

func (s DescribeDetectMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDimensionInput added in v1.30.2 

type DescribeDimensionInput struct {

	// The unique identifier for the dimension.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDimensionInput) GoString added in v1.30.2 

func (s DescribeDimensionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionInput) SetName added in v1.30.2 

func (s *DescribeDimensionInput) SetName(v string) *DescribeDimensionInput

SetName sets the Name field's value.

func (DescribeDimensionInput) String added in v1.30.2 

func (s DescribeDimensionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionInput) Validate added in v1.30.2 

func (s *DescribeDimensionInput) Validate() error

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

type DescribeDimensionOutput added in v1.30.2 

type DescribeDimensionOutput struct {

	// The Amazon Resource Name (ARN) for the dimension.
	Arn *string `locationName:"arn" type:"string"`

	// The date the dimension was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

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

	// The unique identifier for the dimension.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The value or list of values used to scope the dimension. For example, for
	// topic filters, this is the pattern used to match the MQTT topic name.
	StringValues []*string `locationName:"stringValues" min:"1" type:"list"`

	// The type of the dimension.
	Type *string `locationName:"type" type:"string" enum:"DimensionType"`
	// contains filtered or unexported fields
}

func (DescribeDimensionOutput) GoString added in v1.30.2 

func (s DescribeDimensionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionOutput) SetArn added in v1.30.2 

func (s *DescribeDimensionOutput) SetArn(v string) *DescribeDimensionOutput

SetArn sets the Arn field's value.

func (*DescribeDimensionOutput) SetCreationDate added in v1.30.2 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeDimensionOutput) SetLastModifiedDate added in v1.30.2 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeDimensionOutput) SetName added in v1.30.2 

func (s *DescribeDimensionOutput) SetName(v string) *DescribeDimensionOutput

SetName sets the Name field's value.

func (*DescribeDimensionOutput) SetStringValues added in v1.30.2 

func (s *DescribeDimensionOutput) SetStringValues(v []*string) *DescribeDimensionOutput

SetStringValues sets the StringValues field's value.

func (*DescribeDimensionOutput) SetType added in v1.30.2 

func (s *DescribeDimensionOutput) SetType(v string) *DescribeDimensionOutput

SetType sets the Type field's value.

func (DescribeDimensionOutput) String added in v1.30.2 

func (s DescribeDimensionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainConfigurationInput added in v1.25.42 

type DescribeDomainConfigurationInput struct {

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

func (DescribeDomainConfigurationInput) GoString added in v1.25.42 

func (s DescribeDomainConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigurationInput) SetDomainConfigurationName added in v1.25.42 

func (s *DescribeDomainConfigurationInput) SetDomainConfigurationName(v string) *DescribeDomainConfigurationInput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (DescribeDomainConfigurationInput) String added in v1.25.42 

func (s DescribeDomainConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigurationInput) Validate added in v1.25.42 

func (s *DescribeDomainConfigurationInput) Validate() error

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

type DescribeDomainConfigurationOutput added in v1.25.42 

type DescribeDomainConfigurationOutput struct {

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *AuthorizerConfig `locationName:"authorizerConfig" type:"structure"`

	// The ARN of the domain configuration.
	DomainConfigurationArn *string `locationName:"domainConfigurationArn" type:"string"`

	// The name of the domain configuration.
	DomainConfigurationName *string `locationName:"domainConfigurationName" min:"1" type:"string"`

	// A Boolean value that specifies the current state of the domain configuration.
	DomainConfigurationStatus *string `locationName:"domainConfigurationStatus" type:"string" enum:"DomainConfigurationStatus"`

	// The name of the domain.
	DomainName *string `locationName:"domainName" min:"1" type:"string"`

	// The type of the domain.
	DomainType *string `locationName:"domainType" type:"string" enum:"DomainType"`

	// The date and time the domain configuration's status was last changed.
	LastStatusChangeDate *time.Time `locationName:"lastStatusChangeDate" type:"timestamp"`

	// A list containing summary information about the server certificate included
	// in the domain configuration.
	ServerCertificates []*ServerCertificateSummary `locationName:"serverCertificates" type:"list"`

	// The type of service delivered by the endpoint.
	ServiceType *string `locationName:"serviceType" type:"string" enum:"ServiceType"`
	// contains filtered or unexported fields
}

func (DescribeDomainConfigurationOutput) GoString added in v1.25.42 

func (s DescribeDomainConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigurationOutput) SetAuthorizerConfig added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetAuthorizerConfig(v *AuthorizerConfig) *DescribeDomainConfigurationOutput

SetAuthorizerConfig sets the AuthorizerConfig field's value.

func (*DescribeDomainConfigurationOutput) SetDomainConfigurationArn added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetDomainConfigurationArn(v string) *DescribeDomainConfigurationOutput

SetDomainConfigurationArn sets the DomainConfigurationArn field's value.

func (*DescribeDomainConfigurationOutput) SetDomainConfigurationName added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetDomainConfigurationName(v string) *DescribeDomainConfigurationOutput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (*DescribeDomainConfigurationOutput) SetDomainConfigurationStatus added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetDomainConfigurationStatus(v string) *DescribeDomainConfigurationOutput

SetDomainConfigurationStatus sets the DomainConfigurationStatus field's value.

func (*DescribeDomainConfigurationOutput) SetDomainName added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetDomainName(v string) *DescribeDomainConfigurationOutput

SetDomainName sets the DomainName field's value.

func (*DescribeDomainConfigurationOutput) SetDomainType added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetDomainType(v string) *DescribeDomainConfigurationOutput

SetDomainType sets the DomainType field's value.

func (*DescribeDomainConfigurationOutput) SetLastStatusChangeDate added in v1.35.8 

func (s *DescribeDomainConfigurationOutput) SetLastStatusChangeDate(v time.Time) *DescribeDomainConfigurationOutput

SetLastStatusChangeDate sets the LastStatusChangeDate field's value.

func (*DescribeDomainConfigurationOutput) SetServerCertificates added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetServerCertificates(v []*ServerCertificateSummary) *DescribeDomainConfigurationOutput

SetServerCertificates sets the ServerCertificates field's value.

func (*DescribeDomainConfigurationOutput) SetServiceType added in v1.25.42 

func (s *DescribeDomainConfigurationOutput) SetServiceType(v string) *DescribeDomainConfigurationOutput

SetServiceType sets the ServiceType field's value.

func (DescribeDomainConfigurationOutput) String added in v1.25.42 

func (s DescribeDomainConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEndpointInput 

type DescribeEndpointInput struct {

	// The endpoint type. Valid endpoint types include:
	//
	//    * iot:Data - Returns a VeriSign signed data endpoint.
	//
	//    * iot:Data-ATS - Returns an ATS signed data endpoint.
	//
	//    * iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
	//
	//    * iot:Jobs - Returns an IoT device management Jobs API endpoint.
	//
	// We strongly recommend that customers use the newer iot:Data-ATS endpoint
	// type to avoid issues related to the widespread distrust of Symantec certificate
	// authorities.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventConfigurationsInput added in v1.12.36 

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

func (DescribeEventConfigurationsInput) GoString added in v1.12.36 

func (s DescribeEventConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeEventConfigurationsInput) String added in v1.12.36 

func (s DescribeEventConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventConfigurationsOutput added in v1.12.36 

type DescribeEventConfigurationsOutput struct {

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

	// 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"`
	// contains filtered or unexported fields
}

func (DescribeEventConfigurationsOutput) GoString added in v1.12.36 

func (s DescribeEventConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventConfigurationsOutput) SetCreationDate added in v1.12.36 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeEventConfigurationsOutput) SetEventConfigurations added in v1.12.36 

func (s *DescribeEventConfigurationsOutput) SetEventConfigurations(v map[string]*Configuration) *DescribeEventConfigurationsOutput

SetEventConfigurations sets the EventConfigurations field's value.

func (*DescribeEventConfigurationsOutput) SetLastModifiedDate added in v1.12.36 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (DescribeEventConfigurationsOutput) String added in v1.12.36 

func (s DescribeEventConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFleetMetricInput added in v1.40.34 

type DescribeFleetMetricInput struct {

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

func (DescribeFleetMetricInput) GoString added in v1.40.34 

func (s DescribeFleetMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetMetricInput) SetMetricName added in v1.40.34 

func (s *DescribeFleetMetricInput) SetMetricName(v string) *DescribeFleetMetricInput

SetMetricName sets the MetricName field's value.

func (DescribeFleetMetricInput) String added in v1.40.34 

func (s DescribeFleetMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetMetricInput) Validate added in v1.40.34 

func (s *DescribeFleetMetricInput) Validate() error

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

type DescribeFleetMetricOutput added in v1.40.34 

type DescribeFleetMetricOutput struct {

	// The field to aggregate.
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string"`

	// The type of the aggregation query.
	AggregationType *AggregationType `locationName:"aggregationType" type:"structure"`

	// The date when the fleet metric is created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

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

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

	// The date when the fleet metric is last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The ARN of the fleet metric to describe.
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The name of the fleet metric to describe.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	Period *int64 `locationName:"period" min:"60" type:"integer"`

	// The search query string.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`

	// The query version.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

	// Used to support unit transformation such as milliseconds to seconds. The
	// unit must be supported by CW metric (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html).
	Unit *string `locationName:"unit" type:"string" enum:"FleetMetricUnit"`

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

func (DescribeFleetMetricOutput) GoString added in v1.40.34 

func (s DescribeFleetMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFleetMetricOutput) SetAggregationField added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetAggregationField(v string) *DescribeFleetMetricOutput

SetAggregationField sets the AggregationField field's value.

func (*DescribeFleetMetricOutput) SetAggregationType added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetAggregationType(v *AggregationType) *DescribeFleetMetricOutput

SetAggregationType sets the AggregationType field's value.

func (*DescribeFleetMetricOutput) SetCreationDate added in v1.40.34 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeFleetMetricOutput) SetDescription added in v1.40.34 

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

SetDescription sets the Description field's value.

func (*DescribeFleetMetricOutput) SetIndexName added in v1.40.34 

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

SetIndexName sets the IndexName field's value.

func (*DescribeFleetMetricOutput) SetLastModifiedDate added in v1.40.34 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeFleetMetricOutput) SetMetricArn added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetMetricArn(v string) *DescribeFleetMetricOutput

SetMetricArn sets the MetricArn field's value.

func (*DescribeFleetMetricOutput) SetMetricName added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetMetricName(v string) *DescribeFleetMetricOutput

SetMetricName sets the MetricName field's value.

func (*DescribeFleetMetricOutput) SetPeriod added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetPeriod(v int64) *DescribeFleetMetricOutput

SetPeriod sets the Period field's value.

func (*DescribeFleetMetricOutput) SetQueryString added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetQueryString(v string) *DescribeFleetMetricOutput

SetQueryString sets the QueryString field's value.

func (*DescribeFleetMetricOutput) SetQueryVersion added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetQueryVersion(v string) *DescribeFleetMetricOutput

SetQueryVersion sets the QueryVersion field's value.

func (*DescribeFleetMetricOutput) SetUnit added in v1.40.34 

func (s *DescribeFleetMetricOutput) SetUnit(v string) *DescribeFleetMetricOutput

SetUnit sets the Unit field's value.

func (*DescribeFleetMetricOutput) SetVersion added in v1.40.34 

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

SetVersion sets the Version field's value.

func (DescribeFleetMetricOutput) String added in v1.40.34 

func (s DescribeFleetMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 contains only registry data.
	//
	//    * REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow
	//    data.
	//
	//    * REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry
	//    data and thing connectivity status data.
	//
	//    * REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains
	//    registry data, shadow data, and thing connectivity status data.
	//
	//    * MULTI_INDEXING_MODE - Your thing index contains multiple data sources.
	//    For more information, see GetIndexingConfiguration (https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetJobId sets the JobId field's value.

func (*DescribeJobExecutionInput) SetThingName added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeJobExecutionOutput) SetExecution added in v1.12.36 

func (s *DescribeJobExecutionOutput) SetExecution(v *JobExecution) *DescribeJobExecutionOutput

SetExecution sets the Execution field's value.

func (DescribeJobExecutionOutput) String added in v1.12.36 

func (s DescribeJobExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeJobTemplateInput added in v1.38.47 

type DescribeJobTemplateInput struct {

	// The unique identifier of the job template.
	//
	// JobTemplateId is a required field
	JobTemplateId *string `location:"uri" locationName:"jobTemplateId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeJobTemplateInput) GoString added in v1.38.47 

func (s DescribeJobTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeJobTemplateInput) SetJobTemplateId added in v1.38.47 

func (s *DescribeJobTemplateInput) SetJobTemplateId(v string) *DescribeJobTemplateInput

SetJobTemplateId sets the JobTemplateId field's value.

func (DescribeJobTemplateInput) String added in v1.38.47 

func (s DescribeJobTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeJobTemplateInput) Validate added in v1.38.47 

func (s *DescribeJobTemplateInput) Validate() error

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

type DescribeJobTemplateOutput added in v1.38.47 

type DescribeJobTemplateOutput struct {

	// The criteria that determine when and how a job abort takes place.
	AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"`

	// The time, in seconds since the epoch, when the job template was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

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

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

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

	// The configuration that determines how many retries are allowed for each failure
	// type for a job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig `locationName:"jobExecutionsRetryConfig" type:"structure"`

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

	// The ARN of the job template.
	JobTemplateArn *string `locationName:"jobTemplateArn" min:"1" type:"string"`

	// The unique identifier of the job template.
	JobTemplateId *string `locationName:"jobTemplateId" min:"1" type:"string"`

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

	// Specifies the amount of time each device has to finish its execution of the
	// job. A timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// timer expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeJobTemplateOutput) GoString added in v1.38.47 

func (s DescribeJobTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeJobTemplateOutput) SetAbortConfig added in v1.38.47 

func (s *DescribeJobTemplateOutput) SetAbortConfig(v *AbortConfig) *DescribeJobTemplateOutput

SetAbortConfig sets the AbortConfig field's value.

func (*DescribeJobTemplateOutput) SetCreatedAt added in v1.38.47 

func (s *DescribeJobTemplateOutput) SetCreatedAt(v time.Time) *DescribeJobTemplateOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeJobTemplateOutput) SetDescription added in v1.38.47 

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

SetDescription sets the Description field's value.

func (*DescribeJobTemplateOutput) SetDocument added in v1.38.47 

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

SetDocument sets the Document field's value.

func (*DescribeJobTemplateOutput) SetDocumentSource added in v1.38.47 

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

SetDocumentSource sets the DocumentSource field's value.

func (*DescribeJobTemplateOutput) SetJobExecutionsRetryConfig added in v1.42.28 

func (s *DescribeJobTemplateOutput) SetJobExecutionsRetryConfig(v *JobExecutionsRetryConfig) *DescribeJobTemplateOutput

SetJobExecutionsRetryConfig sets the JobExecutionsRetryConfig field's value.

func (*DescribeJobTemplateOutput) SetJobExecutionsRolloutConfig added in v1.38.47 

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

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*DescribeJobTemplateOutput) SetJobTemplateArn added in v1.38.47 

func (s *DescribeJobTemplateOutput) SetJobTemplateArn(v string) *DescribeJobTemplateOutput

SetJobTemplateArn sets the JobTemplateArn field's value.

func (*DescribeJobTemplateOutput) SetJobTemplateId added in v1.38.47 

func (s *DescribeJobTemplateOutput) SetJobTemplateId(v string) *DescribeJobTemplateOutput

SetJobTemplateId sets the JobTemplateId field's value.

func (*DescribeJobTemplateOutput) SetPresignedUrlConfig added in v1.38.47 

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

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

func (*DescribeJobTemplateOutput) SetTimeoutConfig added in v1.38.47 

func (s *DescribeJobTemplateOutput) SetTimeoutConfig(v *TimeoutConfig) *DescribeJobTemplateOutput

SetTimeoutConfig sets the TimeoutConfig field's value.

func (DescribeJobTemplateOutput) String added in v1.38.47 

func (s DescribeJobTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeManagedJobTemplateInput added in v1.42.11 

type DescribeManagedJobTemplateInput struct {

	// The unique name of a managed job template, which is required.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`

	// An optional parameter to specify version of a managed template. If not specified,
	// the pre-defined default version is returned.
	TemplateVersion *string `location:"querystring" locationName:"templateVersion" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeManagedJobTemplateInput) GoString added in v1.42.11 

func (s DescribeManagedJobTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeManagedJobTemplateInput) SetTemplateName added in v1.42.11 

func (s *DescribeManagedJobTemplateInput) SetTemplateName(v string) *DescribeManagedJobTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DescribeManagedJobTemplateInput) SetTemplateVersion added in v1.42.11 

func (s *DescribeManagedJobTemplateInput) SetTemplateVersion(v string) *DescribeManagedJobTemplateInput

SetTemplateVersion sets the TemplateVersion field's value.

func (DescribeManagedJobTemplateInput) String added in v1.42.11 

func (s DescribeManagedJobTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeManagedJobTemplateInput) Validate added in v1.42.11 

func (s *DescribeManagedJobTemplateInput) Validate() error

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

type DescribeManagedJobTemplateOutput added in v1.42.11 

type DescribeManagedJobTemplateOutput struct {

	// The unique description of a managed template.
	Description *string `locationName:"description" type:"string"`

	// The document schema for a managed job template.
	Document *string `locationName:"document" type:"string"`

	// A map of key-value pairs that you can use as guidance to specify the inputs
	// for creating a job from a managed template.
	//
	// documentParameters can only be used when creating jobs from Amazon Web Services
	// managed templates. This parameter can't be used with custom job templates
	// or to create jobs from them.
	DocumentParameters []*DocumentParameter `locationName:"documentParameters" type:"list"`

	// A list of environments that are supported with the managed job template.
	Environments []*string `locationName:"environments" type:"list"`

	// The unique Amazon Resource Name (ARN) of the managed template.
	TemplateArn *string `locationName:"templateArn" min:"1" type:"string"`

	// The unique name of a managed template, such as AWS-Reboot.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`

	// The version for a managed template.
	TemplateVersion *string `locationName:"templateVersion" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeManagedJobTemplateOutput) GoString added in v1.42.11 

func (s DescribeManagedJobTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeManagedJobTemplateOutput) SetDescription added in v1.42.11 

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

SetDescription sets the Description field's value.

func (*DescribeManagedJobTemplateOutput) SetDocument added in v1.42.11 

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

SetDocument sets the Document field's value.

func (*DescribeManagedJobTemplateOutput) SetDocumentParameters added in v1.42.11 

func (s *DescribeManagedJobTemplateOutput) SetDocumentParameters(v []*DocumentParameter) *DescribeManagedJobTemplateOutput

SetDocumentParameters sets the DocumentParameters field's value.

func (*DescribeManagedJobTemplateOutput) SetEnvironments added in v1.42.11 

func (s *DescribeManagedJobTemplateOutput) SetEnvironments(v []*string) *DescribeManagedJobTemplateOutput

SetEnvironments sets the Environments field's value.

func (*DescribeManagedJobTemplateOutput) SetTemplateArn added in v1.42.11 

func (s *DescribeManagedJobTemplateOutput) SetTemplateArn(v string) *DescribeManagedJobTemplateOutput

SetTemplateArn sets the TemplateArn field's value.

func (*DescribeManagedJobTemplateOutput) SetTemplateName added in v1.42.11 

func (s *DescribeManagedJobTemplateOutput) SetTemplateName(v string) *DescribeManagedJobTemplateOutput

SetTemplateName sets the TemplateName field's value.

func (*DescribeManagedJobTemplateOutput) SetTemplateVersion added in v1.42.11 

func (s *DescribeManagedJobTemplateOutput) SetTemplateVersion(v string) *DescribeManagedJobTemplateOutput

SetTemplateVersion sets the TemplateVersion field's value.

func (DescribeManagedJobTemplateOutput) String added in v1.42.11 

func (s DescribeManagedJobTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMitigationActionInput added in v1.21.10 

type DescribeMitigationActionInput struct {

	// The friendly name that uniquely identifies the mitigation action.
	//
	// ActionName is a required field
	ActionName *string `location:"uri" locationName:"actionName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMitigationActionInput) GoString added in v1.21.10 

func (s DescribeMitigationActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMitigationActionInput) SetActionName added in v1.21.10 

func (s *DescribeMitigationActionInput) SetActionName(v string) *DescribeMitigationActionInput

SetActionName sets the ActionName field's value.

func (DescribeMitigationActionInput) String added in v1.21.10 

func (s DescribeMitigationActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMitigationActionInput) Validate added in v1.21.10 

func (s *DescribeMitigationActionInput) Validate() error

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

type DescribeMitigationActionOutput added in v1.21.10 

type DescribeMitigationActionOutput struct {

	// The ARN that identifies this migration action.
	ActionArn *string `locationName:"actionArn" type:"string"`

	// A unique identifier for this action.
	ActionId *string `locationName:"actionId" type:"string"`

	// The friendly name that uniquely identifies the mitigation action.
	ActionName *string `locationName:"actionName" type:"string"`

	// Parameters that control how the mitigation action is applied, specific to
	// the type of mitigation action.
	ActionParams *MitigationActionParams `locationName:"actionParams" type:"structure"`

	// The type of mitigation action.
	ActionType *string `locationName:"actionType" type:"string" enum:"MitigationActionType"`

	// The date and time when the mitigation action was added to your Amazon Web
	// Services accounts.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The date and time when the mitigation action was last changed.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The ARN of the IAM role used to apply this action.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMitigationActionOutput) GoString added in v1.21.10 

func (s DescribeMitigationActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMitigationActionOutput) SetActionArn added in v1.21.10 

func (s *DescribeMitigationActionOutput) SetActionArn(v string) *DescribeMitigationActionOutput

SetActionArn sets the ActionArn field's value.

func (*DescribeMitigationActionOutput) SetActionId added in v1.21.10 

func (s *DescribeMitigationActionOutput) SetActionId(v string) *DescribeMitigationActionOutput

SetActionId sets the ActionId field's value.

func (*DescribeMitigationActionOutput) SetActionName added in v1.21.10 

func (s *DescribeMitigationActionOutput) SetActionName(v string) *DescribeMitigationActionOutput

SetActionName sets the ActionName field's value.

func (*DescribeMitigationActionOutput) SetActionParams added in v1.21.10 

func (s *DescribeMitigationActionOutput) SetActionParams(v *MitigationActionParams) *DescribeMitigationActionOutput

SetActionParams sets the ActionParams field's value.

func (*DescribeMitigationActionOutput) SetActionType added in v1.21.10 

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

SetActionType sets the ActionType field's value.

func (*DescribeMitigationActionOutput) SetCreationDate added in v1.21.10 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeMitigationActionOutput) SetLastModifiedDate added in v1.21.10 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeMitigationActionOutput) SetRoleArn added in v1.21.10 

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

SetRoleArn sets the RoleArn field's value.

func (DescribeMitigationActionOutput) String added in v1.21.10 

func (s DescribeMitigationActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProvisioningTemplateInput added in v1.25.42 

type DescribeProvisioningTemplateInput struct {

	// The name of the fleet provisioning template.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningTemplateInput) GoString added in v1.25.42 

func (s DescribeProvisioningTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateInput) SetTemplateName added in v1.25.42 

func (s *DescribeProvisioningTemplateInput) SetTemplateName(v string) *DescribeProvisioningTemplateInput

SetTemplateName sets the TemplateName field's value.

func (DescribeProvisioningTemplateInput) String added in v1.25.42 

func (s DescribeProvisioningTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateInput) Validate added in v1.25.42 

func (s *DescribeProvisioningTemplateInput) Validate() error

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

type DescribeProvisioningTemplateOutput added in v1.25.42 

type DescribeProvisioningTemplateOutput struct {

	// The date when the fleet provisioning template was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The default fleet template version ID.
	DefaultVersionId *int64 `locationName:"defaultVersionId" type:"integer"`

	// The description of the fleet provisioning template.
	Description *string `locationName:"description" type:"string"`

	// True if the fleet provisioning template is enabled, otherwise false.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The date when the fleet provisioning template was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// Gets information about a pre-provisioned hook.
	PreProvisioningHook *ProvisioningHook `locationName:"preProvisioningHook" type:"structure"`

	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string `locationName:"provisioningRoleArn" min:"20" type:"string"`

	// The ARN of the fleet provisioning template.
	TemplateArn *string `locationName:"templateArn" type:"string"`

	// The JSON formatted contents of the fleet provisioning template.
	TemplateBody *string `locationName:"templateBody" type:"string"`

	// The name of the fleet provisioning template.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningTemplateOutput) GoString added in v1.25.42 

func (s DescribeProvisioningTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateOutput) SetCreationDate added in v1.25.42 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeProvisioningTemplateOutput) SetDefaultVersionId added in v1.25.42 

func (s *DescribeProvisioningTemplateOutput) SetDefaultVersionId(v int64) *DescribeProvisioningTemplateOutput

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*DescribeProvisioningTemplateOutput) SetDescription added in v1.25.42 

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

SetDescription sets the Description field's value.

func (*DescribeProvisioningTemplateOutput) SetEnabled added in v1.25.42 

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

SetEnabled sets the Enabled field's value.

func (*DescribeProvisioningTemplateOutput) SetLastModifiedDate added in v1.25.42 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeProvisioningTemplateOutput) SetPreProvisioningHook added in v1.30.18 

func (s *DescribeProvisioningTemplateOutput) SetPreProvisioningHook(v *ProvisioningHook) *DescribeProvisioningTemplateOutput

SetPreProvisioningHook sets the PreProvisioningHook field's value.

func (*DescribeProvisioningTemplateOutput) SetProvisioningRoleArn added in v1.25.42 

func (s *DescribeProvisioningTemplateOutput) SetProvisioningRoleArn(v string) *DescribeProvisioningTemplateOutput

SetProvisioningRoleArn sets the ProvisioningRoleArn field's value.

func (*DescribeProvisioningTemplateOutput) SetTemplateArn added in v1.25.42 

func (s *DescribeProvisioningTemplateOutput) SetTemplateArn(v string) *DescribeProvisioningTemplateOutput

SetTemplateArn sets the TemplateArn field's value.

func (*DescribeProvisioningTemplateOutput) SetTemplateBody added in v1.25.42 

func (s *DescribeProvisioningTemplateOutput) SetTemplateBody(v string) *DescribeProvisioningTemplateOutput

SetTemplateBody sets the TemplateBody field's value.

func (*DescribeProvisioningTemplateOutput) SetTemplateName added in v1.25.42 

func (s *DescribeProvisioningTemplateOutput) SetTemplateName(v string) *DescribeProvisioningTemplateOutput

SetTemplateName sets the TemplateName field's value.

func (DescribeProvisioningTemplateOutput) String added in v1.25.42 

func (s DescribeProvisioningTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProvisioningTemplateVersionInput added in v1.25.42 

type DescribeProvisioningTemplateVersionInput struct {

	// The template name.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`

	// The fleet provisioning template version ID.
	//
	// VersionId is a required field
	VersionId *int64 `location:"uri" locationName:"versionId" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningTemplateVersionInput) GoString added in v1.25.42 

func (s DescribeProvisioningTemplateVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateVersionInput) SetTemplateName added in v1.25.42 

func (s *DescribeProvisioningTemplateVersionInput) SetTemplateName(v string) *DescribeProvisioningTemplateVersionInput

SetTemplateName sets the TemplateName field's value.

func (*DescribeProvisioningTemplateVersionInput) SetVersionId added in v1.25.42 

func (s *DescribeProvisioningTemplateVersionInput) SetVersionId(v int64) *DescribeProvisioningTemplateVersionInput

SetVersionId sets the VersionId field's value.

func (DescribeProvisioningTemplateVersionInput) String added in v1.25.42 

func (s DescribeProvisioningTemplateVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateVersionInput) Validate added in v1.25.42 

func (s *DescribeProvisioningTemplateVersionInput) Validate() error

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

type DescribeProvisioningTemplateVersionOutput added in v1.25.42 

type DescribeProvisioningTemplateVersionOutput struct {

	// The date when the fleet provisioning template version was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// True if the fleet provisioning template version is the default version.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The JSON formatted contents of the fleet provisioning template version.
	TemplateBody *string `locationName:"templateBody" type:"string"`

	// The fleet provisioning template version ID.
	VersionId *int64 `locationName:"versionId" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningTemplateVersionOutput) GoString added in v1.25.42 

func (s DescribeProvisioningTemplateVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProvisioningTemplateVersionOutput) SetCreationDate added in v1.25.42 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeProvisioningTemplateVersionOutput) SetIsDefaultVersion added in v1.25.42 

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

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*DescribeProvisioningTemplateVersionOutput) SetTemplateBody added in v1.25.42 

func (s *DescribeProvisioningTemplateVersionOutput) SetTemplateBody(v string) *DescribeProvisioningTemplateVersionOutput

SetTemplateBody sets the TemplateBody field's value.

func (*DescribeProvisioningTemplateVersionOutput) SetVersionId added in v1.25.42 

func (s *DescribeProvisioningTemplateVersionOutput) SetVersionId(v int64) *DescribeProvisioningTemplateVersionOutput

SetVersionId sets the VersionId field's value.

func (DescribeProvisioningTemplateVersionOutput) String added in v1.25.42 

func (s DescribeProvisioningTemplateVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRoleAliasInput) SetRoleAlias added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRoleAliasOutput) SetRoleAliasDescription added in v1.12.36 

func (s *DescribeRoleAliasOutput) SetRoleAliasDescription(v *RoleAliasDescription) *DescribeRoleAliasOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScheduledAuditInput added in v1.15.2 

type DescribeScheduledAuditInput struct {

	// The name of the scheduled audit whose information you want to get.
	//
	// ScheduledAuditName is a required field
	ScheduledAuditName *string `location:"uri" locationName:"scheduledAuditName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeScheduledAuditInput) GoString added in v1.15.2 

func (s DescribeScheduledAuditInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledAuditInput) SetScheduledAuditName added in v1.15.2 

func (s *DescribeScheduledAuditInput) SetScheduledAuditName(v string) *DescribeScheduledAuditInput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (DescribeScheduledAuditInput) String added in v1.15.2 

func (s DescribeScheduledAuditInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledAuditInput) Validate added in v1.15.2 

func (s *DescribeScheduledAuditInput) Validate() error

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

type DescribeScheduledAuditOutput added in v1.15.2 

type DescribeScheduledAuditOutput struct {

	// The day of the month on which the scheduled audit takes place. This is will
	// be 1 through 31 or LAST. If days 29-31 are specified, and the month does
	// not have that many days, the audit takes place on the LAST day of the month.
	DayOfMonth *string `locationName:"dayOfMonth" type:"string"`

	// The day of the week on which the scheduled audit takes place, either one
	// of SUN, MON, TUE, WED, THU, FRI, or SAT.
	DayOfWeek *string `locationName:"dayOfWeek" type:"string" enum:"DayOfWeek"`

	// How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY,
	// or MONTHLY. The start time of each audit is determined by the system.
	Frequency *string `locationName:"frequency" type:"string" enum:"AuditFrequency"`

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string `locationName:"scheduledAuditArn" type:"string"`

	// The name of the scheduled audit.
	ScheduledAuditName *string `locationName:"scheduledAuditName" min:"1" type:"string"`

	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list
	// of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	TargetCheckNames []*string `locationName:"targetCheckNames" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScheduledAuditOutput) GoString added in v1.15.2 

func (s DescribeScheduledAuditOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledAuditOutput) SetDayOfMonth added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetDayOfMonth(v string) *DescribeScheduledAuditOutput

SetDayOfMonth sets the DayOfMonth field's value.

func (*DescribeScheduledAuditOutput) SetDayOfWeek added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetDayOfWeek(v string) *DescribeScheduledAuditOutput

SetDayOfWeek sets the DayOfWeek field's value.

func (*DescribeScheduledAuditOutput) SetFrequency added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetFrequency(v string) *DescribeScheduledAuditOutput

SetFrequency sets the Frequency field's value.

func (*DescribeScheduledAuditOutput) SetScheduledAuditArn added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetScheduledAuditArn(v string) *DescribeScheduledAuditOutput

SetScheduledAuditArn sets the ScheduledAuditArn field's value.

func (*DescribeScheduledAuditOutput) SetScheduledAuditName added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetScheduledAuditName(v string) *DescribeScheduledAuditOutput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (*DescribeScheduledAuditOutput) SetTargetCheckNames added in v1.15.2 

func (s *DescribeScheduledAuditOutput) SetTargetCheckNames(v []*string) *DescribeScheduledAuditOutput

SetTargetCheckNames sets the TargetCheckNames field's value.

func (DescribeScheduledAuditOutput) String added in v1.15.2 

func (s DescribeScheduledAuditOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSecurityProfileInput added in v1.15.2 

type DescribeSecurityProfileInput struct {

	// The name of the security profile whose information you want to get.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSecurityProfileInput) GoString added in v1.15.2 

func (s DescribeSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *DescribeSecurityProfileInput) SetSecurityProfileName(v string) *DescribeSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (DescribeSecurityProfileInput) String added in v1.15.2 

func (s DescribeSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityProfileInput) Validate added in v1.15.2 

func (s *DescribeSecurityProfileInput) Validate() error

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

type DescribeSecurityProfileOutput added in v1.15.2 

type DescribeSecurityProfileOutput struct {

	// Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
	//
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []*string `locationName:"additionalMetricsToRetain" deprecated:"true" type:"list"`

	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here.
	AdditionalMetricsToRetainV2 []*MetricToRetain `locationName:"additionalMetricsToRetainV2" type:"list"`

	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*AlertTarget `locationName:"alertTargets" type:"map"`

	// Specifies the behaviors that, when violated by a device (thing), cause an
	// alert.
	Behaviors []*Behavior `locationName:"behaviors" type:"list"`

	// The time the security profile was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The time the security profile was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The ARN of the security profile.
	SecurityProfileArn *string `locationName:"securityProfileArn" type:"string"`

	// A description of the security profile (associated with the security profile
	// when it was created or updated).
	SecurityProfileDescription *string `locationName:"securityProfileDescription" type:"string"`

	// The name of the security profile.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The version of the security profile. A new version is generated whenever
	// the security profile is updated.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (DescribeSecurityProfileOutput) GoString added in v1.15.2 

func (s DescribeSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityProfileOutput) SetAdditionalMetricsToRetain added in v1.17.1 

func (s *DescribeSecurityProfileOutput) SetAdditionalMetricsToRetain(v []*string) *DescribeSecurityProfileOutput

SetAdditionalMetricsToRetain sets the AdditionalMetricsToRetain field's value.

func (*DescribeSecurityProfileOutput) SetAdditionalMetricsToRetainV2 added in v1.30.2 

func (s *DescribeSecurityProfileOutput) SetAdditionalMetricsToRetainV2(v []*MetricToRetain) *DescribeSecurityProfileOutput

SetAdditionalMetricsToRetainV2 sets the AdditionalMetricsToRetainV2 field's value.

func (*DescribeSecurityProfileOutput) SetAlertTargets added in v1.15.2 

func (s *DescribeSecurityProfileOutput) SetAlertTargets(v map[string]*AlertTarget) *DescribeSecurityProfileOutput

SetAlertTargets sets the AlertTargets field's value.

func (*DescribeSecurityProfileOutput) SetBehaviors added in v1.15.2 

func (s *DescribeSecurityProfileOutput) SetBehaviors(v []*Behavior) *DescribeSecurityProfileOutput

SetBehaviors sets the Behaviors field's value.

func (*DescribeSecurityProfileOutput) SetCreationDate added in v1.15.2 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeSecurityProfileOutput) SetLastModifiedDate added in v1.15.2 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeSecurityProfileOutput) SetSecurityProfileArn added in v1.15.2 

func (s *DescribeSecurityProfileOutput) SetSecurityProfileArn(v string) *DescribeSecurityProfileOutput

SetSecurityProfileArn sets the SecurityProfileArn field's value.

func (*DescribeSecurityProfileOutput) SetSecurityProfileDescription added in v1.15.2 

func (s *DescribeSecurityProfileOutput) SetSecurityProfileDescription(v string) *DescribeSecurityProfileOutput

SetSecurityProfileDescription sets the SecurityProfileDescription field's value.

func (*DescribeSecurityProfileOutput) SetSecurityProfileName added in v1.15.2 

func (s *DescribeSecurityProfileOutput) SetSecurityProfileName(v string) *DescribeSecurityProfileOutput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*DescribeSecurityProfileOutput) SetVersion added in v1.15.2 

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

SetVersion sets the Version field's value.

func (DescribeSecurityProfileOutput) String added in v1.15.2 

func (s DescribeSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamOutput) SetStreamInfo added in v1.12.51 

func (s *DescribeStreamOutput) SetStreamInfo(v *StreamInfo) *DescribeStreamOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 dynamic thing group index name.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

	// The dynamic thing group search query string.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`

	// The dynamic thing group query version.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

	// The dynamic thing group status.
	Status *string `locationName:"status" type:"string" enum:"DynamicGroupStatus"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThingGroupOutput) SetIndexName added in v1.15.79 

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

SetIndexName sets the IndexName field's value.

func (*DescribeThingGroupOutput) SetQueryString added in v1.15.79 

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

SetQueryString sets the QueryString field's value.

func (*DescribeThingGroupOutput) SetQueryVersion added in v1.15.79 

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

SetQueryVersion sets the QueryVersion field's value.

func (*DescribeThingGroupOutput) SetStatus added in v1.15.79 

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

SetStatus sets the Status field's value.

func (*DescribeThingGroupOutput) SetThingGroupArn added in v1.12.36 

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

SetThingGroupArn sets the ThingGroupArn field's value.

func (*DescribeThingGroupOutput) SetThingGroupId added in v1.12.36 

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

SetThingGroupId sets the ThingGroupId field's value.

func (*DescribeThingGroupOutput) SetThingGroupMetadata added in v1.12.36 

func (s *DescribeThingGroupOutput) SetThingGroupMetadata(v *ThingGroupMetadata) *DescribeThingGroupOutput

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 

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

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (*DescribeThingGroupOutput) SetVersion added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 name of the billing group the thing belongs to.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`

	// The default MQTT client ID. For a typical device, the thing name is also
	// used as the default MQTT client ID. Although we don’t require a mapping
	// between a thing's registry name and its use of MQTT client IDs, certificates,
	// or shadow state, we recommend that you choose a thing name and use it as
	// the MQTT client ID for the registry and the Device Shadow service.
	//
	// This lets you better organize your IoT fleet without removing the flexibility
	// of the underlying device certificate model or shadows.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetBillingGroupName added in v1.15.79 

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

SetBillingGroupName sets the BillingGroupName 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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DescribeThingRegistrationTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThingRegistrationTaskInput) SetTaskId added in v1.12.36 

func (s *DescribeThingRegistrationTaskInput) SetTaskId(v string) *DescribeThingRegistrationTaskInput

SetTaskId sets the TaskId field's value.

func (DescribeThingRegistrationTaskInput) String added in v1.12.36 

func (s DescribeThingRegistrationTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThingRegistrationTaskInput) Validate added in v1.12.36 

func (s *DescribeThingRegistrationTaskInput) Validate() error

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

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

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

func (s DescribeThingRegistrationTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThingRegistrationTaskOutput) SetCreationDate added in v1.12.36 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeThingRegistrationTaskOutput) SetFailureCount added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetFailureCount(v int64) *DescribeThingRegistrationTaskOutput

SetFailureCount sets the FailureCount field's value.

func (*DescribeThingRegistrationTaskOutput) SetInputFileBucket added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetInputFileBucket(v string) *DescribeThingRegistrationTaskOutput

SetInputFileBucket sets the InputFileBucket field's value.

func (*DescribeThingRegistrationTaskOutput) SetInputFileKey added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetInputFileKey(v string) *DescribeThingRegistrationTaskOutput

SetInputFileKey sets the InputFileKey field's value.

func (*DescribeThingRegistrationTaskOutput) SetLastModifiedDate added in v1.12.36 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeThingRegistrationTaskOutput) SetMessage added in v1.12.36 

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

SetMessage sets the Message field's value.

func (*DescribeThingRegistrationTaskOutput) SetPercentageProgress added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetPercentageProgress(v int64) *DescribeThingRegistrationTaskOutput

SetPercentageProgress sets the PercentageProgress field's value.

func (*DescribeThingRegistrationTaskOutput) SetRoleArn added in v1.12.36 

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeThingRegistrationTaskOutput) SetStatus added in v1.12.36 

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

SetStatus sets the Status field's value.

func (*DescribeThingRegistrationTaskOutput) SetSuccessCount added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetSuccessCount(v int64) *DescribeThingRegistrationTaskOutput

SetSuccessCount sets the SuccessCount field's value.

func (*DescribeThingRegistrationTaskOutput) SetTaskId added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetTaskId(v string) *DescribeThingRegistrationTaskOutput

SetTaskId sets the TaskId field's value.

func (*DescribeThingRegistrationTaskOutput) SetTemplateBody added in v1.12.36 

func (s *DescribeThingRegistrationTaskOutput) SetTemplateBody(v string) *DescribeThingRegistrationTaskOutput

SetTemplateBody sets the TemplateBody field's value.

func (DescribeThingRegistrationTaskOutput) String added in v1.12.36 

func (s DescribeThingRegistrationTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThingTypeOutput) SetThingTypeArn added in v1.12.36 

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

SetThingTypeArn sets the ThingTypeArn field's value.

func (*DescribeThingTypeOutput) SetThingTypeId added in v1.12.36 

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

SetThingTypeId sets the ThingTypeId field's value.

func (*DescribeThingTypeOutput) SetThingTypeMetadata added in v1.5.0 

func (s *DescribeThingTypeOutput) SetThingTypeMetadata(v *ThingTypeMetadata) *DescribeThingTypeOutput

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Destination added in v1.15.22 

type Destination struct {

	// Describes the location in S3 of the updated firmware.
	S3Destination *S3Destination `locationName:"s3Destination" type:"structure"`
	// contains filtered or unexported fields
}

Describes the location of the updated firmware.

func (Destination) GoString added in v1.15.22 

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetS3Destination added in v1.15.22 

func (s *Destination) SetS3Destination(v *S3Destination) *Destination

SetS3Destination sets the S3Destination field's value.

func (Destination) String added in v1.15.22 

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) Validate added in v1.15.22 

func (s *Destination) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachPolicyOutput) String added in v1.12.36 

func (s DetachPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
	// thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId
	// (region: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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachPrincipalPolicyInput) SetPolicyName added in v1.5.0 

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

SetPolicyName sets the PolicyName field's value.

func (*DetachPrincipalPolicyInput) SetPrincipal added in v1.5.0 

func (s *DetachPrincipalPolicyInput) SetPrincipal(v string) *DetachPrincipalPolicyInput

SetPrincipal sets the Principal field's value.

func (DetachPrincipalPolicyInput) String 

func (s DetachPrincipalPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachPrincipalPolicyOutput) String 

func (s DetachPrincipalPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachSecurityProfileInput added in v1.15.2 

type DetachSecurityProfileInput struct {

	// The security profile that is detached.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`

	// The ARN of the thing group from which the security profile is detached.
	//
	// SecurityProfileTargetArn is a required field
	SecurityProfileTargetArn *string `location:"querystring" locationName:"securityProfileTargetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachSecurityProfileInput) GoString added in v1.15.2 

func (s DetachSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *DetachSecurityProfileInput) SetSecurityProfileName(v string) *DetachSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*DetachSecurityProfileInput) SetSecurityProfileTargetArn added in v1.15.2 

func (s *DetachSecurityProfileInput) SetSecurityProfileTargetArn(v string) *DetachSecurityProfileInput

SetSecurityProfileTargetArn sets the SecurityProfileTargetArn field's value.

func (DetachSecurityProfileInput) String added in v1.15.2 

func (s DetachSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachSecurityProfileInput) Validate added in v1.15.2 

func (s *DetachSecurityProfileInput) Validate() error

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

type DetachSecurityProfileOutput added in v1.15.2 

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

func (DetachSecurityProfileOutput) GoString added in v1.15.2 

func (s DetachSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachSecurityProfileOutput) String added in v1.15.2 

func (s DetachSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachThingPrincipalInput) SetPrincipal added in v1.5.0 

func (s *DetachThingPrincipalInput) SetPrincipal(v string) *DetachThingPrincipalInput

SetPrincipal sets the Principal field's value.

func (*DetachThingPrincipalInput) SetThingName added in v1.5.0 

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

SetThingName sets the ThingName field's value.

func (DetachThingPrincipalInput) String 

func (s DetachThingPrincipalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachThingPrincipalOutput) String 

func (s DetachThingPrincipalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectMitigationActionExecution added in v1.36.9 

type DetectMitigationActionExecution struct {

	// The friendly name that uniquely identifies the mitigation action.
	ActionName *string `locationName:"actionName" type:"string"`

	// The error code of a mitigation action.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The date a mitigation action ended.
	ExecutionEndDate *time.Time `locationName:"executionEndDate" type:"timestamp"`

	// The date a mitigation action was started.
	ExecutionStartDate *time.Time `locationName:"executionStartDate" type:"timestamp"`

	// The message of a mitigation action.
	Message *string `locationName:"message" type:"string"`

	// The status of a mitigation action.
	Status *string `locationName:"status" type:"string" enum:"DetectMitigationActionExecutionStatus"`

	// The unique identifier of the task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

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

	// The unique identifier of the violation.
	ViolationId *string `locationName:"violationId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes which mitigation actions should be executed.

func (DetectMitigationActionExecution) GoString added in v1.36.9 

func (s DetectMitigationActionExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectMitigationActionExecution) SetActionName added in v1.36.9 

func (s *DetectMitigationActionExecution) SetActionName(v string) *DetectMitigationActionExecution

SetActionName sets the ActionName field's value.

func (*DetectMitigationActionExecution) SetErrorCode added in v1.36.9 

func (s *DetectMitigationActionExecution) SetErrorCode(v string) *DetectMitigationActionExecution

SetErrorCode sets the ErrorCode field's value.

func (*DetectMitigationActionExecution) SetExecutionEndDate added in v1.36.9 

func (s *DetectMitigationActionExecution) SetExecutionEndDate(v time.Time) *DetectMitigationActionExecution

SetExecutionEndDate sets the ExecutionEndDate field's value.

func (*DetectMitigationActionExecution) SetExecutionStartDate added in v1.36.9 

func (s *DetectMitigationActionExecution) SetExecutionStartDate(v time.Time) *DetectMitigationActionExecution

SetExecutionStartDate sets the ExecutionStartDate field's value.

func (*DetectMitigationActionExecution) SetMessage added in v1.36.9 

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

SetMessage sets the Message field's value.

func (*DetectMitigationActionExecution) SetStatus added in v1.36.9 

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

SetStatus sets the Status field's value.

func (*DetectMitigationActionExecution) SetTaskId added in v1.36.9 

func (s *DetectMitigationActionExecution) SetTaskId(v string) *DetectMitigationActionExecution

SetTaskId sets the TaskId field's value.

func (*DetectMitigationActionExecution) SetThingName added in v1.36.9 

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

SetThingName sets the ThingName field's value.

func (*DetectMitigationActionExecution) SetViolationId added in v1.36.9 

func (s *DetectMitigationActionExecution) SetViolationId(v string) *DetectMitigationActionExecution

SetViolationId sets the ViolationId field's value.

func (DetectMitigationActionExecution) String added in v1.36.9 

func (s DetectMitigationActionExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectMitigationActionsTaskStatistics added in v1.36.9 

type DetectMitigationActionsTaskStatistics struct {

	// The actions that were performed.
	ActionsExecuted *int64 `locationName:"actionsExecuted" type:"long"`

	// The actions that failed.
	ActionsFailed *int64 `locationName:"actionsFailed" type:"long"`

	// The actions that were skipped.
	ActionsSkipped *int64 `locationName:"actionsSkipped" type:"long"`
	// contains filtered or unexported fields
}

The statistics of a mitigation action task.

func (DetectMitigationActionsTaskStatistics) GoString added in v1.36.9 

func (s DetectMitigationActionsTaskStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectMitigationActionsTaskStatistics) SetActionsExecuted added in v1.36.9 

func (s *DetectMitigationActionsTaskStatistics) SetActionsExecuted(v int64) *DetectMitigationActionsTaskStatistics

SetActionsExecuted sets the ActionsExecuted field's value.

func (*DetectMitigationActionsTaskStatistics) SetActionsFailed added in v1.36.9 

func (s *DetectMitigationActionsTaskStatistics) SetActionsFailed(v int64) *DetectMitigationActionsTaskStatistics

SetActionsFailed sets the ActionsFailed field's value.

func (*DetectMitigationActionsTaskStatistics) SetActionsSkipped added in v1.36.9 

func (s *DetectMitigationActionsTaskStatistics) SetActionsSkipped(v int64) *DetectMitigationActionsTaskStatistics

SetActionsSkipped sets the ActionsSkipped field's value.

func (DetectMitigationActionsTaskStatistics) String added in v1.36.9 

func (s DetectMitigationActionsTaskStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectMitigationActionsTaskSummary added in v1.36.9 

type DetectMitigationActionsTaskSummary struct {

	// The definition of the actions.
	ActionsDefinition []*MitigationAction `locationName:"actionsDefinition" type:"list"`

	// Includes only active violations.
	OnlyActiveViolationsIncluded *bool `locationName:"onlyActiveViolationsIncluded" type:"boolean"`

	// Includes suppressed alerts.
	SuppressedAlertsIncluded *bool `locationName:"suppressedAlertsIncluded" type:"boolean"`

	// Specifies the ML Detect findings to which the mitigation actions are applied.
	Target *DetectMitigationActionsTaskTarget `locationName:"target" type:"structure"`

	// The date the task ended.
	TaskEndTime *time.Time `locationName:"taskEndTime" type:"timestamp"`

	// The unique identifier of the task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

	// The date the task started.
	TaskStartTime *time.Time `locationName:"taskStartTime" type:"timestamp"`

	// The statistics of a mitigation action task.
	TaskStatistics *DetectMitigationActionsTaskStatistics `locationName:"taskStatistics" type:"structure"`

	// The status of the task.
	TaskStatus *string `locationName:"taskStatus" type:"string" enum:"DetectMitigationActionsTaskStatus"`

	// Specifies the time period of which violation events occurred between.
	ViolationEventOccurrenceRange *ViolationEventOccurrenceRange `locationName:"violationEventOccurrenceRange" type:"structure"`
	// contains filtered or unexported fields
}

The summary of the mitigation action tasks.

func (DetectMitigationActionsTaskSummary) GoString added in v1.36.9 

func (s DetectMitigationActionsTaskSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectMitigationActionsTaskSummary) SetActionsDefinition added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetActionsDefinition(v []*MitigationAction) *DetectMitigationActionsTaskSummary

SetActionsDefinition sets the ActionsDefinition field's value.

func (*DetectMitigationActionsTaskSummary) SetOnlyActiveViolationsIncluded added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetOnlyActiveViolationsIncluded(v bool) *DetectMitigationActionsTaskSummary

SetOnlyActiveViolationsIncluded sets the OnlyActiveViolationsIncluded field's value.

func (*DetectMitigationActionsTaskSummary) SetSuppressedAlertsIncluded added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetSuppressedAlertsIncluded(v bool) *DetectMitigationActionsTaskSummary

SetSuppressedAlertsIncluded sets the SuppressedAlertsIncluded field's value.

func (*DetectMitigationActionsTaskSummary) SetTarget added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTarget(v *DetectMitigationActionsTaskTarget) *DetectMitigationActionsTaskSummary

SetTarget sets the Target field's value.

func (*DetectMitigationActionsTaskSummary) SetTaskEndTime added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTaskEndTime(v time.Time) *DetectMitigationActionsTaskSummary

SetTaskEndTime sets the TaskEndTime field's value.

func (*DetectMitigationActionsTaskSummary) SetTaskId added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTaskId(v string) *DetectMitigationActionsTaskSummary

SetTaskId sets the TaskId field's value.

func (*DetectMitigationActionsTaskSummary) SetTaskStartTime added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTaskStartTime(v time.Time) *DetectMitigationActionsTaskSummary

SetTaskStartTime sets the TaskStartTime field's value.

func (*DetectMitigationActionsTaskSummary) SetTaskStatistics added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTaskStatistics(v *DetectMitigationActionsTaskStatistics) *DetectMitigationActionsTaskSummary

SetTaskStatistics sets the TaskStatistics field's value.

func (*DetectMitigationActionsTaskSummary) SetTaskStatus added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetTaskStatus(v string) *DetectMitigationActionsTaskSummary

SetTaskStatus sets the TaskStatus field's value.

func (*DetectMitigationActionsTaskSummary) SetViolationEventOccurrenceRange added in v1.36.9 

func (s *DetectMitigationActionsTaskSummary) SetViolationEventOccurrenceRange(v *ViolationEventOccurrenceRange) *DetectMitigationActionsTaskSummary

SetViolationEventOccurrenceRange sets the ViolationEventOccurrenceRange field's value.

func (DetectMitigationActionsTaskSummary) String added in v1.36.9 

func (s DetectMitigationActionsTaskSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectMitigationActionsTaskTarget added in v1.36.9 

type DetectMitigationActionsTaskTarget struct {

	// The name of the behavior.
	BehaviorName *string `locationName:"behaviorName" min:"1" type:"string"`

	// The name of the security profile.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The unique identifiers of the violations.
	ViolationIds []*string `locationName:"violationIds" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The target of a mitigation action task.

func (DetectMitigationActionsTaskTarget) GoString added in v1.36.9 

func (s DetectMitigationActionsTaskTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectMitigationActionsTaskTarget) SetBehaviorName added in v1.36.9 

func (s *DetectMitigationActionsTaskTarget) SetBehaviorName(v string) *DetectMitigationActionsTaskTarget

SetBehaviorName sets the BehaviorName field's value.

func (*DetectMitigationActionsTaskTarget) SetSecurityProfileName added in v1.36.9 

func (s *DetectMitigationActionsTaskTarget) SetSecurityProfileName(v string) *DetectMitigationActionsTaskTarget

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*DetectMitigationActionsTaskTarget) SetViolationIds added in v1.36.9 

func (s *DetectMitigationActionsTaskTarget) SetViolationIds(v []*string) *DetectMitigationActionsTaskTarget

SetViolationIds sets the ViolationIds field's value.

func (DetectMitigationActionsTaskTarget) String added in v1.36.9 

func (s DetectMitigationActionsTaskTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectMitigationActionsTaskTarget) Validate added in v1.36.9 

func (s *DetectMitigationActionsTaskTarget) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableTopicRuleInput) SetRuleName added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableTopicRuleOutput) String added in v1.0.11 

func (s DisableTopicRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentParameter added in v1.42.11 

type DocumentParameter struct {

	// Description of the map field containing the patterns that need to be replaced
	// in a managed template job document schema.
	Description *string `locationName:"description" type:"string"`

	// An example illustrating a pattern that need to be replaced in a managed template
	// job document schema.
	Example *string `locationName:"example" type:"string"`

	// Key of the map field containing the patterns that need to be replaced in
	// a managed template job document schema.
	Key *string `locationName:"key" min:"1" type:"string"`

	// Specifies whether a pattern that needs to be replaced in a managed template
	// job document schema is optional or required.
	Optional *bool `locationName:"optional" type:"boolean"`

	// A regular expression of the patterns that need to be replaced in a managed
	// template job document schema.
	Regex *string `locationName:"regex" type:"string"`
	// contains filtered or unexported fields
}

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

func (DocumentParameter) GoString added in v1.42.11 

func (s DocumentParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentParameter) SetDescription added in v1.42.11 

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

SetDescription sets the Description field's value.

func (*DocumentParameter) SetExample added in v1.42.11 

func (s *DocumentParameter) SetExample(v string) *DocumentParameter

SetExample sets the Example field's value.

func (*DocumentParameter) SetKey added in v1.42.11 

func (s *DocumentParameter) SetKey(v string) *DocumentParameter

SetKey sets the Key field's value.

func (*DocumentParameter) SetOptional added in v1.42.11 

func (s *DocumentParameter) SetOptional(v bool) *DocumentParameter

SetOptional sets the Optional field's value.

func (*DocumentParameter) SetRegex added in v1.42.11 

func (s *DocumentParameter) SetRegex(v string) *DocumentParameter

SetRegex sets the Regex field's value.

func (DocumentParameter) String added in v1.42.11 

func (s DocumentParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainConfigurationSummary added in v1.25.42 

type DomainConfigurationSummary struct {

	// The ARN of the domain configuration.
	DomainConfigurationArn *string `locationName:"domainConfigurationArn" type:"string"`

	// The name of the domain configuration. This value must be unique to a region.
	DomainConfigurationName *string `locationName:"domainConfigurationName" min:"1" type:"string"`

	// The type of service delivered by the endpoint.
	ServiceType *string `locationName:"serviceType" type:"string" enum:"ServiceType"`
	// contains filtered or unexported fields
}

The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

  • Data

  • Jobs

  • CredentialProvider

func (DomainConfigurationSummary) GoString added in v1.25.42 

func (s DomainConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainConfigurationSummary) SetDomainConfigurationArn added in v1.25.42 

func (s *DomainConfigurationSummary) SetDomainConfigurationArn(v string) *DomainConfigurationSummary

SetDomainConfigurationArn sets the DomainConfigurationArn field's value.

func (*DomainConfigurationSummary) SetDomainConfigurationName added in v1.25.42 

func (s *DomainConfigurationSummary) SetDomainConfigurationName(v string) *DomainConfigurationSummary

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (*DomainConfigurationSummary) SetServiceType added in v1.25.42 

func (s *DomainConfigurationSummary) SetServiceType(v string) *DomainConfigurationSummary

SetServiceType sets the ServiceType field's value.

func (DomainConfigurationSummary) String added in v1.25.42 

func (s DomainConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a required field
	PutItem *PutItemInput `locationName:"putItem" type:"structure" required:"true"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ElasticsearchAction added in v1.1.12 

type ElasticsearchAction struct {

	// The endpoint of your OpenSearch 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 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 OpenSearch.
	//
	// 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 OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html).

func (ElasticsearchAction) GoString added in v1.1.12 

func (s ElasticsearchAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetId sets the Id field's value.

func (*ElasticsearchAction) SetIndex added in v1.5.0 

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

SetIndex sets the Index field's value.

func (*ElasticsearchAction) SetRoleArn added in v1.5.0 

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

SetRoleArn sets the RoleArn field's value.

func (*ElasticsearchAction) SetType added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

type EnableIoTLoggingParams struct {

	// Specifies the type of information to be logged.
	//
	// LogLevel is a required field
	LogLevel *string `locationName:"logLevel" type:"string" required:"true" enum:"LogLevel"`

	// The Amazon Resource Name (ARN) of the IAM role used for logging.
	//
	// RoleArnForLogging is a required field
	RoleArnForLogging *string `locationName:"roleArnForLogging" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.

func (EnableIoTLoggingParams) GoString added in v1.21.10 

func (s EnableIoTLoggingParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableIoTLoggingParams) SetLogLevel added in v1.21.10 

func (s *EnableIoTLoggingParams) SetLogLevel(v string) *EnableIoTLoggingParams

SetLogLevel sets the LogLevel field's value.

func (*EnableIoTLoggingParams) SetRoleArnForLogging added in v1.21.10 

func (s *EnableIoTLoggingParams) SetRoleArnForLogging(v string) *EnableIoTLoggingParams

SetRoleArnForLogging sets the RoleArnForLogging field's value.

func (EnableIoTLoggingParams) String added in v1.21.10 

func (s EnableIoTLoggingParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableIoTLoggingParams) Validate added in v1.21.10 

func (s *EnableIoTLoggingParams) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableTopicRuleInput) SetRuleName added in v1.5.0 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableTopicRuleOutput) String added in v1.0.11 

func (s EnableTopicRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExponentialRolloutRate added in v1.15.79 

type ExponentialRolloutRate struct {

	// The minimum number of things that will be notified of a pending job, per
	// minute at the start of job rollout. This parameter allows you to define the
	// initial rate of rollout.
	//
	// BaseRatePerMinute is a required field
	BaseRatePerMinute *int64 `locationName:"baseRatePerMinute" min:"1" type:"integer" required:"true"`

	// The exponential factor to increase the rate of rollout for a job.
	//
	// Amazon Web Services IoT Core supports up to one digit after the decimal (for
	// example, 1.5, but not 1.55).
	//
	// IncrementFactor is a required field
	IncrementFactor *float64 `locationName:"incrementFactor" min:"1.1" type:"double" required:"true"`

	// The criteria to initiate the increase in rate of rollout for a job.
	//
	// RateIncreaseCriteria is a required field
	RateIncreaseCriteria *RateIncreaseCriteria `locationName:"rateIncreaseCriteria" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Allows you to create an exponential rate of rollout for a job.

func (ExponentialRolloutRate) GoString added in v1.15.79 

func (s ExponentialRolloutRate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExponentialRolloutRate) SetBaseRatePerMinute added in v1.15.79 

func (s *ExponentialRolloutRate) SetBaseRatePerMinute(v int64) *ExponentialRolloutRate

SetBaseRatePerMinute sets the BaseRatePerMinute field's value.

func (*ExponentialRolloutRate) SetIncrementFactor added in v1.15.79 

func (s *ExponentialRolloutRate) SetIncrementFactor(v float64) *ExponentialRolloutRate

SetIncrementFactor sets the IncrementFactor field's value.

func (*ExponentialRolloutRate) SetRateIncreaseCriteria added in v1.15.79 

func (s *ExponentialRolloutRate) SetRateIncreaseCriteria(v *RateIncreaseCriteria) *ExponentialRolloutRate

SetRateIncreaseCriteria sets the RateIncreaseCriteria field's value.

func (ExponentialRolloutRate) String added in v1.15.79 

func (s ExponentialRolloutRate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExponentialRolloutRate) Validate added in v1.15.79 

func (s *ExponentialRolloutRate) Validate() error

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

type Field added in v1.25.34 

type Field struct {

	// The name of the field.
	Name *string `locationName:"name" type:"string"`

	// The data type of the field.
	Type *string `locationName:"type" type:"string" enum:"FieldType"`
	// contains filtered or unexported fields
}

Describes the name and data type at a field.

func (Field) GoString added in v1.25.34 

func (s Field) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Field) SetName added in v1.25.34 

func (s *Field) SetName(v string) *Field

SetName sets the Name field's value.

func (*Field) SetType added in v1.25.34 

func (s *Field) SetType(v string) *Field

SetType sets the Type field's value.

func (Field) String added in v1.25.34 

func (s Field) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileLocation added in v1.15.22 

type FileLocation struct {

	// The location of the updated firmware in S3.
	S3Location *S3Location `locationName:"s3Location" type:"structure"`

	// The stream that contains the OTA update.
	Stream *Stream `locationName:"stream" type:"structure"`
	// contains filtered or unexported fields
}

The location of the OTA update.

func (FileLocation) GoString added in v1.15.22 

func (s FileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileLocation) SetS3Location added in v1.15.22 

func (s *FileLocation) SetS3Location(v *S3Location) *FileLocation

SetS3Location sets the S3Location field's value.

func (*FileLocation) SetStream added in v1.15.22 

func (s *FileLocation) SetStream(v *Stream) *FileLocation

SetStream sets the Stream field's value.

func (FileLocation) String added in v1.15.22 

func (s FileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileLocation) Validate added in v1.15.22 

func (s *FileLocation) Validate() error

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

type FirehoseAction 

type FirehoseAction struct {

	// Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch
	// (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html).
	// The default value is false.
	//
	// When batchMode is true and the rule's SQL statement evaluates to an Array,
	// each Array element forms one record in the PutRecordBatch (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html)
	// request. The resulting array can't have more than 500 records.
	BatchMode *bool `locationName:"batchMode" type:"boolean"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirehoseAction) SetBatchMode added in v1.35.27 

func (s *FirehoseAction) SetBatchMode(v bool) *FirehoseAction

SetBatchMode sets the BatchMode field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

type FleetMetricNameAndArn struct {

	// The fleet metric ARN.
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The fleet metric name.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The name and ARN of a fleet metric.

func (FleetMetricNameAndArn) GoString added in v1.40.34 

func (s FleetMetricNameAndArn) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FleetMetricNameAndArn) SetMetricArn added in v1.40.34 

func (s *FleetMetricNameAndArn) SetMetricArn(v string) *FleetMetricNameAndArn

SetMetricArn sets the MetricArn field's value.

func (*FleetMetricNameAndArn) SetMetricName added in v1.40.34 

func (s *FleetMetricNameAndArn) SetMetricName(v string) *FleetMetricNameAndArn

SetMetricName sets the MetricName field's value.

func (FleetMetricNameAndArn) String added in v1.40.34 

func (s FleetMetricNameAndArn) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBehaviorModelTrainingSummariesInput added in v1.36.9 

type GetBehaviorModelTrainingSummariesInput struct {

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

	// The name of the security profile.
	SecurityProfileName *string `location:"querystring" locationName:"securityProfileName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetBehaviorModelTrainingSummariesInput) GoString added in v1.36.9 

func (s GetBehaviorModelTrainingSummariesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBehaviorModelTrainingSummariesInput) SetMaxResults added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesInput) SetMaxResults(v int64) *GetBehaviorModelTrainingSummariesInput

SetMaxResults sets the MaxResults field's value.

func (*GetBehaviorModelTrainingSummariesInput) SetNextToken added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesInput) SetNextToken(v string) *GetBehaviorModelTrainingSummariesInput

SetNextToken sets the NextToken field's value.

func (*GetBehaviorModelTrainingSummariesInput) SetSecurityProfileName added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesInput) SetSecurityProfileName(v string) *GetBehaviorModelTrainingSummariesInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (GetBehaviorModelTrainingSummariesInput) String added in v1.36.9 

func (s GetBehaviorModelTrainingSummariesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBehaviorModelTrainingSummariesInput) Validate added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesInput) Validate() error

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

type GetBehaviorModelTrainingSummariesOutput added in v1.36.9 

type GetBehaviorModelTrainingSummariesOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of all ML Detect behaviors and their model status for a given Security
	// Profile.
	Summaries []*BehaviorModelTrainingSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (GetBehaviorModelTrainingSummariesOutput) GoString added in v1.36.9 

func (s GetBehaviorModelTrainingSummariesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBehaviorModelTrainingSummariesOutput) SetNextToken added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesOutput) SetNextToken(v string) *GetBehaviorModelTrainingSummariesOutput

SetNextToken sets the NextToken field's value.

func (*GetBehaviorModelTrainingSummariesOutput) SetSummaries added in v1.36.9 

func (s *GetBehaviorModelTrainingSummariesOutput) SetSummaries(v []*BehaviorModelTrainingSummary) *GetBehaviorModelTrainingSummariesOutput

SetSummaries sets the Summaries field's value.

func (GetBehaviorModelTrainingSummariesOutput) String added in v1.36.9 

func (s GetBehaviorModelTrainingSummariesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketsAggregationInput added in v1.40.34 

type GetBucketsAggregationInput struct {

	// The aggregation field.
	//
	// AggregationField is a required field
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string" required:"true"`

	// The basic control of the response shape and the bucket aggregation type to
	// perform.
	//
	// BucketsAggregationType is a required field
	BucketsAggregationType *BucketsAggregationType `locationName:"bucketsAggregationType" type:"structure" required:"true"`

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

	// The search query string.
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" min:"1" type:"string" required:"true"`

	// The version of the query.
	QueryVersion *string `locationName:"queryVersion" type:"string"`
	// contains filtered or unexported fields
}

func (GetBucketsAggregationInput) GoString added in v1.40.34 

func (s GetBucketsAggregationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsAggregationInput) SetAggregationField added in v1.40.34 

func (s *GetBucketsAggregationInput) SetAggregationField(v string) *GetBucketsAggregationInput

SetAggregationField sets the AggregationField field's value.

func (*GetBucketsAggregationInput) SetBucketsAggregationType added in v1.40.34 

func (s *GetBucketsAggregationInput) SetBucketsAggregationType(v *BucketsAggregationType) *GetBucketsAggregationInput

SetBucketsAggregationType sets the BucketsAggregationType field's value.

func (*GetBucketsAggregationInput) SetIndexName added in v1.40.34 

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

SetIndexName sets the IndexName field's value.

func (*GetBucketsAggregationInput) SetQueryString added in v1.40.34 

func (s *GetBucketsAggregationInput) SetQueryString(v string) *GetBucketsAggregationInput

SetQueryString sets the QueryString field's value.

func (*GetBucketsAggregationInput) SetQueryVersion added in v1.40.34 

func (s *GetBucketsAggregationInput) SetQueryVersion(v string) *GetBucketsAggregationInput

SetQueryVersion sets the QueryVersion field's value.

func (GetBucketsAggregationInput) String added in v1.40.34 

func (s GetBucketsAggregationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsAggregationInput) Validate added in v1.40.34 

func (s *GetBucketsAggregationInput) Validate() error

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

type GetBucketsAggregationOutput added in v1.40.34 

type GetBucketsAggregationOutput struct {

	// The main part of the response with a list of buckets. Each bucket contains
	// a keyValue and a count.
	//
	// keyValue: The aggregation field value counted for the particular bucket.
	//
	// count: The number of documents that have that value.
	Buckets []*Bucket `locationName:"buckets" type:"list"`

	// The total number of things that fit the query string criteria.
	TotalCount *int64 `locationName:"totalCount" type:"integer"`
	// contains filtered or unexported fields
}

func (GetBucketsAggregationOutput) GoString added in v1.40.34 

func (s GetBucketsAggregationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsAggregationOutput) SetBuckets added in v1.40.34 

func (s *GetBucketsAggregationOutput) SetBuckets(v []*Bucket) *GetBucketsAggregationOutput

SetBuckets sets the Buckets field's value.

func (*GetBucketsAggregationOutput) SetTotalCount added in v1.40.34 

func (s *GetBucketsAggregationOutput) SetTotalCount(v int64) *GetBucketsAggregationOutput

SetTotalCount sets the TotalCount field's value.

func (GetBucketsAggregationOutput) String added in v1.40.34 

func (s GetBucketsAggregationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCardinalityInput added in v1.25.34 

type GetCardinalityInput struct {

	// The field to aggregate.
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string"`

	// The name of the index to search.
	IndexName *string `locationName:"indexName" min:"1" 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 (GetCardinalityInput) GoString added in v1.25.34 

func (s GetCardinalityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCardinalityInput) SetAggregationField added in v1.25.34 

func (s *GetCardinalityInput) SetAggregationField(v string) *GetCardinalityInput

SetAggregationField sets the AggregationField field's value.

func (*GetCardinalityInput) SetIndexName added in v1.25.34 

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

SetIndexName sets the IndexName field's value.

func (*GetCardinalityInput) SetQueryString added in v1.25.34 

func (s *GetCardinalityInput) SetQueryString(v string) *GetCardinalityInput

SetQueryString sets the QueryString field's value.

func (*GetCardinalityInput) SetQueryVersion added in v1.25.34 

func (s *GetCardinalityInput) SetQueryVersion(v string) *GetCardinalityInput

SetQueryVersion sets the QueryVersion field's value.

func (GetCardinalityInput) String added in v1.25.34 

func (s GetCardinalityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCardinalityInput) Validate added in v1.25.34 

func (s *GetCardinalityInput) Validate() error

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

type GetCardinalityOutput added in v1.25.34 

type GetCardinalityOutput struct {

	// The approximate count of unique values that match the query.
	Cardinality *int64 `locationName:"cardinality" type:"integer"`
	// contains filtered or unexported fields
}

func (GetCardinalityOutput) GoString added in v1.25.34 

func (s GetCardinalityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCardinalityOutput) SetCardinality added in v1.25.34 

func (s *GetCardinalityOutput) SetCardinality(v int64) *GetCardinalityOutput

SetCardinality sets the Cardinality field's value.

func (GetCardinalityOutput) String added in v1.25.34 

func (s GetCardinalityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEffectivePoliciesInput added in v1.12.36 

type GetEffectivePoliciesInput struct {

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

	// The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
	// thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId
	// (region:id).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

SetPrincipal sets the Principal field's value.

func (*GetEffectivePoliciesInput) SetThingName added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEffectivePoliciesOutput) SetEffectivePolicies added in v1.12.36 

func (s *GetEffectivePoliciesOutput) SetEffectivePolicies(v []*EffectivePolicy) *GetEffectivePoliciesOutput

SetEffectivePolicies sets the EffectivePolicies field's value.

func (GetEffectivePoliciesOutput) String added in v1.12.36 

func (s GetEffectivePoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIndexingConfigurationInput added in v1.12.36 

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

func (GetIndexingConfigurationInput) GoString added in v1.12.36 

func (s GetIndexingConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetIndexingConfigurationInput) String added in v1.12.36 

func (s GetIndexingConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIndexingConfigurationOutput added in v1.12.36 

type GetIndexingConfigurationOutput struct {

	// The index configuration.
	ThingGroupIndexingConfiguration *ThingGroupIndexingConfiguration `locationName:"thingGroupIndexingConfiguration" type:"structure"`

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

func (GetIndexingConfigurationOutput) GoString added in v1.12.36 

func (s GetIndexingConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIndexingConfigurationOutput) SetThingGroupIndexingConfiguration added in v1.15.19 

func (s *GetIndexingConfigurationOutput) SetThingGroupIndexingConfiguration(v *ThingGroupIndexingConfiguration) *GetIndexingConfigurationOutput

SetThingGroupIndexingConfiguration sets the ThingGroupIndexingConfiguration field's value.

func (*GetIndexingConfigurationOutput) SetThingIndexingConfiguration added in v1.12.36 

func (s *GetIndexingConfigurationOutput) SetThingIndexingConfiguration(v *ThingIndexingConfiguration) *GetIndexingConfigurationOutput

SetThingIndexingConfiguration sets the ThingIndexingConfiguration field's value.

func (GetIndexingConfigurationOutput) String added in v1.12.36 

func (s GetIndexingConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobDocumentInput) SetJobId added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobDocumentOutput) SetDocument added in v1.12.36 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetLoggingOptionsInput) String 

func (s GetLoggingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoggingOptionsOutput) SetLogLevel added in v1.5.0 

func (s *GetLoggingOptionsOutput) SetLogLevel(v string) *GetLoggingOptionsOutput

SetLogLevel sets the LogLevel field's value.

func (*GetLoggingOptionsOutput) SetRoleArn added in v1.5.0 

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

SetRoleArn sets the RoleArn field's value.

func (GetLoggingOptionsOutput) String 

func (s GetLoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPercentilesInput added in v1.25.34 

type GetPercentilesInput struct {

	// The field to aggregate.
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string"`

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

	// The percentile groups returned.
	Percents []*float64 `locationName:"percents" type:"list"`

	// 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 (GetPercentilesInput) GoString added in v1.25.34 

func (s GetPercentilesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPercentilesInput) SetAggregationField added in v1.25.34 

func (s *GetPercentilesInput) SetAggregationField(v string) *GetPercentilesInput

SetAggregationField sets the AggregationField field's value.

func (*GetPercentilesInput) SetIndexName added in v1.25.34 

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

SetIndexName sets the IndexName field's value.

func (*GetPercentilesInput) SetPercents added in v1.25.34 

func (s *GetPercentilesInput) SetPercents(v []*float64) *GetPercentilesInput

SetPercents sets the Percents field's value.

func (*GetPercentilesInput) SetQueryString added in v1.25.34 

func (s *GetPercentilesInput) SetQueryString(v string) *GetPercentilesInput

SetQueryString sets the QueryString field's value.

func (*GetPercentilesInput) SetQueryVersion added in v1.25.34 

func (s *GetPercentilesInput) SetQueryVersion(v string) *GetPercentilesInput

SetQueryVersion sets the QueryVersion field's value.

func (GetPercentilesInput) String added in v1.25.34 

func (s GetPercentilesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPercentilesInput) Validate added in v1.25.34 

func (s *GetPercentilesInput) Validate() error

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

type GetPercentilesOutput added in v1.25.34 

type GetPercentilesOutput struct {

	// The percentile values of the aggregated fields.
	Percentiles []*PercentPair `locationName:"percentiles" type:"list"`
	// contains filtered or unexported fields
}

func (GetPercentilesOutput) GoString added in v1.25.34 

func (s GetPercentilesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPercentilesOutput) SetPercentiles added in v1.25.34 

func (s *GetPercentilesOutput) SetPercentiles(v []*PercentPair) *GetPercentilesOutput

SetPercentiles sets the Percentiles field's value.

func (GetPercentilesOutput) String added in v1.25.34 

func (s GetPercentilesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// 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 was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

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

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetRegistrationCodeInput) String added in v1.1.18 

func (s GetRegistrationCodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStatisticsInput added in v1.19.0 

type GetStatisticsInput struct {

	// The aggregation field name.
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string"`

	// The name of the index to search. The default value is AWS_Things.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

	// The query used to search. You can specify "*" for the query string to get
	// the count of all indexed things in your Amazon Web Services account.
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" min:"1" type:"string" required:"true"`

	// The version of the query used to search.
	QueryVersion *string `locationName:"queryVersion" type:"string"`
	// contains filtered or unexported fields
}

func (GetStatisticsInput) GoString added in v1.19.0 

func (s GetStatisticsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStatisticsInput) SetAggregationField added in v1.19.0 

func (s *GetStatisticsInput) SetAggregationField(v string) *GetStatisticsInput

SetAggregationField sets the AggregationField field's value.

func (*GetStatisticsInput) SetIndexName added in v1.19.0 

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

SetIndexName sets the IndexName field's value.

func (*GetStatisticsInput) SetQueryString added in v1.19.0 

func (s *GetStatisticsInput) SetQueryString(v string) *GetStatisticsInput

SetQueryString sets the QueryString field's value.

func (*GetStatisticsInput) SetQueryVersion added in v1.19.0 

func (s *GetStatisticsInput) SetQueryVersion(v string) *GetStatisticsInput

SetQueryVersion sets the QueryVersion field's value.

func (GetStatisticsInput) String added in v1.19.0 

func (s GetStatisticsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStatisticsInput) Validate added in v1.19.0 

func (s *GetStatisticsInput) Validate() error

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

type GetStatisticsOutput added in v1.19.0 

type GetStatisticsOutput struct {

	// The statistics returned by the Fleet Indexing service based on the query
	// and aggregation field.
	Statistics *Statistics `locationName:"statistics" type:"structure"`
	// contains filtered or unexported fields
}

func (GetStatisticsOutput) GoString added in v1.19.0 

func (s GetStatisticsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStatisticsOutput) SetStatistics added in v1.19.0 

func (s *GetStatisticsOutput) SetStatistics(v *Statistics) *GetStatisticsOutput

SetStatistics sets the Statistics field's value.

func (GetStatisticsOutput) String added in v1.19.0 

func (s GetStatisticsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTopicRuleDestinationInput added in v1.25.38 

type GetTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTopicRuleDestinationInput) GoString added in v1.25.38 

func (s GetTopicRuleDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTopicRuleDestinationInput) SetArn added in v1.25.38 

func (s *GetTopicRuleDestinationInput) SetArn(v string) *GetTopicRuleDestinationInput

SetArn sets the Arn field's value.

func (GetTopicRuleDestinationInput) String added in v1.25.38 

func (s GetTopicRuleDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTopicRuleDestinationInput) Validate added in v1.25.38 

func (s *GetTopicRuleDestinationInput) Validate() error

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

type GetTopicRuleDestinationOutput added in v1.25.38 

type GetTopicRuleDestinationOutput struct {

	// The topic rule destination.
	TopicRuleDestination *TopicRuleDestination `locationName:"topicRuleDestination" type:"structure"`
	// contains filtered or unexported fields
}

func (GetTopicRuleDestinationOutput) GoString added in v1.25.38 

func (s GetTopicRuleDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTopicRuleDestinationOutput) SetTopicRuleDestination added in v1.25.38 

func (s *GetTopicRuleDestinationOutput) SetTopicRuleDestination(v *TopicRuleDestination) *GetTopicRuleDestinationOutput

SetTopicRuleDestination sets the TopicRuleDestination field's value.

func (GetTopicRuleDestinationOutput) String added in v1.25.38 

func (s GetTopicRuleDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTopicRuleOutput) SetRule added in v1.5.0 

func (s *GetTopicRuleOutput) SetRule(v *TopicRule) *GetTopicRuleOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetV2LoggingOptionsInput) String added in v1.12.36 

func (s GetV2LoggingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetV2LoggingOptionsOutput) SetDefaultLogLevel added in v1.12.36 

func (s *GetV2LoggingOptionsOutput) SetDefaultLogLevel(v string) *GetV2LoggingOptionsOutput

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HttpAction added in v1.25.38 

type HttpAction struct {

	// The authentication method to use when sending data to an HTTPS endpoint.
	Auth *HttpAuthorization `locationName:"auth" type:"structure"`

	// The URL to which IoT sends a confirmation message. The value of the confirmation
	// URL must be a prefix of the endpoint URL. If you do not specify a confirmation
	// URL IoT uses the endpoint URL as the confirmation URL. If you use substitution
	// templates in the confirmationUrl, you must create and enable topic rule destinations
	// that match each possible value of the substitution template before traffic
	// is allowed to your endpoint URL.
	ConfirmationUrl *string `locationName:"confirmationUrl" type:"string"`

	// The HTTP headers to send with the message data.
	Headers []*HttpActionHeader `locationName:"headers" type:"list"`

	// The endpoint URL. If substitution templates are used in the URL, you must
	// also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination
	// is created if possible.
	//
	// Url is a required field
	Url *string `locationName:"url" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Send data to an HTTPS endpoint.

func (HttpAction) GoString added in v1.25.38 

func (s HttpAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpAction) SetAuth added in v1.25.38 

func (s *HttpAction) SetAuth(v *HttpAuthorization) *HttpAction

SetAuth sets the Auth field's value.

func (*HttpAction) SetConfirmationUrl added in v1.25.38 

func (s *HttpAction) SetConfirmationUrl(v string) *HttpAction

SetConfirmationUrl sets the ConfirmationUrl field's value.

func (*HttpAction) SetHeaders added in v1.25.38 

func (s *HttpAction) SetHeaders(v []*HttpActionHeader) *HttpAction

SetHeaders sets the Headers field's value.

func (*HttpAction) SetUrl added in v1.25.38 

func (s *HttpAction) SetUrl(v string) *HttpAction

SetUrl sets the Url field's value.

func (HttpAction) String added in v1.25.38 

func (s HttpAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpAction) Validate added in v1.25.38 

func (s *HttpAction) Validate() error

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

type HttpActionHeader added in v1.25.38 

type HttpActionHeader struct {

	// The HTTP header key.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The HTTP header value. Substitution templates are supported.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The HTTP action header.

func (HttpActionHeader) GoString added in v1.25.38 

func (s HttpActionHeader) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpActionHeader) SetKey added in v1.25.38 

func (s *HttpActionHeader) SetKey(v string) *HttpActionHeader

SetKey sets the Key field's value.

func (*HttpActionHeader) SetValue added in v1.25.38 

func (s *HttpActionHeader) SetValue(v string) *HttpActionHeader

SetValue sets the Value field's value.

func (HttpActionHeader) String added in v1.25.38 

func (s HttpActionHeader) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpActionHeader) Validate added in v1.25.38 

func (s *HttpActionHeader) Validate() error

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

type HttpAuthorization added in v1.25.38 

type HttpAuthorization struct {

	// Use Sig V4 authorization. For more information, see Signature Version 4 Signing
	// Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	Sigv4 *SigV4Authorization `locationName:"sigv4" type:"structure"`
	// contains filtered or unexported fields
}

The authorization method used to send messages.

func (HttpAuthorization) GoString added in v1.25.38 

func (s HttpAuthorization) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpAuthorization) SetSigv4 added in v1.25.38 

func (s *HttpAuthorization) SetSigv4(v *SigV4Authorization) *HttpAuthorization

SetSigv4 sets the Sigv4 field's value.

func (HttpAuthorization) String added in v1.25.38 

func (s HttpAuthorization) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpAuthorization) Validate added in v1.25.38 

func (s *HttpAuthorization) Validate() error

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

type HttpContext added in v1.25.42 

type HttpContext struct {

	// The header keys and values in an HTTP authorization request.
	Headers map[string]*string `locationName:"headers" type:"map"`

	// The query string keys and values in an HTTP authorization request.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the HTTP context to use for the test authorizer request.

func (HttpContext) GoString added in v1.25.42 

func (s HttpContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpContext) SetHeaders added in v1.25.42 

func (s *HttpContext) SetHeaders(v map[string]*string) *HttpContext

SetHeaders sets the Headers field's value.

func (*HttpContext) SetQueryString added in v1.25.42 

func (s *HttpContext) SetQueryString(v string) *HttpContext

SetQueryString sets the QueryString field's value.

func (HttpContext) String added in v1.25.42 

func (s HttpContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpContext) Validate added in v1.25.42 

func (s *HttpContext) Validate() error

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

type HttpUrlDestinationConfiguration added in v1.25.38 

type HttpUrlDestinationConfiguration struct {

	// The URL IoT uses to confirm ownership of or access to the topic rule destination
	// URL.
	//
	// ConfirmationUrl is a required field
	ConfirmationUrl *string `locationName:"confirmationUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

HTTP URL destination configuration used by the topic rule's HTTP action.

func (HttpUrlDestinationConfiguration) GoString added in v1.25.38 

func (s HttpUrlDestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpUrlDestinationConfiguration) SetConfirmationUrl added in v1.25.38 

func (s *HttpUrlDestinationConfiguration) SetConfirmationUrl(v string) *HttpUrlDestinationConfiguration

SetConfirmationUrl sets the ConfirmationUrl field's value.

func (HttpUrlDestinationConfiguration) String added in v1.25.38 

func (s HttpUrlDestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpUrlDestinationConfiguration) Validate added in v1.25.38 

func (s *HttpUrlDestinationConfiguration) Validate() error

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

type HttpUrlDestinationProperties added in v1.25.38 

type HttpUrlDestinationProperties struct {

	// The URL used to confirm the HTTP topic rule destination URL.
	ConfirmationUrl *string `locationName:"confirmationUrl" type:"string"`
	// contains filtered or unexported fields
}

HTTP URL destination properties.

func (HttpUrlDestinationProperties) GoString added in v1.25.38 

func (s HttpUrlDestinationProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpUrlDestinationProperties) SetConfirmationUrl added in v1.25.38 

func (s *HttpUrlDestinationProperties) SetConfirmationUrl(v string) *HttpUrlDestinationProperties

SetConfirmationUrl sets the ConfirmationUrl field's value.

func (HttpUrlDestinationProperties) String added in v1.25.38 

func (s HttpUrlDestinationProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HttpUrlDestinationSummary added in v1.25.38 

type HttpUrlDestinationSummary struct {

	// The URL used to confirm ownership of or access to the HTTP topic rule destination
	// URL.
	ConfirmationUrl *string `locationName:"confirmationUrl" type:"string"`
	// contains filtered or unexported fields
}

Information about an HTTP URL destination.

func (HttpUrlDestinationSummary) GoString added in v1.25.38 

func (s HttpUrlDestinationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpUrlDestinationSummary) SetConfirmationUrl added in v1.25.38 

func (s *HttpUrlDestinationSummary) SetConfirmationUrl(v string) *HttpUrlDestinationSummary

SetConfirmationUrl sets the ConfirmationUrl field's value.

func (HttpUrlDestinationSummary) String added in v1.25.38 

func (s HttpUrlDestinationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IndexNotReadyException added in v1.28.0 

type IndexNotReadyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The index is not ready.

func (*IndexNotReadyException) Code added in v1.28.0 

func (s *IndexNotReadyException) Code() string

Code returns the exception type name.

func (*IndexNotReadyException) Error added in v1.28.0 

func (s *IndexNotReadyException) Error() string

func (IndexNotReadyException) GoString added in v1.28.0 

func (s IndexNotReadyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexNotReadyException) Message added in v1.28.0 

func (s *IndexNotReadyException) Message() string

Message returns the exception's message.

func (*IndexNotReadyException) OrigErr added in v1.28.0 

func (s *IndexNotReadyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IndexNotReadyException) RequestID added in v1.28.0 

func (s *IndexNotReadyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IndexNotReadyException) StatusCode added in v1.28.0 

func (s *IndexNotReadyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IndexNotReadyException) String added in v1.28.0 

func (s IndexNotReadyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalException added in v1.28.0 

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalException) Code added in v1.28.0 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error added in v1.28.0 

func (s *InternalException) Error() string

func (InternalException) GoString added in v1.28.0 

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message added in v1.28.0 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr added in v1.28.0 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID added in v1.28.0 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode added in v1.28.0 

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String added in v1.28.0 

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException added in v1.28.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException added in v1.42.11 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Internal error from the service that indicates an unexpected error or that the service is unavailable.

func (*InternalServerException) Code added in v1.42.11 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.42.11 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.42.11 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.42.11 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.42.11 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.42.11 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.42.11 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.42.11 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidAggregationException added in v1.28.0 

type InvalidAggregationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The aggregation is invalid.

func (*InvalidAggregationException) Code added in v1.28.0 

func (s *InvalidAggregationException) Code() string

Code returns the exception type name.

func (*InvalidAggregationException) Error added in v1.28.0 

func (s *InvalidAggregationException) Error() string

func (InvalidAggregationException) GoString added in v1.28.0 

func (s InvalidAggregationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidAggregationException) Message added in v1.28.0 

func (s *InvalidAggregationException) Message() string

Message returns the exception's message.

func (*InvalidAggregationException) OrigErr added in v1.28.0 

func (s *InvalidAggregationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidAggregationException) RequestID added in v1.28.0 

func (s *InvalidAggregationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidAggregationException) StatusCode added in v1.28.0 

func (s *InvalidAggregationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidAggregationException) String added in v1.28.0 

func (s InvalidAggregationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidQueryException added in v1.28.0 

type InvalidQueryException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query is invalid.

func (*InvalidQueryException) Code added in v1.28.0 

func (s *InvalidQueryException) Code() string

Code returns the exception type name.

func (*InvalidQueryException) Error added in v1.28.0 

func (s *InvalidQueryException) Error() string

func (InvalidQueryException) GoString added in v1.28.0 

func (s InvalidQueryException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidQueryException) Message added in v1.28.0 

func (s *InvalidQueryException) Message() string

Message returns the exception's message.

func (*InvalidQueryException) OrigErr added in v1.28.0 

func (s *InvalidQueryException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidQueryException) RequestID added in v1.28.0 

func (s *InvalidQueryException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidQueryException) StatusCode added in v1.28.0 

func (s *InvalidQueryException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidQueryException) String added in v1.28.0 

func (s InvalidQueryException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request is not valid.

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidResponseException added in v1.28.0 

type InvalidResponseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The response is invalid.

func (*InvalidResponseException) Code added in v1.28.0 

func (s *InvalidResponseException) Code() string

Code returns the exception type name.

func (*InvalidResponseException) Error added in v1.28.0 

func (s *InvalidResponseException) Error() string

func (InvalidResponseException) GoString added in v1.28.0 

func (s InvalidResponseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidResponseException) Message added in v1.28.0 

func (s *InvalidResponseException) Message() string

Message returns the exception's message.

func (*InvalidResponseException) OrigErr added in v1.28.0 

func (s *InvalidResponseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResponseException) RequestID added in v1.28.0 

func (s *InvalidResponseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResponseException) StatusCode added in v1.28.0 

func (s *InvalidResponseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidResponseException) String added in v1.28.0 

func (s InvalidResponseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidStateTransitionException added in v1.28.0 

type InvalidStateTransitionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidStateTransitionException) Code added in v1.28.0 

func (s *InvalidStateTransitionException) Code() string

Code returns the exception type name.

func (*InvalidStateTransitionException) Error added in v1.28.0 

func (s *InvalidStateTransitionException) Error() string

func (InvalidStateTransitionException) GoString added in v1.28.0 

func (s InvalidStateTransitionException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidStateTransitionException) Message added in v1.28.0 

func (s *InvalidStateTransitionException) Message() string

Message returns the exception's message.

func (*InvalidStateTransitionException) OrigErr added in v1.28.0 

func (s *InvalidStateTransitionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidStateTransitionException) RequestID added in v1.28.0 

func (s *InvalidStateTransitionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidStateTransitionException) StatusCode added in v1.28.0 

func (s *InvalidStateTransitionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidStateTransitionException) String added in v1.28.0 

func (s InvalidStateTransitionException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: 

mySession := session.Must(session.NewSession())

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

Requires permission to access the AcceptCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) AddThingToBillingGroup added in v1.15.79 

func (c *IoT) AddThingToBillingGroup(input *AddThingToBillingGroupInput) (*AddThingToBillingGroupOutput, error)

AddThingToBillingGroup API operation for AWS IoT.

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) AddThingToBillingGroupRequest added in v1.15.79 

func (c *IoT) AddThingToBillingGroupRequest(input *AddThingToBillingGroupInput) (req *request.Request, output *AddThingToBillingGroupOutput)

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

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 AddThingToBillingGroup for more information on using the AddThingToBillingGroup 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 AddThingToBillingGroupRequest method.
req, resp := client.AddThingToBillingGroupRequest(params)

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

func (*IoT) AddThingToBillingGroupWithContext added in v1.15.79 

func (c *IoT) AddThingToBillingGroupWithContext(ctx aws.Context, input *AddThingToBillingGroupInput, opts ...request.Option) (*AddThingToBillingGroupOutput, error)

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

See AddThingToBillingGroup 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.

Requires permission to access the AddThingToThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the AssociateTargetsWithJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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 the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 deprecated 

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 action is deprecated. Please use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

Deprecated: AttachPrincipalPolicy has been deprecated

func (*IoT) AttachPrincipalPolicyRequest deprecated 

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

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

Deprecated: AttachPrincipalPolicy has been deprecated

func (*IoT) AttachPrincipalPolicyWithContext deprecated 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.

Deprecated: AttachPrincipalPolicyWithContext has been deprecated

func (*IoT) AttachSecurityProfile added in v1.15.2 

func (c *IoT) AttachSecurityProfile(input *AttachSecurityProfileInput) (*AttachSecurityProfileOutput, error)

AttachSecurityProfile API operation for AWS IoT.

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

Requires permission to access the AttachSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • LimitExceededException A limit has been exceeded.

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

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) AttachSecurityProfileRequest added in v1.15.2 

func (c *IoT) AttachSecurityProfileRequest(input *AttachSecurityProfileInput) (req *request.Request, output *AttachSecurityProfileOutput)

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

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 AttachSecurityProfile for more information on using the AttachSecurityProfile 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 AttachSecurityProfileRequest method.
req, resp := client.AttachSecurityProfileRequest(params)

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

func (*IoT) AttachSecurityProfileWithContext added in v1.15.2 

func (c *IoT) AttachSecurityProfileWithContext(ctx aws.Context, input *AttachSecurityProfileInput, opts ...request.Option) (*AttachSecurityProfileOutput, error)

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

See AttachSecurityProfile 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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CancelAuditMitigationActionsTask added in v1.21.10 

func (c *IoT) CancelAuditMitigationActionsTask(input *CancelAuditMitigationActionsTaskInput) (*CancelAuditMitigationActionsTaskOutput, error)

CancelAuditMitigationActionsTask API operation for AWS IoT.

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

Requires permission to access the CancelAuditMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CancelAuditMitigationActionsTaskRequest added in v1.21.10 

func (c *IoT) CancelAuditMitigationActionsTaskRequest(input *CancelAuditMitigationActionsTaskInput) (req *request.Request, output *CancelAuditMitigationActionsTaskOutput)

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

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 CancelAuditMitigationActionsTask for more information on using the CancelAuditMitigationActionsTask 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 CancelAuditMitigationActionsTaskRequest method.
req, resp := client.CancelAuditMitigationActionsTaskRequest(params)

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

func (*IoT) CancelAuditMitigationActionsTaskWithContext added in v1.21.10 

func (c *IoT) CancelAuditMitigationActionsTaskWithContext(ctx aws.Context, input *CancelAuditMitigationActionsTaskInput, opts ...request.Option) (*CancelAuditMitigationActionsTaskOutput, error)

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

See CancelAuditMitigationActionsTask 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) CancelAuditTask added in v1.15.2 

func (c *IoT) CancelAuditTask(input *CancelAuditTaskInput) (*CancelAuditTaskOutput, error)

CancelAuditTask API operation for AWS IoT.

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

Requires permission to access the CancelAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CancelAuditTaskRequest added in v1.15.2 

func (c *IoT) CancelAuditTaskRequest(input *CancelAuditTaskInput) (req *request.Request, output *CancelAuditTaskOutput)

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

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 CancelAuditTask for more information on using the CancelAuditTask 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 CancelAuditTaskRequest method.
req, resp := client.CancelAuditTaskRequest(params)

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

func (*IoT) CancelAuditTaskWithContext added in v1.15.2 

func (c *IoT) CancelAuditTaskWithContext(ctx aws.Context, input *CancelAuditTaskInput, opts ...request.Option) (*CancelAuditTaskOutput, error)

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

See CancelAuditTask 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, 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.

Requires permission to access the CancelCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CancelDetectMitigationActionsTask added in v1.36.9 

func (c *IoT) CancelDetectMitigationActionsTask(input *CancelDetectMitigationActionsTaskInput) (*CancelDetectMitigationActionsTaskOutput, error)

CancelDetectMitigationActionsTask API operation for AWS IoT.

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CancelDetectMitigationActionsTaskRequest added in v1.36.9 

func (c *IoT) CancelDetectMitigationActionsTaskRequest(input *CancelDetectMitigationActionsTaskInput) (req *request.Request, output *CancelDetectMitigationActionsTaskOutput)

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

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 CancelDetectMitigationActionsTask for more information on using the CancelDetectMitigationActionsTask 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 CancelDetectMitigationActionsTaskRequest method.
req, resp := client.CancelDetectMitigationActionsTaskRequest(params)

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

func (*IoT) CancelDetectMitigationActionsTaskWithContext added in v1.36.9 

func (c *IoT) CancelDetectMitigationActionsTaskWithContext(ctx aws.Context, input *CancelDetectMitigationActionsTaskInput, opts ...request.Option) (*CancelDetectMitigationActionsTaskOutput, error)

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

See CancelDetectMitigationActionsTask 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.

Requires permission to access the CancelJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • LimitExceededException A limit has been exceeded.

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.

Requires permission to access the CancelJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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

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.

Requires permission to access the ClearDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) ConfirmTopicRuleDestination added in v1.25.38 

func (c *IoT) ConfirmTopicRuleDestination(input *ConfirmTopicRuleDestinationInput) (*ConfirmTopicRuleDestinationOutput, error)

ConfirmTopicRuleDestination API operation for AWS IoT.

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

Requires permission to access the ConfirmTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) ConfirmTopicRuleDestinationRequest added in v1.25.38 

func (c *IoT) ConfirmTopicRuleDestinationRequest(input *ConfirmTopicRuleDestinationInput) (req *request.Request, output *ConfirmTopicRuleDestinationOutput)

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

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 ConfirmTopicRuleDestination for more information on using the ConfirmTopicRuleDestination 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 ConfirmTopicRuleDestinationRequest method.
req, resp := client.ConfirmTopicRuleDestinationRequest(params)

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

func (*IoT) ConfirmTopicRuleDestinationWithContext added in v1.25.38 

func (c *IoT) ConfirmTopicRuleDestinationWithContext(ctx aws.Context, input *ConfirmTopicRuleDestinationInput, opts ...request.Option) (*ConfirmTopicRuleDestinationOutput, error)

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

See ConfirmTopicRuleDestination 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) CreateAuditSuppression added in v1.34.3 

func (c *IoT) CreateAuditSuppression(input *CreateAuditSuppressionInput) (*CreateAuditSuppressionOutput, error)

CreateAuditSuppression API operation for AWS IoT.

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

func (*IoT) CreateAuditSuppressionRequest added in v1.34.3 

func (c *IoT) CreateAuditSuppressionRequest(input *CreateAuditSuppressionInput) (req *request.Request, output *CreateAuditSuppressionOutput)

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

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 CreateAuditSuppression for more information on using the CreateAuditSuppression 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 CreateAuditSuppressionRequest method.
req, resp := client.CreateAuditSuppressionRequest(params)

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

func (*IoT) CreateAuditSuppressionWithContext added in v1.34.3 

func (c *IoT) CreateAuditSuppressionWithContext(ctx aws.Context, input *CreateAuditSuppressionInput, opts ...request.Option) (*CreateAuditSuppressionOutput, error)

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

See CreateAuditSuppression 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.

Requires permission to access the CreateAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceAlreadyExistsException The resource already exists.

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CreateBillingGroup added in v1.15.79 

func (c *IoT) CreateBillingGroup(input *CreateBillingGroupInput) (*CreateBillingGroupOutput, error)

CreateBillingGroup API operation for AWS IoT.

Creates a billing group.

Requires permission to access the CreateBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateBillingGroupRequest added in v1.15.79 

func (c *IoT) CreateBillingGroupRequest(input *CreateBillingGroupInput) (req *request.Request, output *CreateBillingGroupOutput)

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

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 CreateBillingGroup for more information on using the CreateBillingGroup 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 CreateBillingGroupRequest method.
req, resp := client.CreateBillingGroupRequest(params)

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

func (*IoT) CreateBillingGroupWithContext added in v1.15.79 

func (c *IoT) CreateBillingGroupWithContext(ctx aws.Context, input *CreateBillingGroupInput, opts ...request.Option) (*CreateBillingGroupOutput, error)

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

See CreateBillingGroup 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms).

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

Requires permission to access the CreateCertificateFromCsr (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Amazon Web Services 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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CreateCustomMetric added in v1.36.9 

func (c *IoT) CreateCustomMetric(input *CreateCustomMetricInput) (*CreateCustomMetricOutput, error)

CreateCustomMetric API operation for AWS IoT.

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateCustomMetricRequest added in v1.36.9 

func (c *IoT) CreateCustomMetricRequest(input *CreateCustomMetricInput) (req *request.Request, output *CreateCustomMetricOutput)

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

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 CreateCustomMetric for more information on using the CreateCustomMetric 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 CreateCustomMetricRequest method.
req, resp := client.CreateCustomMetricRequest(params)

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

func (*IoT) CreateCustomMetricWithContext added in v1.36.9 

func (c *IoT) CreateCustomMetricWithContext(ctx aws.Context, input *CreateCustomMetricInput, opts ...request.Option) (*CreateCustomMetricOutput, error)

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

See CreateCustomMetric 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) CreateDimension added in v1.30.2 

func (c *IoT) CreateDimension(input *CreateDimensionInput) (*CreateDimensionOutput, error)

CreateDimension API operation for AWS IoT.

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Requires permission to access the CreateDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) CreateDimensionRequest added in v1.30.2 

func (c *IoT) CreateDimensionRequest(input *CreateDimensionInput) (req *request.Request, output *CreateDimensionOutput)

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

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 CreateDimension for more information on using the CreateDimension 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 CreateDimensionRequest method.
req, resp := client.CreateDimensionRequest(params)

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

func (*IoT) CreateDimensionWithContext added in v1.30.2 

func (c *IoT) CreateDimensionWithContext(ctx aws.Context, input *CreateDimensionInput, opts ...request.Option) (*CreateDimensionOutput, error)

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

See CreateDimension 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) CreateDomainConfiguration added in v1.25.42 

func (c *IoT) CreateDomainConfiguration(input *CreateDomainConfigurationInput) (*CreateDomainConfigurationOutput, error)

CreateDomainConfiguration API operation for AWS IoT.

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • LimitExceededException A limit has been exceeded.

  • CertificateValidationException The certificate is invalid.

  • ResourceAlreadyExistsException The resource already exists.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • UnauthorizedException You are not authorized to perform this operation.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) CreateDomainConfigurationRequest added in v1.25.42 

func (c *IoT) CreateDomainConfigurationRequest(input *CreateDomainConfigurationInput) (req *request.Request, output *CreateDomainConfigurationOutput)

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

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 CreateDomainConfiguration for more information on using the CreateDomainConfiguration 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 CreateDomainConfigurationRequest method.
req, resp := client.CreateDomainConfigurationRequest(params)

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

func (*IoT) CreateDomainConfigurationWithContext added in v1.25.42 

func (c *IoT) CreateDomainConfigurationWithContext(ctx aws.Context, input *CreateDomainConfigurationInput, opts ...request.Option) (*CreateDomainConfigurationOutput, error)

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

See CreateDomainConfiguration 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) CreateDynamicThingGroup added in v1.15.79 

func (c *IoT) CreateDynamicThingGroup(input *CreateDynamicThingGroupInput) (*CreateDynamicThingGroupOutput, error)

CreateDynamicThingGroup API operation for AWS IoT.

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • InvalidQueryException The query is invalid.

  • LimitExceededException A limit has been exceeded.

func (*IoT) CreateDynamicThingGroupRequest added in v1.15.79 

func (c *IoT) CreateDynamicThingGroupRequest(input *CreateDynamicThingGroupInput) (req *request.Request, output *CreateDynamicThingGroupOutput)

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

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 CreateDynamicThingGroup for more information on using the CreateDynamicThingGroup 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 CreateDynamicThingGroupRequest method.
req, resp := client.CreateDynamicThingGroupRequest(params)

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

func (*IoT) CreateDynamicThingGroupWithContext added in v1.15.79 

func (c *IoT) CreateDynamicThingGroupWithContext(ctx aws.Context, input *CreateDynamicThingGroupInput, opts ...request.Option) (*CreateDynamicThingGroupOutput, error)

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

See CreateDynamicThingGroup 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) CreateFleetMetric added in v1.40.34 

func (c *IoT) CreateFleetMetric(input *CreateFleetMetricInput) (*CreateFleetMetricOutput, error)

CreateFleetMetric API operation for AWS IoT.

Creates a fleet metric.

Requires permission to access the CreateFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • IndexNotReadyException The index is not ready.

func (*IoT) CreateFleetMetricRequest added in v1.40.34 

func (c *IoT) CreateFleetMetricRequest(input *CreateFleetMetricInput) (req *request.Request, output *CreateFleetMetricOutput)

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

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 CreateFleetMetric for more information on using the CreateFleetMetric 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 CreateFleetMetricRequest method.
req, resp := client.CreateFleetMetricRequest(params)

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

func (*IoT) CreateFleetMetricWithContext added in v1.40.34 

func (c *IoT) CreateFleetMetricWithContext(ctx aws.Context, input *CreateFleetMetricInput, opts ...request.Option) (*CreateFleetMetricOutput, error)

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

See CreateFleetMetric 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.

Requires permission to access the CreateJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ResourceAlreadyExistsException The resource already exists.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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) CreateJobTemplate added in v1.38.47 

func (c *IoT) CreateJobTemplate(input *CreateJobTemplateInput) (*CreateJobTemplateOutput, error)

CreateJobTemplate API operation for AWS IoT.

Creates a job template.

Requires permission to access the CreateJobTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ConflictException A resource with the same name already exists.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateJobTemplateRequest added in v1.38.47 

func (c *IoT) CreateJobTemplateRequest(input *CreateJobTemplateInput) (req *request.Request, output *CreateJobTemplateOutput)

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

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 CreateJobTemplate for more information on using the CreateJobTemplate 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 CreateJobTemplateRequest method.
req, resp := client.CreateJobTemplateRequest(params)

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

func (*IoT) CreateJobTemplateWithContext added in v1.38.47 

func (c *IoT) CreateJobTemplateWithContext(ctx aws.Context, input *CreateJobTemplateInput, opts ...request.Option) (*CreateJobTemplateOutput, error)

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

See CreateJobTemplate 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) 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. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API (https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api).

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

Requires permission to access the CreateKeysAndCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CreateMitigationAction added in v1.21.10 

func (c *IoT) CreateMitigationAction(input *CreateMitigationActionInput) (*CreateMitigationActionOutput, error)

CreateMitigationAction API operation for AWS IoT.

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html). Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateMitigationActionRequest added in v1.21.10 

func (c *IoT) CreateMitigationActionRequest(input *CreateMitigationActionInput) (req *request.Request, output *CreateMitigationActionOutput)

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

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 CreateMitigationAction for more information on using the CreateMitigationAction 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 CreateMitigationActionRequest method.
req, resp := client.CreateMitigationActionRequest(params)

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

func (*IoT) CreateMitigationActionWithContext added in v1.21.10 

func (c *IoT) CreateMitigationActionWithContext(ctx aws.Context, input *CreateMitigationActionInput, opts ...request.Option) (*CreateMitigationActionOutput, error)

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

See CreateMitigationAction 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 IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ResourceNotFoundException The specified resource does not exist.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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

Requires permission to access the CreatePolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceAlreadyExistsException The resource already exists.

  • MalformedPolicyException The policy documentation is not valid.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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

Requires permission to access the CreatePolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • MalformedPolicyException The policy documentation is not valid.

  • VersionsLimitExceededException The number of policy versions exceeds the limit.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CreateProvisioningClaim added in v1.25.42 

func (c *IoT) CreateProvisioningClaim(input *CreateProvisioningClaimInput) (*CreateProvisioningClaimOutput, error)

CreateProvisioningClaim API operation for AWS IoT.

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateProvisioningClaimRequest added in v1.25.42 

func (c *IoT) CreateProvisioningClaimRequest(input *CreateProvisioningClaimInput) (req *request.Request, output *CreateProvisioningClaimOutput)

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

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 CreateProvisioningClaim for more information on using the CreateProvisioningClaim 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 CreateProvisioningClaimRequest method.
req, resp := client.CreateProvisioningClaimRequest(params)

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

func (*IoT) CreateProvisioningClaimWithContext added in v1.25.42 

func (c *IoT) CreateProvisioningClaimWithContext(ctx aws.Context, input *CreateProvisioningClaimInput, opts ...request.Option) (*CreateProvisioningClaimOutput, error)

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

See CreateProvisioningClaim 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) CreateProvisioningTemplate added in v1.25.42 

func (c *IoT) CreateProvisioningTemplate(input *CreateProvisioningTemplateInput) (*CreateProvisioningTemplateOutput, error)

CreateProvisioningTemplate API operation for AWS IoT.

Creates a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ResourceAlreadyExistsException The resource already exists.

func (*IoT) CreateProvisioningTemplateRequest added in v1.25.42 

func (c *IoT) CreateProvisioningTemplateRequest(input *CreateProvisioningTemplateInput) (req *request.Request, output *CreateProvisioningTemplateOutput)

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

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 CreateProvisioningTemplate for more information on using the CreateProvisioningTemplate 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 CreateProvisioningTemplateRequest method.
req, resp := client.CreateProvisioningTemplateRequest(params)

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

func (*IoT) CreateProvisioningTemplateVersion added in v1.25.42 

func (c *IoT) CreateProvisioningTemplateVersion(input *CreateProvisioningTemplateVersionInput) (*CreateProvisioningTemplateVersionOutput, error)

CreateProvisioningTemplateVersion API operation for AWS IoT.

Creates a new version of a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • VersionsLimitExceededException The number of policy versions exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) CreateProvisioningTemplateVersionRequest added in v1.25.42 

func (c *IoT) CreateProvisioningTemplateVersionRequest(input *CreateProvisioningTemplateVersionInput) (req *request.Request, output *CreateProvisioningTemplateVersionOutput)

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

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 CreateProvisioningTemplateVersion for more information on using the CreateProvisioningTemplateVersion 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 CreateProvisioningTemplateVersionRequest method.
req, resp := client.CreateProvisioningTemplateVersionRequest(params)

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

func (*IoT) CreateProvisioningTemplateVersionWithContext added in v1.25.42 

func (c *IoT) CreateProvisioningTemplateVersionWithContext(ctx aws.Context, input *CreateProvisioningTemplateVersionInput, opts ...request.Option) (*CreateProvisioningTemplateVersionOutput, error)

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

See CreateProvisioningTemplateVersion 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) CreateProvisioningTemplateWithContext added in v1.25.42 

func (c *IoT) CreateProvisioningTemplateWithContext(ctx aws.Context, input *CreateProvisioningTemplateInput, opts ...request.Option) (*CreateProvisioningTemplateOutput, error)

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

See CreateProvisioningTemplate 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.

Requires permission to access the CreateRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceAlreadyExistsException The resource already exists.

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) CreateScheduledAudit added in v1.15.2 

func (c *IoT) CreateScheduledAudit(input *CreateScheduledAuditInput) (*CreateScheduledAuditOutput, error)

CreateScheduledAudit API operation for AWS IoT.

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

func (*IoT) CreateScheduledAuditRequest added in v1.15.2 

func (c *IoT) CreateScheduledAuditRequest(input *CreateScheduledAuditInput) (req *request.Request, output *CreateScheduledAuditOutput)

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

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 CreateScheduledAudit for more information on using the CreateScheduledAudit 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 CreateScheduledAuditRequest method.
req, resp := client.CreateScheduledAuditRequest(params)

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

func (*IoT) CreateScheduledAuditWithContext added in v1.15.2 

func (c *IoT) CreateScheduledAuditWithContext(ctx aws.Context, input *CreateScheduledAuditInput, opts ...request.Option) (*CreateScheduledAuditOutput, error)

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

See CreateScheduledAudit 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) CreateSecurityProfile added in v1.15.2 

func (c *IoT) CreateSecurityProfile(input *CreateSecurityProfileInput) (*CreateSecurityProfileOutput, error)

CreateSecurityProfile API operation for AWS IoT.

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) CreateSecurityProfileRequest added in v1.15.2 

func (c *IoT) CreateSecurityProfileRequest(input *CreateSecurityProfileInput) (req *request.Request, output *CreateSecurityProfileOutput)

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

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 CreateSecurityProfile for more information on using the CreateSecurityProfile 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 CreateSecurityProfileRequest method.
req, resp := client.CreateSecurityProfileRequest(params)

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

func (*IoT) CreateSecurityProfileWithContext added in v1.15.2 

func (c *IoT) CreateSecurityProfileWithContext(ctx aws.Context, input *CreateSecurityProfileInput, opts ...request.Option) (*CreateSecurityProfileOutput, error)

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

See CreateSecurityProfile 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.

Requires permission to access the CreateStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ResourceNotFoundException The specified resource does not exist.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) for information about authorizing control plane actions.

Requires permission to access the CreateThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceAlreadyExistsException The resource already exists.

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

This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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

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.

Requires permission to access the CreateThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the CreateTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

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

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ServiceUnavailableException The service is temporarily unavailable.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) CreateTopicRuleDestination added in v1.25.38 

func (c *IoT) CreateTopicRuleDestination(input *CreateTopicRuleDestinationInput) (*CreateTopicRuleDestinationOutput, error)

CreateTopicRuleDestination API operation for AWS IoT.

Creates a topic rule destination. The destination must be confirmed prior to use.

Requires permission to access the CreateTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceAlreadyExistsException The resource already exists.

  • ServiceUnavailableException The service is temporarily unavailable.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) CreateTopicRuleDestinationRequest added in v1.25.38 

func (c *IoT) CreateTopicRuleDestinationRequest(input *CreateTopicRuleDestinationInput) (req *request.Request, output *CreateTopicRuleDestinationOutput)

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

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 CreateTopicRuleDestination for more information on using the CreateTopicRuleDestination 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 CreateTopicRuleDestinationRequest method.
req, resp := client.CreateTopicRuleDestinationRequest(params)

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

func (*IoT) CreateTopicRuleDestinationWithContext added in v1.25.38 

func (c *IoT) CreateTopicRuleDestinationWithContext(ctx aws.Context, input *CreateTopicRuleDestinationInput, opts ...request.Option) (*CreateTopicRuleDestinationOutput, error)

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

See CreateTopicRuleDestination 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) 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 successfully.

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) DeleteAccountAuditConfiguration added in v1.15.2 

func (c *IoT) DeleteAccountAuditConfiguration(input *DeleteAccountAuditConfigurationInput) (*DeleteAccountAuditConfigurationOutput, error)

DeleteAccountAuditConfiguration API operation for AWS IoT.

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

Requires permission to access the DeleteAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteAccountAuditConfigurationRequest added in v1.15.2 

func (c *IoT) DeleteAccountAuditConfigurationRequest(input *DeleteAccountAuditConfigurationInput) (req *request.Request, output *DeleteAccountAuditConfigurationOutput)

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

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 DeleteAccountAuditConfiguration for more information on using the DeleteAccountAuditConfiguration 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 DeleteAccountAuditConfigurationRequest method.
req, resp := client.DeleteAccountAuditConfigurationRequest(params)

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

func (*IoT) DeleteAccountAuditConfigurationWithContext added in v1.15.2 

func (c *IoT) DeleteAccountAuditConfigurationWithContext(ctx aws.Context, input *DeleteAccountAuditConfigurationInput, opts ...request.Option) (*DeleteAccountAuditConfigurationOutput, error)

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

See DeleteAccountAuditConfiguration 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) DeleteAuditSuppression added in v1.34.3 

func (c *IoT) DeleteAuditSuppression(input *DeleteAuditSuppressionInput) (*DeleteAuditSuppressionOutput, error)

DeleteAuditSuppression API operation for AWS IoT.

Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteAuditSuppressionRequest added in v1.34.3 

func (c *IoT) DeleteAuditSuppressionRequest(input *DeleteAuditSuppressionInput) (req *request.Request, output *DeleteAuditSuppressionOutput)

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

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 DeleteAuditSuppression for more information on using the DeleteAuditSuppression 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 DeleteAuditSuppressionRequest method.
req, resp := client.DeleteAuditSuppressionRequest(params)

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

func (*IoT) DeleteAuditSuppressionWithContext added in v1.34.3 

func (c *IoT) DeleteAuditSuppressionWithContext(ctx aws.Context, input *DeleteAuditSuppressionInput, opts ...request.Option) (*DeleteAuditSuppressionOutput, error)

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

See DeleteAuditSuppression 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.

Requires permission to access the DeleteAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

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

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) DeleteBillingGroup added in v1.15.79 

func (c *IoT) DeleteBillingGroup(input *DeleteBillingGroupInput) (*DeleteBillingGroupOutput, error)

DeleteBillingGroup API operation for AWS IoT.

Deletes the billing group.

Requires permission to access the DeleteBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

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

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteBillingGroupRequest added in v1.15.79 

func (c *IoT) DeleteBillingGroupRequest(input *DeleteBillingGroupInput) (req *request.Request, output *DeleteBillingGroupOutput)

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

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 DeleteBillingGroup for more information on using the DeleteBillingGroup 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 DeleteBillingGroupRequest method.
req, resp := client.DeleteBillingGroupRequest(params)

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

func (*IoT) DeleteBillingGroupWithContext added in v1.15.79 

func (c *IoT) DeleteBillingGroupWithContext(ctx aws.Context, input *DeleteBillingGroupInput, opts ...request.Option) (*DeleteBillingGroupOutput, error)

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

See DeleteBillingGroup 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.

Requires permission to access the DeleteCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • CertificateStateException The certificate operation is not allowed.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.

Requires permission to access the DeleteCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • CertificateStateException The certificate operation is not allowed.

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) DeleteCustomMetric added in v1.36.9 

func (c *IoT) DeleteCustomMetric(input *DeleteCustomMetricInput) (*DeleteCustomMetricOutput, error)

DeleteCustomMetric API operation for AWS IoT.

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles (https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html) API with metricName set to your custom metric name.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteCustomMetricRequest added in v1.36.9 

func (c *IoT) DeleteCustomMetricRequest(input *DeleteCustomMetricInput) (req *request.Request, output *DeleteCustomMetricOutput)

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

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 DeleteCustomMetric for more information on using the DeleteCustomMetric 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 DeleteCustomMetricRequest method.
req, resp := client.DeleteCustomMetricRequest(params)

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

func (*IoT) DeleteCustomMetricWithContext added in v1.36.9 

func (c *IoT) DeleteCustomMetricWithContext(ctx aws.Context, input *DeleteCustomMetricInput, opts ...request.Option) (*DeleteCustomMetricOutput, error)

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

See DeleteCustomMetric 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) DeleteDimension added in v1.30.2 

func (c *IoT) DeleteDimension(input *DeleteDimensionInput) (*DeleteDimensionOutput, error)

DeleteDimension API operation for AWS IoT.

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) DeleteDimensionRequest added in v1.30.2 

func (c *IoT) DeleteDimensionRequest(input *DeleteDimensionInput) (req *request.Request, output *DeleteDimensionOutput)

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

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 DeleteDimension for more information on using the DeleteDimension 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 DeleteDimensionRequest method.
req, resp := client.DeleteDimensionRequest(params)

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

func (*IoT) DeleteDimensionWithContext added in v1.30.2 

func (c *IoT) DeleteDimensionWithContext(ctx aws.Context, input *DeleteDimensionInput, opts ...request.Option) (*DeleteDimensionOutput, error)

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

See DeleteDimension 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) DeleteDomainConfiguration added in v1.25.42 

func (c *IoT) DeleteDomainConfiguration(input *DeleteDomainConfigurationInput) (*DeleteDomainConfigurationOutput, error)

DeleteDomainConfiguration API operation for AWS IoT.

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

func (*IoT) DeleteDomainConfigurationRequest added in v1.25.42 

func (c *IoT) DeleteDomainConfigurationRequest(input *DeleteDomainConfigurationInput) (req *request.Request, output *DeleteDomainConfigurationOutput)

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

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 DeleteDomainConfiguration for more information on using the DeleteDomainConfiguration 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 DeleteDomainConfigurationRequest method.
req, resp := client.DeleteDomainConfigurationRequest(params)

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

func (*IoT) DeleteDomainConfigurationWithContext added in v1.25.42 

func (c *IoT) DeleteDomainConfigurationWithContext(ctx aws.Context, input *DeleteDomainConfigurationInput, opts ...request.Option) (*DeleteDomainConfigurationOutput, error)

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

See DeleteDomainConfiguration 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) DeleteDynamicThingGroup added in v1.15.79 

func (c *IoT) DeleteDynamicThingGroup(input *DeleteDynamicThingGroupInput) (*DeleteDynamicThingGroupOutput, error)

DeleteDynamicThingGroup API operation for AWS IoT.

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

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

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteDynamicThingGroupRequest added in v1.15.79 

func (c *IoT) DeleteDynamicThingGroupRequest(input *DeleteDynamicThingGroupInput) (req *request.Request, output *DeleteDynamicThingGroupOutput)

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

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 DeleteDynamicThingGroup for more information on using the DeleteDynamicThingGroup 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 DeleteDynamicThingGroupRequest method.
req, resp := client.DeleteDynamicThingGroupRequest(params)

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

func (*IoT) DeleteDynamicThingGroupWithContext added in v1.15.79 

func (c *IoT) DeleteDynamicThingGroupWithContext(ctx aws.Context, input *DeleteDynamicThingGroupInput, opts ...request.Option) (*DeleteDynamicThingGroupOutput, error)

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

See DeleteDynamicThingGroup 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) DeleteFleetMetric added in v1.40.34 

func (c *IoT) DeleteFleetMetric(input *DeleteFleetMetricInput) (*DeleteFleetMetricOutput, error)

DeleteFleetMetric API operation for AWS IoT.

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

Requires permission to access the DeleteFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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) DeleteFleetMetricRequest added in v1.40.34 

func (c *IoT) DeleteFleetMetricRequest(input *DeleteFleetMetricInput) (req *request.Request, output *DeleteFleetMetricOutput)

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

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 DeleteFleetMetric for more information on using the DeleteFleetMetric 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 DeleteFleetMetricRequest method.
req, resp := client.DeleteFleetMetricRequest(params)

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

func (*IoT) DeleteFleetMetricWithContext added in v1.40.34 

func (c *IoT) DeleteFleetMetricWithContext(ctx aws.Context, input *DeleteFleetMetricInput, opts ...request.Option) (*DeleteFleetMetricOutput, error)

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

See DeleteFleetMetric 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.

Requires permission to access the DeleteJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

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

  • ResourceNotFoundException The specified resource does not exist.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

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

Requires permission to access the DeleteJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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

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) DeleteJobTemplate added in v1.38.47 

func (c *IoT) DeleteJobTemplate(input *DeleteJobTemplateInput) (*DeleteJobTemplateOutput, error)

DeleteJobTemplate API operation for AWS IoT.

Deletes the specified job template.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteJobTemplateRequest added in v1.38.47 

func (c *IoT) DeleteJobTemplateRequest(input *DeleteJobTemplateInput) (req *request.Request, output *DeleteJobTemplateOutput)

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

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 DeleteJobTemplate for more information on using the DeleteJobTemplate 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 DeleteJobTemplateRequest method.
req, resp := client.DeleteJobTemplateRequest(params)

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

func (*IoT) DeleteJobTemplateWithContext added in v1.38.47 

func (c *IoT) DeleteJobTemplateWithContext(ctx aws.Context, input *DeleteJobTemplateInput, opts ...request.Option) (*DeleteJobTemplateOutput, error)

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

See DeleteJobTemplate 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) 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) DeleteMitigationAction added in v1.21.10 

func (c *IoT) DeleteMitigationAction(input *DeleteMitigationActionInput) (*DeleteMitigationActionOutput, error)

DeleteMitigationAction API operation for AWS IoT.

Deletes a defined mitigation action from your Amazon Web Services accounts.

Requires permission to access the DeleteMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteMitigationActionRequest added in v1.21.10 

func (c *IoT) DeleteMitigationActionRequest(input *DeleteMitigationActionInput) (req *request.Request, output *DeleteMitigationActionOutput)

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

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 DeleteMitigationAction for more information on using the DeleteMitigationAction 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 DeleteMitigationActionRequest method.
req, resp := client.DeleteMitigationActionRequest(params)

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

func (*IoT) DeleteMitigationActionWithContext added in v1.21.10 

func (c *IoT) DeleteMitigationActionWithContext(ctx aws.Context, input *DeleteMitigationActionInput, opts ...request.Option) (*DeleteMitigationActionOutput, error)

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

See DeleteMitigationAction 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.

Requires permission to access the DeleteOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • ServiceUnavailableException The service is temporarily unavailable.

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

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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

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

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DeletePolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

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

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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

Requires permission to access the DeletePolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

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

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) DeleteProvisioningTemplate added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplate(input *DeleteProvisioningTemplateInput) (*DeleteProvisioningTemplateOutput, error)

DeleteProvisioningTemplate API operation for AWS IoT.

Deletes a fleet provisioning template.

Requires permission to access the DeleteProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ThrottlingException The rate exceeds the limit.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) DeleteProvisioningTemplateRequest added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplateRequest(input *DeleteProvisioningTemplateInput) (req *request.Request, output *DeleteProvisioningTemplateOutput)

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

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 DeleteProvisioningTemplate for more information on using the DeleteProvisioningTemplate 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 DeleteProvisioningTemplateRequest method.
req, resp := client.DeleteProvisioningTemplateRequest(params)

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

func (*IoT) DeleteProvisioningTemplateVersion added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplateVersion(input *DeleteProvisioningTemplateVersionInput) (*DeleteProvisioningTemplateVersionOutput, error)

DeleteProvisioningTemplateVersion API operation for AWS IoT.

Deletes a fleet provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

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

func (*IoT) DeleteProvisioningTemplateVersionRequest added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplateVersionRequest(input *DeleteProvisioningTemplateVersionInput) (req *request.Request, output *DeleteProvisioningTemplateVersionOutput)

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

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 DeleteProvisioningTemplateVersion for more information on using the DeleteProvisioningTemplateVersion 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 DeleteProvisioningTemplateVersionRequest method.
req, resp := client.DeleteProvisioningTemplateVersionRequest(params)

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

func (*IoT) DeleteProvisioningTemplateVersionWithContext added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplateVersionWithContext(ctx aws.Context, input *DeleteProvisioningTemplateVersionInput, opts ...request.Option) (*DeleteProvisioningTemplateVersionOutput, error)

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

See DeleteProvisioningTemplateVersion 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) DeleteProvisioningTemplateWithContext added in v1.25.42 

func (c *IoT) DeleteProvisioningTemplateWithContext(ctx aws.Context, input *DeleteProvisioningTemplateInput, opts ...request.Option) (*DeleteProvisioningTemplateOutput, error)

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

See DeleteProvisioningTemplate 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.

Requires permission to access the DeleteRegistrationCode (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ThrottlingException The rate exceeds the limit.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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

Requires permission to access the DeleteRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) DeleteScheduledAudit added in v1.15.2 

func (c *IoT) DeleteScheduledAudit(input *DeleteScheduledAuditInput) (*DeleteScheduledAuditOutput, error)

DeleteScheduledAudit API operation for AWS IoT.

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DeleteScheduledAuditRequest added in v1.15.2 

func (c *IoT) DeleteScheduledAuditRequest(input *DeleteScheduledAuditInput) (req *request.Request, output *DeleteScheduledAuditOutput)

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

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 DeleteScheduledAudit for more information on using the DeleteScheduledAudit 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 DeleteScheduledAuditRequest method.
req, resp := client.DeleteScheduledAuditRequest(params)

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

func (*IoT) DeleteScheduledAuditWithContext added in v1.15.2 

func (c *IoT) DeleteScheduledAuditWithContext(ctx aws.Context, input *DeleteScheduledAuditInput, opts ...request.Option) (*DeleteScheduledAuditOutput, error)

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

See DeleteScheduledAudit 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) DeleteSecurityProfile added in v1.15.2 

func (c *IoT) DeleteSecurityProfile(input *DeleteSecurityProfileInput) (*DeleteSecurityProfileOutput, error)

DeleteSecurityProfile API operation for AWS IoT.

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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) DeleteSecurityProfileRequest added in v1.15.2 

func (c *IoT) DeleteSecurityProfileRequest(input *DeleteSecurityProfileInput) (req *request.Request, output *DeleteSecurityProfileOutput)

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

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 DeleteSecurityProfile for more information on using the DeleteSecurityProfile 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 DeleteSecurityProfileRequest method.
req, resp := client.DeleteSecurityProfileRequest(params)

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

func (*IoT) DeleteSecurityProfileWithContext added in v1.15.2 

func (c *IoT) DeleteSecurityProfileWithContext(ctx aws.Context, input *DeleteSecurityProfileInput, opts ...request.Option) (*DeleteSecurityProfileOutput, error)

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

See DeleteSecurityProfile 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.

Requires permission to access the DeleteStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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 successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

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

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

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

Requires permission to access the DeleteThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

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

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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

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.

Requires permission to access the DeleteThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the DeleteTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) DeleteTopicRuleDestination added in v1.25.38 

func (c *IoT) DeleteTopicRuleDestination(input *DeleteTopicRuleDestinationInput) (*DeleteTopicRuleDestinationOutput, error)

DeleteTopicRuleDestination API operation for AWS IoT.

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) DeleteTopicRuleDestinationRequest added in v1.25.38 

func (c *IoT) DeleteTopicRuleDestinationRequest(input *DeleteTopicRuleDestinationInput) (req *request.Request, output *DeleteTopicRuleDestinationOutput)

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

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 DeleteTopicRuleDestination for more information on using the DeleteTopicRuleDestination 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 DeleteTopicRuleDestinationRequest method.
req, resp := client.DeleteTopicRuleDestinationRequest(params)

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

func (*IoT) DeleteTopicRuleDestinationWithContext added in v1.25.38 

func (c *IoT) DeleteTopicRuleDestinationWithContext(ctx aws.Context, input *DeleteTopicRuleDestinationInput, opts ...request.Option) (*DeleteTopicRuleDestinationOutput, error)

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

See DeleteTopicRuleDestination 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) 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 successfully.

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.

Requires permission to access the DeleteV2LoggingLevel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • 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 successfully.

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.

Requires permission to access the DeprecateThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) DescribeAccountAuditConfiguration added in v1.15.2 

func (c *IoT) DescribeAccountAuditConfiguration(input *DescribeAccountAuditConfigurationInput) (*DescribeAccountAuditConfigurationOutput, error)

DescribeAccountAuditConfiguration API operation for AWS IoT.

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the DescribeAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeAccountAuditConfigurationRequest added in v1.15.2 

func (c *IoT) DescribeAccountAuditConfigurationRequest(input *DescribeAccountAuditConfigurationInput) (req *request.Request, output *DescribeAccountAuditConfigurationOutput)

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

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 DescribeAccountAuditConfiguration for more information on using the DescribeAccountAuditConfiguration 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 DescribeAccountAuditConfigurationRequest method.
req, resp := client.DescribeAccountAuditConfigurationRequest(params)

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

func (*IoT) DescribeAccountAuditConfigurationWithContext added in v1.15.2 

func (c *IoT) DescribeAccountAuditConfigurationWithContext(ctx aws.Context, input *DescribeAccountAuditConfigurationInput, opts ...request.Option) (*DescribeAccountAuditConfigurationOutput, error)

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

See DescribeAccountAuditConfiguration 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) DescribeAuditFinding added in v1.21.10 

func (c *IoT) DescribeAuditFinding(input *DescribeAuditFindingInput) (*DescribeAuditFindingOutput, error)

DescribeAuditFinding API operation for AWS IoT.

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

Requires permission to access the DescribeAuditFinding (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeAuditFindingRequest added in v1.21.10 

func (c *IoT) DescribeAuditFindingRequest(input *DescribeAuditFindingInput) (req *request.Request, output *DescribeAuditFindingOutput)

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

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 DescribeAuditFinding for more information on using the DescribeAuditFinding 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 DescribeAuditFindingRequest method.
req, resp := client.DescribeAuditFindingRequest(params)

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

func (*IoT) DescribeAuditFindingWithContext added in v1.21.10 

func (c *IoT) DescribeAuditFindingWithContext(ctx aws.Context, input *DescribeAuditFindingInput, opts ...request.Option) (*DescribeAuditFindingOutput, error)

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

See DescribeAuditFinding 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) DescribeAuditMitigationActionsTask added in v1.21.10 

func (c *IoT) DescribeAuditMitigationActionsTask(input *DescribeAuditMitigationActionsTaskInput) (*DescribeAuditMitigationActionsTaskOutput, error)

DescribeAuditMitigationActionsTask API operation for AWS IoT.

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeAuditMitigationActionsTaskRequest added in v1.21.10 

func (c *IoT) DescribeAuditMitigationActionsTaskRequest(input *DescribeAuditMitigationActionsTaskInput) (req *request.Request, output *DescribeAuditMitigationActionsTaskOutput)

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

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 DescribeAuditMitigationActionsTask for more information on using the DescribeAuditMitigationActionsTask 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 DescribeAuditMitigationActionsTaskRequest method.
req, resp := client.DescribeAuditMitigationActionsTaskRequest(params)

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

func (*IoT) DescribeAuditMitigationActionsTaskWithContext added in v1.21.10 

func (c *IoT) DescribeAuditMitigationActionsTaskWithContext(ctx aws.Context, input *DescribeAuditMitigationActionsTaskInput, opts ...request.Option) (*DescribeAuditMitigationActionsTaskOutput, error)

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

See DescribeAuditMitigationActionsTask 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) DescribeAuditSuppression added in v1.34.3 

func (c *IoT) DescribeAuditSuppression(input *DescribeAuditSuppressionInput) (*DescribeAuditSuppressionOutput, error)

DescribeAuditSuppression API operation for AWS IoT.

Gets information about a Device Defender audit suppression.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeAuditSuppressionRequest added in v1.34.3 

func (c *IoT) DescribeAuditSuppressionRequest(input *DescribeAuditSuppressionInput) (req *request.Request, output *DescribeAuditSuppressionOutput)

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

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 DescribeAuditSuppression for more information on using the DescribeAuditSuppression 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 DescribeAuditSuppressionRequest method.
req, resp := client.DescribeAuditSuppressionRequest(params)

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

func (*IoT) DescribeAuditSuppressionWithContext added in v1.34.3 

func (c *IoT) DescribeAuditSuppressionWithContext(ctx aws.Context, input *DescribeAuditSuppressionInput, opts ...request.Option) (*DescribeAuditSuppressionOutput, error)

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

See DescribeAuditSuppression 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) DescribeAuditTask added in v1.15.2 

func (c *IoT) DescribeAuditTask(input *DescribeAuditTaskInput) (*DescribeAuditTaskOutput, error)

DescribeAuditTask API operation for AWS IoT.

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeAuditTaskRequest added in v1.15.2 

func (c *IoT) DescribeAuditTaskRequest(input *DescribeAuditTaskInput) (req *request.Request, output *DescribeAuditTaskOutput)

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

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 DescribeAuditTask for more information on using the DescribeAuditTask 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 DescribeAuditTaskRequest method.
req, resp := client.DescribeAuditTaskRequest(params)

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

func (*IoT) DescribeAuditTaskWithContext added in v1.15.2 

func (c *IoT) DescribeAuditTaskWithContext(ctx aws.Context, input *DescribeAuditTaskInput, opts ...request.Option) (*DescribeAuditTaskOutput, error)

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

See DescribeAuditTask 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.

Requires permission to access the DescribeAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) DescribeBillingGroup added in v1.15.79 

func (c *IoT) DescribeBillingGroup(input *DescribeBillingGroupInput) (*DescribeBillingGroupOutput, error)

DescribeBillingGroup API operation for AWS IoT.

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) DescribeBillingGroupRequest added in v1.15.79 

func (c *IoT) DescribeBillingGroupRequest(input *DescribeBillingGroupInput) (req *request.Request, output *DescribeBillingGroupOutput)

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

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 DescribeBillingGroup for more information on using the DescribeBillingGroup 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 DescribeBillingGroupRequest method.
req, resp := client.DescribeBillingGroupRequest(params)

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

func (*IoT) DescribeBillingGroupWithContext added in v1.15.79 

func (c *IoT) DescribeBillingGroupWithContext(ctx aws.Context, input *DescribeBillingGroupInput, opts ...request.Option) (*DescribeBillingGroupOutput, error)

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

See DescribeBillingGroup 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.

Requires permission to access the DescribeCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the DescribeCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) DescribeCustomMetric added in v1.36.9 

func (c *IoT) DescribeCustomMetric(input *DescribeCustomMetricInput) (*DescribeCustomMetricOutput, error)

DescribeCustomMetric API operation for AWS IoT.

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeCustomMetricRequest added in v1.36.9 

func (c *IoT) DescribeCustomMetricRequest(input *DescribeCustomMetricInput) (req *request.Request, output *DescribeCustomMetricOutput)

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

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 DescribeCustomMetric for more information on using the DescribeCustomMetric 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 DescribeCustomMetricRequest method.
req, resp := client.DescribeCustomMetricRequest(params)

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

func (*IoT) DescribeCustomMetricWithContext added in v1.36.9 

func (c *IoT) DescribeCustomMetricWithContext(ctx aws.Context, input *DescribeCustomMetricInput, opts ...request.Option) (*DescribeCustomMetricOutput, error)

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

See DescribeCustomMetric 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.

Requires permission to access the DescribeDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) DescribeDetectMitigationActionsTask added in v1.36.9 

func (c *IoT) DescribeDetectMitigationActionsTask(input *DescribeDetectMitigationActionsTaskInput) (*DescribeDetectMitigationActionsTaskOutput, error)

DescribeDetectMitigationActionsTask API operation for AWS IoT.

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeDetectMitigationActionsTaskRequest added in v1.36.9 

func (c *IoT) DescribeDetectMitigationActionsTaskRequest(input *DescribeDetectMitigationActionsTaskInput) (req *request.Request, output *DescribeDetectMitigationActionsTaskOutput)

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

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 DescribeDetectMitigationActionsTask for more information on using the DescribeDetectMitigationActionsTask 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 DescribeDetectMitigationActionsTaskRequest method.
req, resp := client.DescribeDetectMitigationActionsTaskRequest(params)

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

func (*IoT) DescribeDetectMitigationActionsTaskWithContext added in v1.36.9 

func (c *IoT) DescribeDetectMitigationActionsTaskWithContext(ctx aws.Context, input *DescribeDetectMitigationActionsTaskInput, opts ...request.Option) (*DescribeDetectMitigationActionsTaskOutput, error)

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

See DescribeDetectMitigationActionsTask 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) DescribeDimension added in v1.30.2 

func (c *IoT) DescribeDimension(input *DescribeDimensionInput) (*DescribeDimensionOutput, error)

DescribeDimension API operation for AWS IoT.

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) DescribeDimensionRequest added in v1.30.2 

func (c *IoT) DescribeDimensionRequest(input *DescribeDimensionInput) (req *request.Request, output *DescribeDimensionOutput)

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

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 DescribeDimension for more information on using the DescribeDimension 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 DescribeDimensionRequest method.
req, resp := client.DescribeDimensionRequest(params)

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

func (*IoT) DescribeDimensionWithContext added in v1.30.2 

func (c *IoT) DescribeDimensionWithContext(ctx aws.Context, input *DescribeDimensionInput, opts ...request.Option) (*DescribeDimensionOutput, error)

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

See DescribeDimension 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) DescribeDomainConfiguration added in v1.25.42 

func (c *IoT) DescribeDomainConfiguration(input *DescribeDomainConfigurationInput) (*DescribeDomainConfigurationOutput, error)

DescribeDomainConfiguration API operation for AWS IoT.

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InvalidRequestException The request is not valid.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeDomainConfigurationRequest added in v1.25.42 

func (c *IoT) DescribeDomainConfigurationRequest(input *DescribeDomainConfigurationInput) (req *request.Request, output *DescribeDomainConfigurationOutput)

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

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 DescribeDomainConfiguration for more information on using the DescribeDomainConfiguration 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 DescribeDomainConfigurationRequest method.
req, resp := client.DescribeDomainConfigurationRequest(params)

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

func (*IoT) DescribeDomainConfigurationWithContext added in v1.25.42 

func (c *IoT) DescribeDomainConfigurationWithContext(ctx aws.Context, input *DescribeDomainConfigurationInput, opts ...request.Option) (*DescribeDomainConfigurationOutput, error)

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

See DescribeDomainConfiguration 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 Amazon Web Services account making the call.

Requires permission to access the DescribeEndpoint (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • UnauthorizedException You are not authorized to perform this operation.

  • 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 successfully.

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.

Requires permission to access the DescribeEventConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) DescribeFleetMetric added in v1.40.34 

func (c *IoT) DescribeFleetMetric(input *DescribeFleetMetricInput) (*DescribeFleetMetricOutput, error)

DescribeFleetMetric API operation for AWS IoT.

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) DescribeFleetMetricRequest added in v1.40.34 

func (c *IoT) DescribeFleetMetricRequest(input *DescribeFleetMetricInput) (req *request.Request, output *DescribeFleetMetricOutput)

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

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 DescribeFleetMetric for more information on using the DescribeFleetMetric 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 DescribeFleetMetricRequest method.
req, resp := client.DescribeFleetMetricRequest(params)

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

func (*IoT) DescribeFleetMetricWithContext added in v1.40.34 

func (c *IoT) DescribeFleetMetricWithContext(ctx aws.Context, input *DescribeFleetMetricInput, opts ...request.Option) (*DescribeFleetMetricOutput, error)

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

See DescribeFleetMetric 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.

Requires permission to access the DescribeIndex (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the DescribeJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

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

Requires permission to access the DescribeJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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

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) DescribeJobTemplate added in v1.38.47 

func (c *IoT) DescribeJobTemplate(input *DescribeJobTemplateInput) (*DescribeJobTemplateOutput, error)

DescribeJobTemplate API operation for AWS IoT.

Returns information about a job template.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeJobTemplateRequest added in v1.38.47 

func (c *IoT) DescribeJobTemplateRequest(input *DescribeJobTemplateInput) (req *request.Request, output *DescribeJobTemplateOutput)

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

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 DescribeJobTemplate for more information on using the DescribeJobTemplate 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 DescribeJobTemplateRequest method.
req, resp := client.DescribeJobTemplateRequest(params)

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

func (*IoT) DescribeJobTemplateWithContext added in v1.38.47 

func (c *IoT) DescribeJobTemplateWithContext(ctx aws.Context, input *DescribeJobTemplateInput, opts ...request.Option) (*DescribeJobTemplateOutput, error)

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

See DescribeJobTemplate 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) 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) DescribeManagedJobTemplate added in v1.42.11 

func (c *IoT) DescribeManagedJobTemplate(input *DescribeManagedJobTemplateInput) (*DescribeManagedJobTemplateOutput, error)

DescribeManagedJobTemplate API operation for AWS IoT.

View details of a managed job template.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalServerException Internal error from the service that indicates an unexpected error or that the service is unavailable.

func (*IoT) DescribeManagedJobTemplateRequest added in v1.42.11 

func (c *IoT) DescribeManagedJobTemplateRequest(input *DescribeManagedJobTemplateInput) (req *request.Request, output *DescribeManagedJobTemplateOutput)

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

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 DescribeManagedJobTemplate for more information on using the DescribeManagedJobTemplate 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 DescribeManagedJobTemplateRequest method.
req, resp := client.DescribeManagedJobTemplateRequest(params)

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

func (*IoT) DescribeManagedJobTemplateWithContext added in v1.42.11 

func (c *IoT) DescribeManagedJobTemplateWithContext(ctx aws.Context, input *DescribeManagedJobTemplateInput, opts ...request.Option) (*DescribeManagedJobTemplateOutput, error)

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

See DescribeManagedJobTemplate 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) DescribeMitigationAction added in v1.21.10 

func (c *IoT) DescribeMitigationAction(input *DescribeMitigationActionInput) (*DescribeMitigationActionOutput, error)

DescribeMitigationAction API operation for AWS IoT.

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeMitigationActionRequest added in v1.21.10 

func (c *IoT) DescribeMitigationActionRequest(input *DescribeMitigationActionInput) (req *request.Request, output *DescribeMitigationActionOutput)

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

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 DescribeMitigationAction for more information on using the DescribeMitigationAction 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 DescribeMitigationActionRequest method.
req, resp := client.DescribeMitigationActionRequest(params)

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

func (*IoT) DescribeMitigationActionWithContext added in v1.21.10 

func (c *IoT) DescribeMitigationActionWithContext(ctx aws.Context, input *DescribeMitigationActionInput, opts ...request.Option) (*DescribeMitigationActionOutput, error)

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

See DescribeMitigationAction 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) DescribeProvisioningTemplate added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplate(input *DescribeProvisioningTemplateInput) (*DescribeProvisioningTemplateOutput, error)

DescribeProvisioningTemplate API operation for AWS IoT.

Returns information about a fleet provisioning template.

Requires permission to access the DescribeProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) DescribeProvisioningTemplateRequest added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplateRequest(input *DescribeProvisioningTemplateInput) (req *request.Request, output *DescribeProvisioningTemplateOutput)

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

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 DescribeProvisioningTemplate for more information on using the DescribeProvisioningTemplate 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 DescribeProvisioningTemplateRequest method.
req, resp := client.DescribeProvisioningTemplateRequest(params)

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

func (*IoT) DescribeProvisioningTemplateVersion added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplateVersion(input *DescribeProvisioningTemplateVersionInput) (*DescribeProvisioningTemplateVersionOutput, error)

DescribeProvisioningTemplateVersion API operation for AWS IoT.

Returns information about a fleet provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) DescribeProvisioningTemplateVersionRequest added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplateVersionRequest(input *DescribeProvisioningTemplateVersionInput) (req *request.Request, output *DescribeProvisioningTemplateVersionOutput)

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

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 DescribeProvisioningTemplateVersion for more information on using the DescribeProvisioningTemplateVersion 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 DescribeProvisioningTemplateVersionRequest method.
req, resp := client.DescribeProvisioningTemplateVersionRequest(params)

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

func (*IoT) DescribeProvisioningTemplateVersionWithContext added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplateVersionWithContext(ctx aws.Context, input *DescribeProvisioningTemplateVersionInput, opts ...request.Option) (*DescribeProvisioningTemplateVersionOutput, error)

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

See DescribeProvisioningTemplateVersion 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) DescribeProvisioningTemplateWithContext added in v1.25.42 

func (c *IoT) DescribeProvisioningTemplateWithContext(ctx aws.Context, input *DescribeProvisioningTemplateInput, opts ...request.Option) (*DescribeProvisioningTemplateOutput, error)

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

See DescribeProvisioningTemplate 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.

Requires permission to access the DescribeRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) DescribeScheduledAudit added in v1.15.2 

func (c *IoT) DescribeScheduledAudit(input *DescribeScheduledAuditInput) (*DescribeScheduledAuditOutput, error)

DescribeScheduledAudit API operation for AWS IoT.

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeScheduledAuditRequest added in v1.15.2 

func (c *IoT) DescribeScheduledAuditRequest(input *DescribeScheduledAuditInput) (req *request.Request, output *DescribeScheduledAuditOutput)

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

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 DescribeScheduledAudit for more information on using the DescribeScheduledAudit 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 DescribeScheduledAuditRequest method.
req, resp := client.DescribeScheduledAuditRequest(params)

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

func (*IoT) DescribeScheduledAuditWithContext added in v1.15.2 

func (c *IoT) DescribeScheduledAuditWithContext(ctx aws.Context, input *DescribeScheduledAuditInput, opts ...request.Option) (*DescribeScheduledAuditOutput, error)

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

See DescribeScheduledAudit 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) DescribeSecurityProfile added in v1.15.2 

func (c *IoT) DescribeSecurityProfile(input *DescribeSecurityProfileInput) (*DescribeSecurityProfileOutput, error)

DescribeSecurityProfile API operation for AWS IoT.

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DescribeSecurityProfileRequest added in v1.15.2 

func (c *IoT) DescribeSecurityProfileRequest(input *DescribeSecurityProfileInput) (req *request.Request, output *DescribeSecurityProfileOutput)

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

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 DescribeSecurityProfile for more information on using the DescribeSecurityProfile 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 DescribeSecurityProfileRequest method.
req, resp := client.DescribeSecurityProfileRequest(params)

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

func (*IoT) DescribeSecurityProfileWithContext added in v1.15.2 

func (c *IoT) DescribeSecurityProfileWithContext(ctx aws.Context, input *DescribeSecurityProfileInput, opts ...request.Option) (*DescribeSecurityProfileOutput, error)

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

See DescribeSecurityProfile 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.

Requires permission to access the DescribeStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the DescribeThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

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

Requires permission to access the DescribeThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the DescribeThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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

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.

Requires permission to access the DescribeThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DetachPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 deprecated 

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

DetachPrincipalPolicy API operation for AWS IoT.

Removes the specified policy from the specified certificate.

This action is deprecated. Please use DetachPolicy instead.

Requires permission to access the DetachPrincipalPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

Deprecated: DetachPrincipalPolicy has been deprecated

func (*IoT) DetachPrincipalPolicyRequest deprecated 

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

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

Deprecated: DetachPrincipalPolicy has been deprecated

func (*IoT) DetachPrincipalPolicyWithContext deprecated 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.

Deprecated: DetachPrincipalPolicyWithContext has been deprecated

func (*IoT) DetachSecurityProfile added in v1.15.2 

func (c *IoT) DetachSecurityProfile(input *DetachSecurityProfileInput) (*DetachSecurityProfileOutput, error)

DetachSecurityProfile API operation for AWS IoT.

Disassociates a Device Defender security profile from a thing group or from this account.

Requires permission to access the DetachSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) DetachSecurityProfileRequest added in v1.15.2 

func (c *IoT) DetachSecurityProfileRequest(input *DetachSecurityProfileInput) (req *request.Request, output *DetachSecurityProfileOutput)

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

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 DetachSecurityProfile for more information on using the DetachSecurityProfile 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 DetachSecurityProfileRequest method.
req, resp := client.DetachSecurityProfileRequest(params)

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

func (*IoT) DetachSecurityProfileWithContext added in v1.15.2 

func (c *IoT) DetachSecurityProfileWithContext(ctx aws.Context, input *DetachSecurityProfileInput, opts ...request.Option) (*DetachSecurityProfileOutput, error)

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

See DetachSecurityProfile 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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

This call is asynchronous. It might take several seconds for the detachment to propagate.

Requires permission to access the DetachThingPrincipal (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the DisableTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

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

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.

Requires permission to access the EnableTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

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

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) GetBehaviorModelTrainingSummaries added in v1.36.9 

func (c *IoT) GetBehaviorModelTrainingSummaries(input *GetBehaviorModelTrainingSummariesInput) (*GetBehaviorModelTrainingSummariesOutput, error)

GetBehaviorModelTrainingSummaries API operation for AWS IoT.

Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) GetBehaviorModelTrainingSummariesPages added in v1.36.9 

func (c *IoT) GetBehaviorModelTrainingSummariesPages(input *GetBehaviorModelTrainingSummariesInput, fn func(*GetBehaviorModelTrainingSummariesOutput, bool) bool) error

GetBehaviorModelTrainingSummariesPages iterates over the pages of a GetBehaviorModelTrainingSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetBehaviorModelTrainingSummaries method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetBehaviorModelTrainingSummaries operation.
pageNum := 0
err := client.GetBehaviorModelTrainingSummariesPages(params,
    func(page *iot.GetBehaviorModelTrainingSummariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) GetBehaviorModelTrainingSummariesPagesWithContext added in v1.36.9 

func (c *IoT) GetBehaviorModelTrainingSummariesPagesWithContext(ctx aws.Context, input *GetBehaviorModelTrainingSummariesInput, fn func(*GetBehaviorModelTrainingSummariesOutput, bool) bool, opts ...request.Option) error

GetBehaviorModelTrainingSummariesPagesWithContext same as GetBehaviorModelTrainingSummariesPages except it takes a Context and allows setting request options on the pages.

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) GetBehaviorModelTrainingSummariesRequest added in v1.36.9 

func (c *IoT) GetBehaviorModelTrainingSummariesRequest(input *GetBehaviorModelTrainingSummariesInput) (req *request.Request, output *GetBehaviorModelTrainingSummariesOutput)

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

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 GetBehaviorModelTrainingSummaries for more information on using the GetBehaviorModelTrainingSummaries 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 GetBehaviorModelTrainingSummariesRequest method.
req, resp := client.GetBehaviorModelTrainingSummariesRequest(params)

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

func (*IoT) GetBehaviorModelTrainingSummariesWithContext added in v1.36.9 

func (c *IoT) GetBehaviorModelTrainingSummariesWithContext(ctx aws.Context, input *GetBehaviorModelTrainingSummariesInput, opts ...request.Option) (*GetBehaviorModelTrainingSummariesOutput, error)

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

See GetBehaviorModelTrainingSummaries 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) GetBucketsAggregation added in v1.40.34 

func (c *IoT) GetBucketsAggregation(input *GetBucketsAggregationInput) (*GetBucketsAggregationOutput, error)

GetBucketsAggregation API operation for AWS IoT.

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • IndexNotReadyException The index is not ready.

func (*IoT) GetBucketsAggregationRequest added in v1.40.34 

func (c *IoT) GetBucketsAggregationRequest(input *GetBucketsAggregationInput) (req *request.Request, output *GetBucketsAggregationOutput)

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

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 GetBucketsAggregation for more information on using the GetBucketsAggregation 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 GetBucketsAggregationRequest method.
req, resp := client.GetBucketsAggregationRequest(params)

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

func (*IoT) GetBucketsAggregationWithContext added in v1.40.34 

func (c *IoT) GetBucketsAggregationWithContext(ctx aws.Context, input *GetBucketsAggregationInput, opts ...request.Option) (*GetBucketsAggregationOutput, error)

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

See GetBucketsAggregation 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) GetCardinality added in v1.25.34 

func (c *IoT) GetCardinality(input *GetCardinalityInput) (*GetCardinalityOutput, error)

GetCardinality API operation for AWS IoT.

Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • IndexNotReadyException The index is not ready.

func (*IoT) GetCardinalityRequest added in v1.25.34 

func (c *IoT) GetCardinalityRequest(input *GetCardinalityInput) (req *request.Request, output *GetCardinalityOutput)

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

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 GetCardinality for more information on using the GetCardinality 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 GetCardinalityRequest method.
req, resp := client.GetCardinalityRequest(params)

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

func (*IoT) GetCardinalityWithContext added in v1.25.34 

func (c *IoT) GetCardinalityWithContext(ctx aws.Context, input *GetCardinalityInput, opts ...request.Option) (*GetCardinalityOutput, error)

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

See GetCardinality 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 IoT device gateway.

Requires permission to access the GetEffectivePolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 indexing configuration.

Requires permission to access the GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the GetJobDocument (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • 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 successfully.

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.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

Requires permission to access the GetLoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • 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 successfully.

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.

Requires permission to access the GetOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) GetPercentiles added in v1.25.34 

func (c *IoT) GetPercentiles(input *GetPercentilesInput) (*GetPercentilesOutput, error)

GetPercentiles API operation for AWS IoT.

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • IndexNotReadyException The index is not ready.

func (*IoT) GetPercentilesRequest added in v1.25.34 

func (c *IoT) GetPercentilesRequest(input *GetPercentilesInput) (req *request.Request, output *GetPercentilesOutput)

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

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 GetPercentiles for more information on using the GetPercentiles 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 GetPercentilesRequest method.
req, resp := client.GetPercentilesRequest(params)

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

func (*IoT) GetPercentilesWithContext added in v1.25.34 

func (c *IoT) GetPercentilesWithContext(ctx aws.Context, input *GetPercentilesInput, opts ...request.Option) (*GetPercentilesOutput, error)

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

See GetPercentiles 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.

Requires permission to access the GetPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the GetPolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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

Requires permission to access the GetRegistrationCode (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) GetStatistics added in v1.19.0 

func (c *IoT) GetStatistics(input *GetStatisticsInput) (*GetStatisticsOutput, error)

GetStatistics API operation for AWS IoT.

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • IndexNotReadyException The index is not ready.

func (*IoT) GetStatisticsRequest added in v1.19.0 

func (c *IoT) GetStatisticsRequest(input *GetStatisticsInput) (req *request.Request, output *GetStatisticsOutput)

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

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 GetStatistics for more information on using the GetStatistics 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 GetStatisticsRequest method.
req, resp := client.GetStatisticsRequest(params)

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

func (*IoT) GetStatisticsWithContext added in v1.19.0 

func (c *IoT) GetStatisticsWithContext(ctx aws.Context, input *GetStatisticsInput, opts ...request.Option) (*GetStatisticsOutput, error)

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

See GetStatistics 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.

Requires permission to access the GetTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) GetTopicRuleDestination added in v1.25.38 

func (c *IoT) GetTopicRuleDestination(input *GetTopicRuleDestinationInput) (*GetTopicRuleDestinationOutput, error)

GetTopicRuleDestination API operation for AWS IoT.

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) GetTopicRuleDestinationRequest added in v1.25.38 

func (c *IoT) GetTopicRuleDestinationRequest(input *GetTopicRuleDestinationInput) (req *request.Request, output *GetTopicRuleDestinationOutput)

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

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 GetTopicRuleDestination for more information on using the GetTopicRuleDestination 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 GetTopicRuleDestinationRequest method.
req, resp := client.GetTopicRuleDestinationRequest(params)

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

func (*IoT) GetTopicRuleDestinationWithContext added in v1.25.38 

func (c *IoT) GetTopicRuleDestinationWithContext(ctx aws.Context, input *GetTopicRuleDestinationInput, opts ...request.Option) (*GetTopicRuleDestinationOutput, error)

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

See GetTopicRuleDestination 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) 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 successfully.

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.

Requires permission to access the GetV2LoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • NotConfiguredException The resource is not configured.

  • 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 successfully.

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) ListActiveViolations added in v1.15.2 

func (c *IoT) ListActiveViolations(input *ListActiveViolationsInput) (*ListActiveViolationsOutput, error)

ListActiveViolations API operation for AWS IoT.

Lists the active violations for a given Device Defender security profile.

Requires permission to access the ListActiveViolations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListActiveViolationsPages added in v1.34.3 

func (c *IoT) ListActiveViolationsPages(input *ListActiveViolationsInput, fn func(*ListActiveViolationsOutput, bool) bool) error

ListActiveViolationsPages iterates over the pages of a ListActiveViolations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListActiveViolations method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListActiveViolations operation.
pageNum := 0
err := client.ListActiveViolationsPages(params,
    func(page *iot.ListActiveViolationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListActiveViolationsPagesWithContext added in v1.34.3 

func (c *IoT) ListActiveViolationsPagesWithContext(ctx aws.Context, input *ListActiveViolationsInput, fn func(*ListActiveViolationsOutput, bool) bool, opts ...request.Option) error

ListActiveViolationsPagesWithContext same as ListActiveViolationsPages except it takes a Context and allows setting request options on the pages.

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) ListActiveViolationsRequest added in v1.15.2 

func (c *IoT) ListActiveViolationsRequest(input *ListActiveViolationsInput) (req *request.Request, output *ListActiveViolationsOutput)

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

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 ListActiveViolations for more information on using the ListActiveViolations 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 ListActiveViolationsRequest method.
req, resp := client.ListActiveViolationsRequest(params)

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

func (*IoT) ListActiveViolationsWithContext added in v1.15.2 

func (c *IoT) ListActiveViolationsWithContext(ctx aws.Context, input *ListActiveViolationsInput, opts ...request.Option) (*ListActiveViolationsOutput, error)

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

See ListActiveViolations 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.

Requires permission to access the ListAttachedPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

func (*IoT) ListAttachedPoliciesPages added in v1.34.3 

func (c *IoT) ListAttachedPoliciesPages(input *ListAttachedPoliciesInput, fn func(*ListAttachedPoliciesOutput, bool) bool) error

ListAttachedPoliciesPages iterates over the pages of a ListAttachedPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAttachedPolicies method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAttachedPolicies operation.
pageNum := 0
err := client.ListAttachedPoliciesPages(params,
    func(page *iot.ListAttachedPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAttachedPoliciesPagesWithContext added in v1.34.3 

func (c *IoT) ListAttachedPoliciesPagesWithContext(ctx aws.Context, input *ListAttachedPoliciesInput, fn func(*ListAttachedPoliciesOutput, bool) bool, opts ...request.Option) error

ListAttachedPoliciesPagesWithContext same as ListAttachedPoliciesPages except it takes a Context and allows setting request options on the pages.

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

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) ListAuditFindings added in v1.15.2 

func (c *IoT) ListAuditFindings(input *ListAuditFindingsInput) (*ListAuditFindingsOutput, error)

ListAuditFindings API operation for AWS IoT.

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)

Requires permission to access the ListAuditFindings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuditFindingsPages added in v1.34.3 

func (c *IoT) ListAuditFindingsPages(input *ListAuditFindingsInput, fn func(*ListAuditFindingsOutput, bool) bool) error

ListAuditFindingsPages iterates over the pages of a ListAuditFindings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuditFindings method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuditFindings operation.
pageNum := 0
err := client.ListAuditFindingsPages(params,
    func(page *iot.ListAuditFindingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuditFindingsPagesWithContext added in v1.34.3 

func (c *IoT) ListAuditFindingsPagesWithContext(ctx aws.Context, input *ListAuditFindingsInput, fn func(*ListAuditFindingsOutput, bool) bool, opts ...request.Option) error

ListAuditFindingsPagesWithContext same as ListAuditFindingsPages except it takes a Context and allows setting request options on the pages.

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) ListAuditFindingsRequest added in v1.15.2 

func (c *IoT) ListAuditFindingsRequest(input *ListAuditFindingsInput) (req *request.Request, output *ListAuditFindingsOutput)

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

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 ListAuditFindings for more information on using the ListAuditFindings 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 ListAuditFindingsRequest method.
req, resp := client.ListAuditFindingsRequest(params)

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

func (*IoT) ListAuditFindingsWithContext added in v1.15.2 

func (c *IoT) ListAuditFindingsWithContext(ctx aws.Context, input *ListAuditFindingsInput, opts ...request.Option) (*ListAuditFindingsOutput, error)

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

See ListAuditFindings 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) ListAuditMitigationActionsExecutions added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsExecutions(input *ListAuditMitigationActionsExecutionsInput) (*ListAuditMitigationActionsExecutionsOutput, error)

ListAuditMitigationActionsExecutions API operation for AWS IoT.

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuditMitigationActionsExecutionsPages added in v1.34.3 

func (c *IoT) ListAuditMitigationActionsExecutionsPages(input *ListAuditMitigationActionsExecutionsInput, fn func(*ListAuditMitigationActionsExecutionsOutput, bool) bool) error

ListAuditMitigationActionsExecutionsPages iterates over the pages of a ListAuditMitigationActionsExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuditMitigationActionsExecutions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuditMitigationActionsExecutions operation.
pageNum := 0
err := client.ListAuditMitigationActionsExecutionsPages(params,
    func(page *iot.ListAuditMitigationActionsExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuditMitigationActionsExecutionsPagesWithContext added in v1.34.3 

func (c *IoT) ListAuditMitigationActionsExecutionsPagesWithContext(ctx aws.Context, input *ListAuditMitigationActionsExecutionsInput, fn func(*ListAuditMitigationActionsExecutionsOutput, bool) bool, opts ...request.Option) error

ListAuditMitigationActionsExecutionsPagesWithContext same as ListAuditMitigationActionsExecutionsPages except it takes a Context and allows setting request options on the pages.

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) ListAuditMitigationActionsExecutionsRequest added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsExecutionsRequest(input *ListAuditMitigationActionsExecutionsInput) (req *request.Request, output *ListAuditMitigationActionsExecutionsOutput)

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

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 ListAuditMitigationActionsExecutions for more information on using the ListAuditMitigationActionsExecutions 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 ListAuditMitigationActionsExecutionsRequest method.
req, resp := client.ListAuditMitigationActionsExecutionsRequest(params)

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

func (*IoT) ListAuditMitigationActionsExecutionsWithContext added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsExecutionsWithContext(ctx aws.Context, input *ListAuditMitigationActionsExecutionsInput, opts ...request.Option) (*ListAuditMitigationActionsExecutionsOutput, error)

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

See ListAuditMitigationActionsExecutions 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) ListAuditMitigationActionsTasks added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsTasks(input *ListAuditMitigationActionsTasksInput) (*ListAuditMitigationActionsTasksOutput, error)

ListAuditMitigationActionsTasks API operation for AWS IoT.

Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuditMitigationActionsTasksPages added in v1.34.3 

func (c *IoT) ListAuditMitigationActionsTasksPages(input *ListAuditMitigationActionsTasksInput, fn func(*ListAuditMitigationActionsTasksOutput, bool) bool) error

ListAuditMitigationActionsTasksPages iterates over the pages of a ListAuditMitigationActionsTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuditMitigationActionsTasks method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuditMitigationActionsTasks operation.
pageNum := 0
err := client.ListAuditMitigationActionsTasksPages(params,
    func(page *iot.ListAuditMitigationActionsTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuditMitigationActionsTasksPagesWithContext added in v1.34.3 

func (c *IoT) ListAuditMitigationActionsTasksPagesWithContext(ctx aws.Context, input *ListAuditMitigationActionsTasksInput, fn func(*ListAuditMitigationActionsTasksOutput, bool) bool, opts ...request.Option) error

ListAuditMitigationActionsTasksPagesWithContext same as ListAuditMitigationActionsTasksPages except it takes a Context and allows setting request options on the pages.

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) ListAuditMitigationActionsTasksRequest added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsTasksRequest(input *ListAuditMitigationActionsTasksInput) (req *request.Request, output *ListAuditMitigationActionsTasksOutput)

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

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 ListAuditMitigationActionsTasks for more information on using the ListAuditMitigationActionsTasks 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 ListAuditMitigationActionsTasksRequest method.
req, resp := client.ListAuditMitigationActionsTasksRequest(params)

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

func (*IoT) ListAuditMitigationActionsTasksWithContext added in v1.21.10 

func (c *IoT) ListAuditMitigationActionsTasksWithContext(ctx aws.Context, input *ListAuditMitigationActionsTasksInput, opts ...request.Option) (*ListAuditMitigationActionsTasksOutput, error)

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

See ListAuditMitigationActionsTasks 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) ListAuditSuppressions added in v1.34.3 

func (c *IoT) ListAuditSuppressions(input *ListAuditSuppressionsInput) (*ListAuditSuppressionsOutput, error)

ListAuditSuppressions API operation for AWS IoT.

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuditSuppressionsPages added in v1.34.3 

func (c *IoT) ListAuditSuppressionsPages(input *ListAuditSuppressionsInput, fn func(*ListAuditSuppressionsOutput, bool) bool) error

ListAuditSuppressionsPages iterates over the pages of a ListAuditSuppressions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuditSuppressions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuditSuppressions operation.
pageNum := 0
err := client.ListAuditSuppressionsPages(params,
    func(page *iot.ListAuditSuppressionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuditSuppressionsPagesWithContext added in v1.34.3 

func (c *IoT) ListAuditSuppressionsPagesWithContext(ctx aws.Context, input *ListAuditSuppressionsInput, fn func(*ListAuditSuppressionsOutput, bool) bool, opts ...request.Option) error

ListAuditSuppressionsPagesWithContext same as ListAuditSuppressionsPages except it takes a Context and allows setting request options on the pages.

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) ListAuditSuppressionsRequest added in v1.34.3 

func (c *IoT) ListAuditSuppressionsRequest(input *ListAuditSuppressionsInput) (req *request.Request, output *ListAuditSuppressionsOutput)

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

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 ListAuditSuppressions for more information on using the ListAuditSuppressions 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 ListAuditSuppressionsRequest method.
req, resp := client.ListAuditSuppressionsRequest(params)

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

func (*IoT) ListAuditSuppressionsWithContext added in v1.34.3 

func (c *IoT) ListAuditSuppressionsWithContext(ctx aws.Context, input *ListAuditSuppressionsInput, opts ...request.Option) (*ListAuditSuppressionsOutput, error)

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

See ListAuditSuppressions 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) ListAuditTasks added in v1.15.2 

func (c *IoT) ListAuditTasks(input *ListAuditTasksInput) (*ListAuditTasksOutput, error)

ListAuditTasks API operation for AWS IoT.

Lists the Device Defender audits that have been performed during a given time period.

Requires permission to access the ListAuditTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuditTasksPages added in v1.34.3 

func (c *IoT) ListAuditTasksPages(input *ListAuditTasksInput, fn func(*ListAuditTasksOutput, bool) bool) error

ListAuditTasksPages iterates over the pages of a ListAuditTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuditTasks method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuditTasks operation.
pageNum := 0
err := client.ListAuditTasksPages(params,
    func(page *iot.ListAuditTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuditTasksPagesWithContext added in v1.34.3 

func (c *IoT) ListAuditTasksPagesWithContext(ctx aws.Context, input *ListAuditTasksInput, fn func(*ListAuditTasksOutput, bool) bool, opts ...request.Option) error

ListAuditTasksPagesWithContext same as ListAuditTasksPages except it takes a Context and allows setting request options on the pages.

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) ListAuditTasksRequest added in v1.15.2 

func (c *IoT) ListAuditTasksRequest(input *ListAuditTasksInput) (req *request.Request, output *ListAuditTasksOutput)

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

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 ListAuditTasks for more information on using the ListAuditTasks 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 ListAuditTasksRequest method.
req, resp := client.ListAuditTasksRequest(params)

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

func (*IoT) ListAuditTasksWithContext added in v1.15.2 

func (c *IoT) ListAuditTasksWithContext(ctx aws.Context, input *ListAuditTasksInput, opts ...request.Option) (*ListAuditTasksOutput, error)

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

See ListAuditTasks 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.

Requires permission to access the ListAuthorizers (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListAuthorizersPages added in v1.34.3 

func (c *IoT) ListAuthorizersPages(input *ListAuthorizersInput, fn func(*ListAuthorizersOutput, bool) bool) error

ListAuthorizersPages iterates over the pages of a ListAuthorizers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAuthorizers method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListAuthorizers operation.
pageNum := 0
err := client.ListAuthorizersPages(params,
    func(page *iot.ListAuthorizersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListAuthorizersPagesWithContext added in v1.34.3 

func (c *IoT) ListAuthorizersPagesWithContext(ctx aws.Context, input *ListAuthorizersInput, fn func(*ListAuthorizersOutput, bool) bool, opts ...request.Option) error

ListAuthorizersPagesWithContext same as ListAuthorizersPages except it takes a Context and allows setting request options on the pages.

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

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) ListBillingGroups added in v1.15.79 

func (c *IoT) ListBillingGroups(input *ListBillingGroupsInput) (*ListBillingGroupsOutput, error)

ListBillingGroups API operation for AWS IoT.

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListBillingGroupsPages added in v1.34.3 

func (c *IoT) ListBillingGroupsPages(input *ListBillingGroupsInput, fn func(*ListBillingGroupsOutput, bool) bool) error

ListBillingGroupsPages iterates over the pages of a ListBillingGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBillingGroups method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListBillingGroups operation.
pageNum := 0
err := client.ListBillingGroupsPages(params,
    func(page *iot.ListBillingGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListBillingGroupsPagesWithContext added in v1.34.3 

func (c *IoT) ListBillingGroupsPagesWithContext(ctx aws.Context, input *ListBillingGroupsInput, fn func(*ListBillingGroupsOutput, bool) bool, opts ...request.Option) error

ListBillingGroupsPagesWithContext same as ListBillingGroupsPages except it takes a Context and allows setting request options on the pages.

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) ListBillingGroupsRequest added in v1.15.79 

func (c *IoT) ListBillingGroupsRequest(input *ListBillingGroupsInput) (req *request.Request, output *ListBillingGroupsOutput)

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

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 ListBillingGroups for more information on using the ListBillingGroups 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 ListBillingGroupsRequest method.
req, resp := client.ListBillingGroupsRequest(params)

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

func (*IoT) ListBillingGroupsWithContext added in v1.15.79 

func (c *IoT) ListBillingGroupsWithContext(ctx aws.Context, input *ListBillingGroupsInput, opts ...request.Option) (*ListBillingGroupsOutput, error)

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

See ListBillingGroups 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 Amazon Web Services account.

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

Requires permission to access the ListCACertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListCACertificatesPages added in v1.34.3 

func (c *IoT) ListCACertificatesPages(input *ListCACertificatesInput, fn func(*ListCACertificatesOutput, bool) bool) error

ListCACertificatesPages iterates over the pages of a ListCACertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCACertificates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListCACertificates operation.
pageNum := 0
err := client.ListCACertificatesPages(params,
    func(page *iot.ListCACertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListCACertificatesPagesWithContext added in v1.34.3 

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

ListCACertificatesPagesWithContext same as ListCACertificatesPages except it takes a Context and allows setting request options on the pages.

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

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 Amazon Web Services account.

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

Requires permission to access the ListCertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

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

Requires permission to access the ListCertificatesByCA (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListCertificatesByCAPages added in v1.34.3 

func (c *IoT) ListCertificatesByCAPages(input *ListCertificatesByCAInput, fn func(*ListCertificatesByCAOutput, bool) bool) error

ListCertificatesByCAPages iterates over the pages of a ListCertificatesByCA operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCertificatesByCA method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListCertificatesByCA operation.
pageNum := 0
err := client.ListCertificatesByCAPages(params,
    func(page *iot.ListCertificatesByCAOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListCertificatesByCAPagesWithContext added in v1.34.3 

func (c *IoT) ListCertificatesByCAPagesWithContext(ctx aws.Context, input *ListCertificatesByCAInput, fn func(*ListCertificatesByCAOutput, bool) bool, opts ...request.Option) error

ListCertificatesByCAPagesWithContext same as ListCertificatesByCAPages except it takes a Context and allows setting request options on the pages.

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

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) ListCertificatesPages added in v1.34.3 

func (c *IoT) ListCertificatesPages(input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool) error

ListCertificatesPages iterates over the pages of a ListCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCertificates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListCertificates operation.
pageNum := 0
err := client.ListCertificatesPages(params,
    func(page *iot.ListCertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListCertificatesPagesWithContext added in v1.34.3 

func (c *IoT) ListCertificatesPagesWithContext(ctx aws.Context, input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool, opts ...request.Option) error

ListCertificatesPagesWithContext same as ListCertificatesPages except it takes a Context and allows setting request options on the pages.

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

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) ListCustomMetrics added in v1.36.9 

func (c *IoT) ListCustomMetrics(input *ListCustomMetricsInput) (*ListCustomMetricsOutput, error)

ListCustomMetrics API operation for AWS IoT.

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListCustomMetricsPages added in v1.36.9 

func (c *IoT) ListCustomMetricsPages(input *ListCustomMetricsInput, fn func(*ListCustomMetricsOutput, bool) bool) error

ListCustomMetricsPages iterates over the pages of a ListCustomMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCustomMetrics method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListCustomMetrics operation.
pageNum := 0
err := client.ListCustomMetricsPages(params,
    func(page *iot.ListCustomMetricsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListCustomMetricsPagesWithContext added in v1.36.9 

func (c *IoT) ListCustomMetricsPagesWithContext(ctx aws.Context, input *ListCustomMetricsInput, fn func(*ListCustomMetricsOutput, bool) bool, opts ...request.Option) error

ListCustomMetricsPagesWithContext same as ListCustomMetricsPages except it takes a Context and allows setting request options on the pages.

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) ListCustomMetricsRequest added in v1.36.9 

func (c *IoT) ListCustomMetricsRequest(input *ListCustomMetricsInput) (req *request.Request, output *ListCustomMetricsOutput)

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

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 ListCustomMetrics for more information on using the ListCustomMetrics 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 ListCustomMetricsRequest method.
req, resp := client.ListCustomMetricsRequest(params)

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

func (*IoT) ListCustomMetricsWithContext added in v1.36.9 

func (c *IoT) ListCustomMetricsWithContext(ctx aws.Context, input *ListCustomMetricsInput, opts ...request.Option) (*ListCustomMetricsOutput, error)

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

See ListCustomMetrics 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) ListDetectMitigationActionsExecutions added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsExecutions(input *ListDetectMitigationActionsExecutionsInput) (*ListDetectMitigationActionsExecutionsOutput, error)

ListDetectMitigationActionsExecutions API operation for AWS IoT.

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListDetectMitigationActionsExecutionsPages added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsExecutionsPages(input *ListDetectMitigationActionsExecutionsInput, fn func(*ListDetectMitigationActionsExecutionsOutput, bool) bool) error

ListDetectMitigationActionsExecutionsPages iterates over the pages of a ListDetectMitigationActionsExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDetectMitigationActionsExecutions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDetectMitigationActionsExecutions operation.
pageNum := 0
err := client.ListDetectMitigationActionsExecutionsPages(params,
    func(page *iot.ListDetectMitigationActionsExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListDetectMitigationActionsExecutionsPagesWithContext added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsExecutionsPagesWithContext(ctx aws.Context, input *ListDetectMitigationActionsExecutionsInput, fn func(*ListDetectMitigationActionsExecutionsOutput, bool) bool, opts ...request.Option) error

ListDetectMitigationActionsExecutionsPagesWithContext same as ListDetectMitigationActionsExecutionsPages except it takes a Context and allows setting request options on the pages.

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) ListDetectMitigationActionsExecutionsRequest added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsExecutionsRequest(input *ListDetectMitigationActionsExecutionsInput) (req *request.Request, output *ListDetectMitigationActionsExecutionsOutput)

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

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 ListDetectMitigationActionsExecutions for more information on using the ListDetectMitigationActionsExecutions 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 ListDetectMitigationActionsExecutionsRequest method.
req, resp := client.ListDetectMitigationActionsExecutionsRequest(params)

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

func (*IoT) ListDetectMitigationActionsExecutionsWithContext added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsExecutionsWithContext(ctx aws.Context, input *ListDetectMitigationActionsExecutionsInput, opts ...request.Option) (*ListDetectMitigationActionsExecutionsOutput, error)

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

See ListDetectMitigationActionsExecutions 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) ListDetectMitigationActionsTasks added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsTasks(input *ListDetectMitigationActionsTasksInput) (*ListDetectMitigationActionsTasksOutput, error)

ListDetectMitigationActionsTasks API operation for AWS IoT.

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListDetectMitigationActionsTasksPages added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsTasksPages(input *ListDetectMitigationActionsTasksInput, fn func(*ListDetectMitigationActionsTasksOutput, bool) bool) error

ListDetectMitigationActionsTasksPages iterates over the pages of a ListDetectMitigationActionsTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDetectMitigationActionsTasks method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDetectMitigationActionsTasks operation.
pageNum := 0
err := client.ListDetectMitigationActionsTasksPages(params,
    func(page *iot.ListDetectMitigationActionsTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListDetectMitigationActionsTasksPagesWithContext added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsTasksPagesWithContext(ctx aws.Context, input *ListDetectMitigationActionsTasksInput, fn func(*ListDetectMitigationActionsTasksOutput, bool) bool, opts ...request.Option) error

ListDetectMitigationActionsTasksPagesWithContext same as ListDetectMitigationActionsTasksPages except it takes a Context and allows setting request options on the pages.

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) ListDetectMitigationActionsTasksRequest added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsTasksRequest(input *ListDetectMitigationActionsTasksInput) (req *request.Request, output *ListDetectMitigationActionsTasksOutput)

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

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 ListDetectMitigationActionsTasks for more information on using the ListDetectMitigationActionsTasks 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 ListDetectMitigationActionsTasksRequest method.
req, resp := client.ListDetectMitigationActionsTasksRequest(params)

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

func (*IoT) ListDetectMitigationActionsTasksWithContext added in v1.36.9 

func (c *IoT) ListDetectMitigationActionsTasksWithContext(ctx aws.Context, input *ListDetectMitigationActionsTasksInput, opts ...request.Option) (*ListDetectMitigationActionsTasksOutput, error)

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

See ListDetectMitigationActionsTasks 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) ListDimensions added in v1.30.2 

func (c *IoT) ListDimensions(input *ListDimensionsInput) (*ListDimensionsOutput, error)

ListDimensions API operation for AWS IoT.

List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListDimensionsPages added in v1.34.3 

func (c *IoT) ListDimensionsPages(input *ListDimensionsInput, fn func(*ListDimensionsOutput, bool) bool) error

ListDimensionsPages iterates over the pages of a ListDimensions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDimensions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDimensions operation.
pageNum := 0
err := client.ListDimensionsPages(params,
    func(page *iot.ListDimensionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListDimensionsPagesWithContext added in v1.34.3 

func (c *IoT) ListDimensionsPagesWithContext(ctx aws.Context, input *ListDimensionsInput, fn func(*ListDimensionsOutput, bool) bool, opts ...request.Option) error

ListDimensionsPagesWithContext same as ListDimensionsPages except it takes a Context and allows setting request options on the pages.

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) ListDimensionsRequest added in v1.30.2 

func (c *IoT) ListDimensionsRequest(input *ListDimensionsInput) (req *request.Request, output *ListDimensionsOutput)

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

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 ListDimensions for more information on using the ListDimensions 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 ListDimensionsRequest method.
req, resp := client.ListDimensionsRequest(params)

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

func (*IoT) ListDimensionsWithContext added in v1.30.2 

func (c *IoT) ListDimensionsWithContext(ctx aws.Context, input *ListDimensionsInput, opts ...request.Option) (*ListDimensionsOutput, error)

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

See ListDimensions 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) ListDomainConfigurations added in v1.25.42 

func (c *IoT) ListDomainConfigurations(input *ListDomainConfigurationsInput) (*ListDomainConfigurationsOutput, error)

ListDomainConfigurations API operation for AWS IoT.

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListDomainConfigurationsPages added in v1.34.3 

func (c *IoT) ListDomainConfigurationsPages(input *ListDomainConfigurationsInput, fn func(*ListDomainConfigurationsOutput, bool) bool) error

ListDomainConfigurationsPages iterates over the pages of a ListDomainConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomainConfigurations method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDomainConfigurations operation.
pageNum := 0
err := client.ListDomainConfigurationsPages(params,
    func(page *iot.ListDomainConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListDomainConfigurationsPagesWithContext added in v1.34.3 

func (c *IoT) ListDomainConfigurationsPagesWithContext(ctx aws.Context, input *ListDomainConfigurationsInput, fn func(*ListDomainConfigurationsOutput, bool) bool, opts ...request.Option) error

ListDomainConfigurationsPagesWithContext same as ListDomainConfigurationsPages except it takes a Context and allows setting request options on the pages.

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) ListDomainConfigurationsRequest added in v1.25.42 

func (c *IoT) ListDomainConfigurationsRequest(input *ListDomainConfigurationsInput) (req *request.Request, output *ListDomainConfigurationsOutput)

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

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 ListDomainConfigurations for more information on using the ListDomainConfigurations 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 ListDomainConfigurationsRequest method.
req, resp := client.ListDomainConfigurationsRequest(params)

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

func (*IoT) ListDomainConfigurationsWithContext added in v1.25.42 

func (c *IoT) ListDomainConfigurationsWithContext(ctx aws.Context, input *ListDomainConfigurationsInput, opts ...request.Option) (*ListDomainConfigurationsOutput, error)

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

See ListDomainConfigurations 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) ListFleetMetrics added in v1.40.34 

func (c *IoT) ListFleetMetrics(input *ListFleetMetricsInput) (*ListFleetMetricsOutput, error)

ListFleetMetrics API operation for AWS IoT.

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListFleetMetricsPages added in v1.40.34 

func (c *IoT) ListFleetMetricsPages(input *ListFleetMetricsInput, fn func(*ListFleetMetricsOutput, bool) bool) error

ListFleetMetricsPages iterates over the pages of a ListFleetMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFleetMetrics method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListFleetMetrics operation.
pageNum := 0
err := client.ListFleetMetricsPages(params,
    func(page *iot.ListFleetMetricsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListFleetMetricsPagesWithContext added in v1.40.34 

func (c *IoT) ListFleetMetricsPagesWithContext(ctx aws.Context, input *ListFleetMetricsInput, fn func(*ListFleetMetricsOutput, bool) bool, opts ...request.Option) error

ListFleetMetricsPagesWithContext same as ListFleetMetricsPages except it takes a Context and allows setting request options on the pages.

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) ListFleetMetricsRequest added in v1.40.34 

func (c *IoT) ListFleetMetricsRequest(input *ListFleetMetricsInput) (req *request.Request, output *ListFleetMetricsOutput)

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

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 ListFleetMetrics for more information on using the ListFleetMetrics 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 ListFleetMetricsRequest method.
req, resp := client.ListFleetMetricsRequest(params)

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

func (*IoT) ListFleetMetricsWithContext added in v1.40.34 

func (c *IoT) ListFleetMetricsWithContext(ctx aws.Context, input *ListFleetMetricsInput, opts ...request.Option) (*ListFleetMetricsOutput, error)

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

See ListFleetMetrics 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.

Requires permission to access the ListIndices (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListIndicesPages added in v1.34.3 

func (c *IoT) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error

ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndices method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListIndices operation.
pageNum := 0
err := client.ListIndicesPages(params,
    func(page *iot.ListIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListIndicesPagesWithContext added in v1.34.3 

func (c *IoT) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error

ListIndicesPagesWithContext same as ListIndicesPages except it takes a Context and allows setting request options on the pages.

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

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.

Requires permission to access the ListJobExecutionsForJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListJobExecutionsForJobPages added in v1.34.3 

func (c *IoT) ListJobExecutionsForJobPages(input *ListJobExecutionsForJobInput, fn func(*ListJobExecutionsForJobOutput, bool) bool) error

ListJobExecutionsForJobPages iterates over the pages of a ListJobExecutionsForJob operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobExecutionsForJob method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListJobExecutionsForJob operation.
pageNum := 0
err := client.ListJobExecutionsForJobPages(params,
    func(page *iot.ListJobExecutionsForJobOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListJobExecutionsForJobPagesWithContext added in v1.34.3 

func (c *IoT) ListJobExecutionsForJobPagesWithContext(ctx aws.Context, input *ListJobExecutionsForJobInput, fn func(*ListJobExecutionsForJobOutput, bool) bool, opts ...request.Option) error

ListJobExecutionsForJobPagesWithContext same as ListJobExecutionsForJobPages except it takes a Context and allows setting request options on the pages.

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

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.

Requires permission to access the ListJobExecutionsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListJobExecutionsForThingPages added in v1.34.3 

func (c *IoT) ListJobExecutionsForThingPages(input *ListJobExecutionsForThingInput, fn func(*ListJobExecutionsForThingOutput, bool) bool) error

ListJobExecutionsForThingPages iterates over the pages of a ListJobExecutionsForThing operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobExecutionsForThing method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListJobExecutionsForThing operation.
pageNum := 0
err := client.ListJobExecutionsForThingPages(params,
    func(page *iot.ListJobExecutionsForThingOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListJobExecutionsForThingPagesWithContext added in v1.34.3 

func (c *IoT) ListJobExecutionsForThingPagesWithContext(ctx aws.Context, input *ListJobExecutionsForThingInput, fn func(*ListJobExecutionsForThingOutput, bool) bool, opts ...request.Option) error

ListJobExecutionsForThingPagesWithContext same as ListJobExecutionsForThingPages except it takes a Context and allows setting request options on the pages.

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

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) ListJobTemplates added in v1.38.47 

func (c *IoT) ListJobTemplates(input *ListJobTemplatesInput) (*ListJobTemplatesOutput, error)

ListJobTemplates API operation for AWS IoT.

Returns a list of job templates.

Requires permission to access the ListJobTemplates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListJobTemplatesPages added in v1.40.34 

func (c *IoT) ListJobTemplatesPages(input *ListJobTemplatesInput, fn func(*ListJobTemplatesOutput, bool) bool) error

ListJobTemplatesPages iterates over the pages of a ListJobTemplates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobTemplates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListJobTemplates operation.
pageNum := 0
err := client.ListJobTemplatesPages(params,
    func(page *iot.ListJobTemplatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListJobTemplatesPagesWithContext added in v1.40.34 

func (c *IoT) ListJobTemplatesPagesWithContext(ctx aws.Context, input *ListJobTemplatesInput, fn func(*ListJobTemplatesOutput, bool) bool, opts ...request.Option) error

ListJobTemplatesPagesWithContext same as ListJobTemplatesPages except it takes a Context and allows setting request options on the pages.

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) ListJobTemplatesRequest added in v1.38.47 

func (c *IoT) ListJobTemplatesRequest(input *ListJobTemplatesInput) (req *request.Request, output *ListJobTemplatesOutput)

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

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 ListJobTemplates for more information on using the ListJobTemplates 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 ListJobTemplatesRequest method.
req, resp := client.ListJobTemplatesRequest(params)

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

func (*IoT) ListJobTemplatesWithContext added in v1.38.47 

func (c *IoT) ListJobTemplatesWithContext(ctx aws.Context, input *ListJobTemplatesInput, opts ...request.Option) (*ListJobTemplatesOutput, error)

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

See ListJobTemplates 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.

Requires permission to access the ListJobs (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListJobsPages added in v1.34.3 

func (c *IoT) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *iot.ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListJobsPagesWithContext added in v1.34.3 

func (c *IoT) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

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

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) ListManagedJobTemplates added in v1.42.11 

func (c *IoT) ListManagedJobTemplates(input *ListManagedJobTemplatesInput) (*ListManagedJobTemplatesOutput, error)

ListManagedJobTemplates API operation for AWS IoT.

Returns a list of managed job templates.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalServerException Internal error from the service that indicates an unexpected error or that the service is unavailable.

func (*IoT) ListManagedJobTemplatesRequest added in v1.42.11 

func (c *IoT) ListManagedJobTemplatesRequest(input *ListManagedJobTemplatesInput) (req *request.Request, output *ListManagedJobTemplatesOutput)

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

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 ListManagedJobTemplates for more information on using the ListManagedJobTemplates 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 ListManagedJobTemplatesRequest method.
req, resp := client.ListManagedJobTemplatesRequest(params)

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

func (*IoT) ListManagedJobTemplatesWithContext added in v1.42.11 

func (c *IoT) ListManagedJobTemplatesWithContext(ctx aws.Context, input *ListManagedJobTemplatesInput, opts ...request.Option) (*ListManagedJobTemplatesOutput, error)

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

See ListManagedJobTemplates 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) ListMetricValues added in v1.43.32 

func (c *IoT) ListMetricValues(input *ListMetricValuesInput) (*ListMetricValuesOutput, error)

ListMetricValues API operation for AWS IoT.

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

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

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) ListMetricValuesPages added in v1.43.32 

func (c *IoT) ListMetricValuesPages(input *ListMetricValuesInput, fn func(*ListMetricValuesOutput, bool) bool) error

ListMetricValuesPages iterates over the pages of a ListMetricValues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMetricValues method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListMetricValues operation.
pageNum := 0
err := client.ListMetricValuesPages(params,
    func(page *iot.ListMetricValuesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListMetricValuesPagesWithContext added in v1.43.32 

func (c *IoT) ListMetricValuesPagesWithContext(ctx aws.Context, input *ListMetricValuesInput, fn func(*ListMetricValuesOutput, bool) bool, opts ...request.Option) error

ListMetricValuesPagesWithContext same as ListMetricValuesPages except it takes a Context and allows setting request options on the pages.

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) ListMetricValuesRequest added in v1.43.32 

func (c *IoT) ListMetricValuesRequest(input *ListMetricValuesInput) (req *request.Request, output *ListMetricValuesOutput)

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

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 ListMetricValues for more information on using the ListMetricValues 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 ListMetricValuesRequest method.
req, resp := client.ListMetricValuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListMetricValuesWithContext added in v1.43.32 

func (c *IoT) ListMetricValuesWithContext(ctx aws.Context, input *ListMetricValuesInput, opts ...request.Option) (*ListMetricValuesOutput, error)

ListMetricValuesWithContext is the same as ListMetricValues with the addition of the ability to pass a context and additional request options.

See ListMetricValues 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) ListMitigationActions added in v1.21.10 

func (c *IoT) ListMitigationActions(input *ListMitigationActionsInput) (*ListMitigationActionsOutput, error)

ListMitigationActions API operation for AWS IoT.

Gets a list of all mitigation actions that match the specified filter criteria.

Requires permission to access the ListMitigationActions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListMitigationActions for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListMitigationActionsPages added in v1.34.3 

func (c *IoT) ListMitigationActionsPages(input *ListMitigationActionsInput, fn func(*ListMitigationActionsOutput, bool) bool) error

ListMitigationActionsPages iterates over the pages of a ListMitigationActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMitigationActions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMitigationActions operation.
pageNum := 0
err := client.ListMitigationActionsPages(params,
    func(page *iot.ListMitigationActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListMitigationActionsPagesWithContext added in v1.34.3 

func (c *IoT) ListMitigationActionsPagesWithContext(ctx aws.Context, input *ListMitigationActionsInput, fn func(*ListMitigationActionsOutput, bool) bool, opts ...request.Option) error

ListMitigationActionsPagesWithContext same as ListMitigationActionsPages except it takes a Context and allows setting request options on the pages.

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) ListMitigationActionsRequest added in v1.21.10 

func (c *IoT) ListMitigationActionsRequest(input *ListMitigationActionsInput) (req *request.Request, output *ListMitigationActionsOutput)

ListMitigationActionsRequest generates a "aws/request.Request" representing the client's request for the ListMitigationActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListMitigationActions for more information on using the ListMitigationActions 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 ListMitigationActionsRequest method.
req, resp := client.ListMitigationActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListMitigationActionsWithContext added in v1.21.10 

func (c *IoT) ListMitigationActionsWithContext(ctx aws.Context, input *ListMitigationActionsInput, opts ...request.Option) (*ListMitigationActionsOutput, error)

ListMitigationActionsWithContext is the same as ListMitigationActions with the addition of the ability to pass a context and additional request options.

See ListMitigationActions 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.

Requires permission to access the ListOTAUpdates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListOTAUpdatesPages added in v1.34.3 

func (c *IoT) ListOTAUpdatesPages(input *ListOTAUpdatesInput, fn func(*ListOTAUpdatesOutput, bool) bool) error

ListOTAUpdatesPages iterates over the pages of a ListOTAUpdates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOTAUpdates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListOTAUpdates operation.
pageNum := 0
err := client.ListOTAUpdatesPages(params,
    func(page *iot.ListOTAUpdatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListOTAUpdatesPagesWithContext added in v1.34.3 

func (c *IoT) ListOTAUpdatesPagesWithContext(ctx aws.Context, input *ListOTAUpdatesInput, fn func(*ListOTAUpdatesOutput, bool) bool, opts ...request.Option) error

ListOTAUpdatesPagesWithContext same as ListOTAUpdatesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListOutgoingCertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListOutgoingCertificatesPages added in v1.34.3 

func (c *IoT) ListOutgoingCertificatesPages(input *ListOutgoingCertificatesInput, fn func(*ListOutgoingCertificatesOutput, bool) bool) error

ListOutgoingCertificatesPages iterates over the pages of a ListOutgoingCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOutgoingCertificates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListOutgoingCertificates operation.
pageNum := 0
err := client.ListOutgoingCertificatesPages(params,
    func(page *iot.ListOutgoingCertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListOutgoingCertificatesPagesWithContext added in v1.34.3 

func (c *IoT) ListOutgoingCertificatesPagesWithContext(ctx aws.Context, input *ListOutgoingCertificatesInput, fn func(*ListOutgoingCertificatesOutput, bool) bool, opts ...request.Option) error

ListOutgoingCertificatesPagesWithContext same as ListOutgoingCertificatesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListPoliciesPages added in v1.34.3 

func (c *IoT) ListPoliciesPages(input *ListPoliciesInput, fn func(*ListPoliciesOutput, bool) bool) error

ListPoliciesPages iterates over the pages of a ListPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPolicies operation.
pageNum := 0
err := client.ListPoliciesPages(params,
    func(page *iot.ListPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListPoliciesPagesWithContext added in v1.34.3 

func (c *IoT) ListPoliciesPagesWithContext(ctx aws.Context, input *ListPoliciesInput, fn func(*ListPoliciesOutput, bool) bool, opts ...request.Option) error

ListPoliciesPagesWithContext same as ListPoliciesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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 deprecated 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 action is deprecated. Please use ListTargetsForPolicy instead.

Requires permission to access the ListPolicyPrincipals (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

Deprecated: ListPolicyPrincipals has been deprecated

func (*IoT) ListPolicyPrincipalsPages deprecated added in v1.34.3 

func (c *IoT) ListPolicyPrincipalsPages(input *ListPolicyPrincipalsInput, fn func(*ListPolicyPrincipalsOutput, bool) bool) error

ListPolicyPrincipalsPages iterates over the pages of a ListPolicyPrincipals operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPolicyPrincipals method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPolicyPrincipals operation.
pageNum := 0
err := client.ListPolicyPrincipalsPages(params,
    func(page *iot.ListPolicyPrincipalsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: ListPolicyPrincipalsPages has been deprecated

func (*IoT) ListPolicyPrincipalsPagesWithContext deprecated added in v1.34.3 

func (c *IoT) ListPolicyPrincipalsPagesWithContext(ctx aws.Context, input *ListPolicyPrincipalsInput, fn func(*ListPolicyPrincipalsOutput, bool) bool, opts ...request.Option) error

ListPolicyPrincipalsPagesWithContext same as ListPolicyPrincipalsPages except it takes a Context and allows setting request options on the pages.

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.

Deprecated: ListPolicyPrincipalsPagesWithContext has been deprecated

func (*IoT) ListPolicyPrincipalsRequest deprecated 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 successfully.

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)
}

Deprecated: ListPolicyPrincipals has been deprecated

func (*IoT) ListPolicyPrincipalsWithContext deprecated 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.

Deprecated: ListPolicyPrincipalsWithContext has been deprecated

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.

Requires permission to access the ListPolicyVersions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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 deprecated 

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 (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax).

Note: This action is deprecated. Please use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

Deprecated: ListPrincipalPolicies has been deprecated

func (*IoT) ListPrincipalPoliciesPages deprecated added in v1.34.3 

func (c *IoT) ListPrincipalPoliciesPages(input *ListPrincipalPoliciesInput, fn func(*ListPrincipalPoliciesOutput, bool) bool) error

ListPrincipalPoliciesPages iterates over the pages of a ListPrincipalPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPrincipalPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPrincipalPolicies operation.
pageNum := 0
err := client.ListPrincipalPoliciesPages(params,
    func(page *iot.ListPrincipalPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: ListPrincipalPoliciesPages has been deprecated

func (*IoT) ListPrincipalPoliciesPagesWithContext deprecated added in v1.34.3 

func (c *IoT) ListPrincipalPoliciesPagesWithContext(ctx aws.Context, input *ListPrincipalPoliciesInput, fn func(*ListPrincipalPoliciesOutput, bool) bool, opts ...request.Option) error

ListPrincipalPoliciesPagesWithContext same as ListPrincipalPoliciesPages except it takes a Context and allows setting request options on the pages.

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.

Deprecated: ListPrincipalPoliciesPagesWithContext has been deprecated

func (*IoT) ListPrincipalPoliciesRequest deprecated 

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 successfully.

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)
}

Deprecated: ListPrincipalPolicies has been deprecated

func (*IoT) ListPrincipalPoliciesWithContext deprecated 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.

Deprecated: ListPrincipalPoliciesWithContext has been deprecated

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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListPrincipalThings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) ListPrincipalThingsPages added in v1.34.3 

func (c *IoT) ListPrincipalThingsPages(input *ListPrincipalThingsInput, fn func(*ListPrincipalThingsOutput, bool) bool) error

ListPrincipalThingsPages iterates over the pages of a ListPrincipalThings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPrincipalThings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPrincipalThings operation.
pageNum := 0
err := client.ListPrincipalThingsPages(params,
    func(page *iot.ListPrincipalThingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListPrincipalThingsPagesWithContext added in v1.34.3 

func (c *IoT) ListPrincipalThingsPagesWithContext(ctx aws.Context, input *ListPrincipalThingsInput, fn func(*ListPrincipalThingsOutput, bool) bool, opts ...request.Option) error

ListPrincipalThingsPagesWithContext same as ListPrincipalThingsPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListProvisioningTemplateVersions added in v1.25.42 

func (c *IoT) ListProvisioningTemplateVersions(input *ListProvisioningTemplateVersionsInput) (*ListProvisioningTemplateVersionsOutput, error)

ListProvisioningTemplateVersions API operation for AWS IoT.

A list of fleet provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListProvisioningTemplateVersions for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) ListProvisioningTemplateVersionsPages added in v1.34.3 

func (c *IoT) ListProvisioningTemplateVersionsPages(input *ListProvisioningTemplateVersionsInput, fn func(*ListProvisioningTemplateVersionsOutput, bool) bool) error

ListProvisioningTemplateVersionsPages iterates over the pages of a ListProvisioningTemplateVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListProvisioningTemplateVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListProvisioningTemplateVersions operation.
pageNum := 0
err := client.ListProvisioningTemplateVersionsPages(params,
    func(page *iot.ListProvisioningTemplateVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListProvisioningTemplateVersionsPagesWithContext added in v1.34.3 

func (c *IoT) ListProvisioningTemplateVersionsPagesWithContext(ctx aws.Context, input *ListProvisioningTemplateVersionsInput, fn func(*ListProvisioningTemplateVersionsOutput, bool) bool, opts ...request.Option) error

ListProvisioningTemplateVersionsPagesWithContext same as ListProvisioningTemplateVersionsPages except it takes a Context and allows setting request options on the pages.

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) ListProvisioningTemplateVersionsRequest added in v1.25.42 

func (c *IoT) ListProvisioningTemplateVersionsRequest(input *ListProvisioningTemplateVersionsInput) (req *request.Request, output *ListProvisioningTemplateVersionsOutput)

ListProvisioningTemplateVersionsRequest generates a "aws/request.Request" representing the client's request for the ListProvisioningTemplateVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListProvisioningTemplateVersions for more information on using the ListProvisioningTemplateVersions 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 ListProvisioningTemplateVersionsRequest method.
req, resp := client.ListProvisioningTemplateVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListProvisioningTemplateVersionsWithContext added in v1.25.42 

func (c *IoT) ListProvisioningTemplateVersionsWithContext(ctx aws.Context, input *ListProvisioningTemplateVersionsInput, opts ...request.Option) (*ListProvisioningTemplateVersionsOutput, error)

ListProvisioningTemplateVersionsWithContext is the same as ListProvisioningTemplateVersions with the addition of the ability to pass a context and additional request options.

See ListProvisioningTemplateVersions 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) ListProvisioningTemplates added in v1.25.42 

func (c *IoT) ListProvisioningTemplates(input *ListProvisioningTemplatesInput) (*ListProvisioningTemplatesOutput, error)

ListProvisioningTemplates API operation for AWS IoT.

Lists the fleet provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListProvisioningTemplates for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) ListProvisioningTemplatesPages added in v1.34.3 

func (c *IoT) ListProvisioningTemplatesPages(input *ListProvisioningTemplatesInput, fn func(*ListProvisioningTemplatesOutput, bool) bool) error

ListProvisioningTemplatesPages iterates over the pages of a ListProvisioningTemplates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListProvisioningTemplates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListProvisioningTemplates operation.
pageNum := 0
err := client.ListProvisioningTemplatesPages(params,
    func(page *iot.ListProvisioningTemplatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListProvisioningTemplatesPagesWithContext added in v1.34.3 

func (c *IoT) ListProvisioningTemplatesPagesWithContext(ctx aws.Context, input *ListProvisioningTemplatesInput, fn func(*ListProvisioningTemplatesOutput, bool) bool, opts ...request.Option) error

ListProvisioningTemplatesPagesWithContext same as ListProvisioningTemplatesPages except it takes a Context and allows setting request options on the pages.

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) ListProvisioningTemplatesRequest added in v1.25.42 

func (c *IoT) ListProvisioningTemplatesRequest(input *ListProvisioningTemplatesInput) (req *request.Request, output *ListProvisioningTemplatesOutput)

ListProvisioningTemplatesRequest generates a "aws/request.Request" representing the client's request for the ListProvisioningTemplates operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListProvisioningTemplates for more information on using the ListProvisioningTemplates 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 ListProvisioningTemplatesRequest method.
req, resp := client.ListProvisioningTemplatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListProvisioningTemplatesWithContext added in v1.25.42 

func (c *IoT) ListProvisioningTemplatesWithContext(ctx aws.Context, input *ListProvisioningTemplatesInput, opts ...request.Option) (*ListProvisioningTemplatesOutput, error)

ListProvisioningTemplatesWithContext is the same as ListProvisioningTemplates with the addition of the ability to pass a context and additional request options.

See ListProvisioningTemplates 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.

Requires permission to access the ListRoleAliases (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListRoleAliasesPages added in v1.34.3 

func (c *IoT) ListRoleAliasesPages(input *ListRoleAliasesInput, fn func(*ListRoleAliasesOutput, bool) bool) error

ListRoleAliasesPages iterates over the pages of a ListRoleAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRoleAliases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListRoleAliases operation.
pageNum := 0
err := client.ListRoleAliasesPages(params,
    func(page *iot.ListRoleAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListRoleAliasesPagesWithContext added in v1.34.3 

func (c *IoT) ListRoleAliasesPagesWithContext(ctx aws.Context, input *ListRoleAliasesInput, fn func(*ListRoleAliasesOutput, bool) bool, opts ...request.Option) error

ListRoleAliasesPagesWithContext same as ListRoleAliasesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListScheduledAudits added in v1.15.2 

func (c *IoT) ListScheduledAudits(input *ListScheduledAuditsInput) (*ListScheduledAuditsOutput, error)

ListScheduledAudits API operation for AWS IoT.

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListScheduledAudits for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListScheduledAuditsPages added in v1.34.3 

func (c *IoT) ListScheduledAuditsPages(input *ListScheduledAuditsInput, fn func(*ListScheduledAuditsOutput, bool) bool) error

ListScheduledAuditsPages iterates over the pages of a ListScheduledAudits operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListScheduledAudits method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListScheduledAudits operation.
pageNum := 0
err := client.ListScheduledAuditsPages(params,
    func(page *iot.ListScheduledAuditsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListScheduledAuditsPagesWithContext added in v1.34.3 

func (c *IoT) ListScheduledAuditsPagesWithContext(ctx aws.Context, input *ListScheduledAuditsInput, fn func(*ListScheduledAuditsOutput, bool) bool, opts ...request.Option) error

ListScheduledAuditsPagesWithContext same as ListScheduledAuditsPages except it takes a Context and allows setting request options on the pages.

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) ListScheduledAuditsRequest added in v1.15.2 

func (c *IoT) ListScheduledAuditsRequest(input *ListScheduledAuditsInput) (req *request.Request, output *ListScheduledAuditsOutput)

ListScheduledAuditsRequest generates a "aws/request.Request" representing the client's request for the ListScheduledAudits operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListScheduledAudits for more information on using the ListScheduledAudits 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 ListScheduledAuditsRequest method.
req, resp := client.ListScheduledAuditsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListScheduledAuditsWithContext added in v1.15.2 

func (c *IoT) ListScheduledAuditsWithContext(ctx aws.Context, input *ListScheduledAuditsInput, opts ...request.Option) (*ListScheduledAuditsOutput, error)

ListScheduledAuditsWithContext is the same as ListScheduledAudits with the addition of the ability to pass a context and additional request options.

See ListScheduledAudits 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) ListSecurityProfiles added in v1.15.2 

func (c *IoT) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error)

ListSecurityProfiles API operation for AWS IoT.

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

dimensionName and metricName cannot be used in the same request.

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 ListSecurityProfiles for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) ListSecurityProfilesForTarget added in v1.15.2 

func (c *IoT) ListSecurityProfilesForTarget(input *ListSecurityProfilesForTargetInput) (*ListSecurityProfilesForTargetOutput, error)

ListSecurityProfilesForTarget API operation for AWS IoT.

Lists the Device Defender security profiles attached to a target (thing group).

Requires permission to access the ListSecurityProfilesForTarget (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListSecurityProfilesForTarget for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) ListSecurityProfilesForTargetPages added in v1.34.3 

func (c *IoT) ListSecurityProfilesForTargetPages(input *ListSecurityProfilesForTargetInput, fn func(*ListSecurityProfilesForTargetOutput, bool) bool) error

ListSecurityProfilesForTargetPages iterates over the pages of a ListSecurityProfilesForTarget operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSecurityProfilesForTarget method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSecurityProfilesForTarget operation.
pageNum := 0
err := client.ListSecurityProfilesForTargetPages(params,
    func(page *iot.ListSecurityProfilesForTargetOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListSecurityProfilesForTargetPagesWithContext added in v1.34.3 

func (c *IoT) ListSecurityProfilesForTargetPagesWithContext(ctx aws.Context, input *ListSecurityProfilesForTargetInput, fn func(*ListSecurityProfilesForTargetOutput, bool) bool, opts ...request.Option) error

ListSecurityProfilesForTargetPagesWithContext same as ListSecurityProfilesForTargetPages except it takes a Context and allows setting request options on the pages.

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) ListSecurityProfilesForTargetRequest added in v1.15.2 

func (c *IoT) ListSecurityProfilesForTargetRequest(input *ListSecurityProfilesForTargetInput) (req *request.Request, output *ListSecurityProfilesForTargetOutput)

ListSecurityProfilesForTargetRequest generates a "aws/request.Request" representing the client's request for the ListSecurityProfilesForTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListSecurityProfilesForTarget for more information on using the ListSecurityProfilesForTarget 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 ListSecurityProfilesForTargetRequest method.
req, resp := client.ListSecurityProfilesForTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListSecurityProfilesForTargetWithContext added in v1.15.2 

func (c *IoT) ListSecurityProfilesForTargetWithContext(ctx aws.Context, input *ListSecurityProfilesForTargetInput, opts ...request.Option) (*ListSecurityProfilesForTargetOutput, error)

ListSecurityProfilesForTargetWithContext is the same as ListSecurityProfilesForTarget with the addition of the ability to pass a context and additional request options.

See ListSecurityProfilesForTarget 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) ListSecurityProfilesPages added in v1.34.3 

func (c *IoT) ListSecurityProfilesPages(input *ListSecurityProfilesInput, fn func(*ListSecurityProfilesOutput, bool) bool) error

ListSecurityProfilesPages iterates over the pages of a ListSecurityProfiles operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSecurityProfiles method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSecurityProfiles operation.
pageNum := 0
err := client.ListSecurityProfilesPages(params,
    func(page *iot.ListSecurityProfilesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListSecurityProfilesPagesWithContext added in v1.34.3 

func (c *IoT) ListSecurityProfilesPagesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, fn func(*ListSecurityProfilesOutput, bool) bool, opts ...request.Option) error

ListSecurityProfilesPagesWithContext same as ListSecurityProfilesPages except it takes a Context and allows setting request options on the pages.

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) ListSecurityProfilesRequest added in v1.15.2 

func (c *IoT) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput)

ListSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the ListSecurityProfiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListSecurityProfiles for more information on using the ListSecurityProfiles 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 ListSecurityProfilesRequest method.
req, resp := client.ListSecurityProfilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListSecurityProfilesWithContext added in v1.15.2 

func (c *IoT) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error)

ListSecurityProfilesWithContext is the same as ListSecurityProfiles with the addition of the ability to pass a context and additional request options.

See ListSecurityProfiles 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 Amazon Web Services account.

Requires permission to access the ListStreams (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListStreamsPages added in v1.34.3 

func (c *IoT) ListStreamsPages(input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool) error

ListStreamsPages iterates over the pages of a ListStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStreams method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStreams operation.
pageNum := 0
err := client.ListStreamsPages(params,
    func(page *iot.ListStreamsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListStreamsPagesWithContext added in v1.34.3 

func (c *IoT) ListStreamsPagesWithContext(ctx aws.Context, input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool, opts ...request.Option) error

ListStreamsPagesWithContext same as ListStreamsPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListTagsForResource added in v1.15.79 

func (c *IoT) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT.

Lists the tags (metadata) you have assigned to the resource.

Requires permission to access the ListTagsForResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListTagsForResourcePages added in v1.34.3 

func (c *IoT) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *iot.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListTagsForResourcePagesWithContext added in v1.34.3 

func (c *IoT) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

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) ListTagsForResourceRequest added in v1.15.79 

func (c *IoT) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListTagsForResourceWithContext added in v1.15.79 

func (c *IoT) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource 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.

Requires permission to access the ListTargetsForPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

func (*IoT) ListTargetsForPolicyPages added in v1.34.3 

func (c *IoT) ListTargetsForPolicyPages(input *ListTargetsForPolicyInput, fn func(*ListTargetsForPolicyOutput, bool) bool) error

ListTargetsForPolicyPages iterates over the pages of a ListTargetsForPolicy operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTargetsForPolicy method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTargetsForPolicy operation.
pageNum := 0
err := client.ListTargetsForPolicyPages(params,
    func(page *iot.ListTargetsForPolicyOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListTargetsForPolicyPagesWithContext added in v1.34.3 

func (c *IoT) ListTargetsForPolicyPagesWithContext(ctx aws.Context, input *ListTargetsForPolicyInput, fn func(*ListTargetsForPolicyOutput, bool) bool, opts ...request.Option) error

ListTargetsForPolicyPagesWithContext same as ListTargetsForPolicyPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListTargetsForSecurityProfile added in v1.15.2 

func (c *IoT) ListTargetsForSecurityProfile(input *ListTargetsForSecurityProfileInput) (*ListTargetsForSecurityProfileOutput, error)

ListTargetsForSecurityProfile API operation for AWS IoT.

Lists the targets (thing groups) associated with a given Device Defender security profile.

Requires permission to access the ListTargetsForSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListTargetsForSecurityProfile for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListTargetsForSecurityProfilePages added in v1.34.3 

func (c *IoT) ListTargetsForSecurityProfilePages(input *ListTargetsForSecurityProfileInput, fn func(*ListTargetsForSecurityProfileOutput, bool) bool) error

ListTargetsForSecurityProfilePages iterates over the pages of a ListTargetsForSecurityProfile operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTargetsForSecurityProfile method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTargetsForSecurityProfile operation.
pageNum := 0
err := client.ListTargetsForSecurityProfilePages(params,
    func(page *iot.ListTargetsForSecurityProfileOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListTargetsForSecurityProfilePagesWithContext added in v1.34.3 

func (c *IoT) ListTargetsForSecurityProfilePagesWithContext(ctx aws.Context, input *ListTargetsForSecurityProfileInput, fn func(*ListTargetsForSecurityProfileOutput, bool) bool, opts ...request.Option) error

ListTargetsForSecurityProfilePagesWithContext same as ListTargetsForSecurityProfilePages except it takes a Context and allows setting request options on the pages.

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) ListTargetsForSecurityProfileRequest added in v1.15.2 

func (c *IoT) ListTargetsForSecurityProfileRequest(input *ListTargetsForSecurityProfileInput) (req *request.Request, output *ListTargetsForSecurityProfileOutput)

ListTargetsForSecurityProfileRequest generates a "aws/request.Request" representing the client's request for the ListTargetsForSecurityProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListTargetsForSecurityProfile for more information on using the ListTargetsForSecurityProfile 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 ListTargetsForSecurityProfileRequest method.
req, resp := client.ListTargetsForSecurityProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListTargetsForSecurityProfileWithContext added in v1.15.2 

func (c *IoT) ListTargetsForSecurityProfileWithContext(ctx aws.Context, input *ListTargetsForSecurityProfileInput, opts ...request.Option) (*ListTargetsForSecurityProfileOutput, error)

ListTargetsForSecurityProfileWithContext is the same as ListTargetsForSecurityProfile with the addition of the ability to pass a context and additional request options.

See ListTargetsForSecurityProfile 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.

Requires permission to access the ListThingGroups (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

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.

Requires permission to access the ListThingGroupsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListThingGroupsForThingPages added in v1.34.3 

func (c *IoT) ListThingGroupsForThingPages(input *ListThingGroupsForThingInput, fn func(*ListThingGroupsForThingOutput, bool) bool) error

ListThingGroupsForThingPages iterates over the pages of a ListThingGroupsForThing operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingGroupsForThing method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingGroupsForThing operation.
pageNum := 0
err := client.ListThingGroupsForThingPages(params,
    func(page *iot.ListThingGroupsForThingOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingGroupsForThingPagesWithContext added in v1.34.3 

func (c *IoT) ListThingGroupsForThingPagesWithContext(ctx aws.Context, input *ListThingGroupsForThingInput, fn func(*ListThingGroupsForThingOutput, bool) bool, opts ...request.Option) error

ListThingGroupsForThingPagesWithContext same as ListThingGroupsForThingPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListThingGroupsPages added in v1.34.3 

func (c *IoT) ListThingGroupsPages(input *ListThingGroupsInput, fn func(*ListThingGroupsOutput, bool) bool) error

ListThingGroupsPages iterates over the pages of a ListThingGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingGroups operation.
pageNum := 0
err := client.ListThingGroupsPages(params,
    func(page *iot.ListThingGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingGroupsPagesWithContext added in v1.34.3 

func (c *IoT) ListThingGroupsPagesWithContext(ctx aws.Context, input *ListThingGroupsInput, fn func(*ListThingGroupsOutput, bool) bool, opts ...request.Option) error

ListThingGroupsPagesWithContext same as ListThingGroupsPages except it takes a Context and allows setting request options on the pages.

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 successfully.

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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) ListThingPrincipalsPages added in v1.35.21 

func (c *IoT) ListThingPrincipalsPages(input *ListThingPrincipalsInput, fn func(*ListThingPrincipalsOutput, bool) bool) error

ListThingPrincipalsPages iterates over the pages of a ListThingPrincipals operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingPrincipals method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingPrincipals operation.
pageNum := 0
err := client.ListThingPrincipalsPages(params,
    func(page *iot.ListThingPrincipalsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingPrincipalsPagesWithContext added in v1.35.21 

func (c *IoT) ListThingPrincipalsPagesWithContext(ctx aws.Context, input *ListThingPrincipalsInput, fn func(*ListThingPrincipalsOutput, bool) bool, opts ...request.Option) error

ListThingPrincipalsPagesWithContext same as ListThingPrincipalsPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListThingRegistrationTaskReportsPages added in v1.34.3 

func (c *IoT) ListThingRegistrationTaskReportsPages(input *ListThingRegistrationTaskReportsInput, fn func(*ListThingRegistrationTaskReportsOutput, bool) bool) error

ListThingRegistrationTaskReportsPages iterates over the pages of a ListThingRegistrationTaskReports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingRegistrationTaskReports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingRegistrationTaskReports operation.
pageNum := 0
err := client.ListThingRegistrationTaskReportsPages(params,
    func(page *iot.ListThingRegistrationTaskReportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingRegistrationTaskReportsPagesWithContext added in v1.34.3 

func (c *IoT) ListThingRegistrationTaskReportsPagesWithContext(ctx aws.Context, input *ListThingRegistrationTaskReportsInput, fn func(*ListThingRegistrationTaskReportsOutput, bool) bool, opts ...request.Option) error

ListThingRegistrationTaskReportsPagesWithContext same as ListThingRegistrationTaskReportsPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListThingRegistrationTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListThingRegistrationTasksPages added in v1.34.3 

func (c *IoT) ListThingRegistrationTasksPages(input *ListThingRegistrationTasksInput, fn func(*ListThingRegistrationTasksOutput, bool) bool) error

ListThingRegistrationTasksPages iterates over the pages of a ListThingRegistrationTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingRegistrationTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingRegistrationTasks operation.
pageNum := 0
err := client.ListThingRegistrationTasksPages(params,
    func(page *iot.ListThingRegistrationTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingRegistrationTasksPagesWithContext added in v1.34.3 

func (c *IoT) ListThingRegistrationTasksPagesWithContext(ctx aws.Context, input *ListThingRegistrationTasksInput, fn func(*ListThingRegistrationTasksOutput, bool) bool, opts ...request.Option) error

ListThingRegistrationTasksPagesWithContext same as ListThingRegistrationTasksPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListThingTypes (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListThingTypesPages added in v1.34.3 

func (c *IoT) ListThingTypesPages(input *ListThingTypesInput, fn func(*ListThingTypesOutput, bool) bool) error

ListThingTypesPages iterates over the pages of a ListThingTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingTypes operation.
pageNum := 0
err := client.ListThingTypesPages(params,
    func(page *iot.ListThingTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingTypesPagesWithContext added in v1.34.3 

func (c *IoT) ListThingTypesPagesWithContext(ctx aws.Context, input *ListThingTypesInput, fn func(*ListThingTypesOutput, bool) bool, opts ...request.Option) error

ListThingTypesPagesWithContext same as ListThingTypesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListThings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListThingsInBillingGroup added in v1.15.79 

func (c *IoT) ListThingsInBillingGroup(input *ListThingsInBillingGroupInput) (*ListThingsInBillingGroupOutput, error)

ListThingsInBillingGroup API operation for AWS IoT.

Lists the things you have added to the given billing group.

Requires permission to access the ListThingsInBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListThingsInBillingGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListThingsInBillingGroupPages added in v1.34.3 

func (c *IoT) ListThingsInBillingGroupPages(input *ListThingsInBillingGroupInput, fn func(*ListThingsInBillingGroupOutput, bool) bool) error

ListThingsInBillingGroupPages iterates over the pages of a ListThingsInBillingGroup operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingsInBillingGroup method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingsInBillingGroup operation.
pageNum := 0
err := client.ListThingsInBillingGroupPages(params,
    func(page *iot.ListThingsInBillingGroupOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingsInBillingGroupPagesWithContext added in v1.34.3 

func (c *IoT) ListThingsInBillingGroupPagesWithContext(ctx aws.Context, input *ListThingsInBillingGroupInput, fn func(*ListThingsInBillingGroupOutput, bool) bool, opts ...request.Option) error

ListThingsInBillingGroupPagesWithContext same as ListThingsInBillingGroupPages except it takes a Context and allows setting request options on the pages.

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) ListThingsInBillingGroupRequest added in v1.15.79 

func (c *IoT) ListThingsInBillingGroupRequest(input *ListThingsInBillingGroupInput) (req *request.Request, output *ListThingsInBillingGroupOutput)

ListThingsInBillingGroupRequest generates a "aws/request.Request" representing the client's request for the ListThingsInBillingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListThingsInBillingGroup for more information on using the ListThingsInBillingGroup 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 ListThingsInBillingGroupRequest method.
req, resp := client.ListThingsInBillingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListThingsInBillingGroupWithContext added in v1.15.79 

func (c *IoT) ListThingsInBillingGroupWithContext(ctx aws.Context, input *ListThingsInBillingGroupInput, opts ...request.Option) (*ListThingsInBillingGroupOutput, error)

ListThingsInBillingGroupWithContext is the same as ListThingsInBillingGroup with the addition of the ability to pass a context and additional request options.

See ListThingsInBillingGroup 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) 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.

Requires permission to access the ListThingsInThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) ListThingsInThingGroupPages added in v1.34.3 

func (c *IoT) ListThingsInThingGroupPages(input *ListThingsInThingGroupInput, fn func(*ListThingsInThingGroupOutput, bool) bool) error

ListThingsInThingGroupPages iterates over the pages of a ListThingsInThingGroup operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThingsInThingGroup method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThingsInThingGroup operation.
pageNum := 0
err := client.ListThingsInThingGroupPages(params,
    func(page *iot.ListThingsInThingGroupOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingsInThingGroupPagesWithContext added in v1.34.3 

func (c *IoT) ListThingsInThingGroupPagesWithContext(ctx aws.Context, input *ListThingsInThingGroupInput, fn func(*ListThingsInThingGroupOutput, bool) bool, opts ...request.Option) error

ListThingsInThingGroupPagesWithContext same as ListThingsInThingGroupPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListThingsPages added in v1.34.3 

func (c *IoT) ListThingsPages(input *ListThingsInput, fn func(*ListThingsOutput, bool) bool) error

ListThingsPages iterates over the pages of a ListThings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThings operation.
pageNum := 0
err := client.ListThingsPages(params,
    func(page *iot.ListThingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListThingsPagesWithContext added in v1.34.3 

func (c *IoT) ListThingsPagesWithContext(ctx aws.Context, input *ListThingsInput, fn func(*ListThingsOutput, bool) bool, opts ...request.Option) error

ListThingsPagesWithContext same as ListThingsPages except it takes a Context and allows setting request options on the pages.

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 successfully.

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) ListTopicRuleDestinations added in v1.25.38 

func (c *IoT) ListTopicRuleDestinations(input *ListTopicRuleDestinationsInput) (*ListTopicRuleDestinationsOutput, error)

ListTopicRuleDestinations API operation for AWS IoT.

Lists all the topic rule destinations in your Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListTopicRuleDestinations for usage and error information.

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

func (*IoT) ListTopicRuleDestinationsPages added in v1.34.3 

func (c *IoT) ListTopicRuleDestinationsPages(input *ListTopicRuleDestinationsInput, fn func(*ListTopicRuleDestinationsOutput, bool) bool) error

ListTopicRuleDestinationsPages iterates over the pages of a ListTopicRuleDestinations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTopicRuleDestinations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTopicRuleDestinations operation.
pageNum := 0
err := client.ListTopicRuleDestinationsPages(params,
    func(page *iot.ListTopicRuleDestinationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListTopicRuleDestinationsPagesWithContext added in v1.34.3 

func (c *IoT) ListTopicRuleDestinationsPagesWithContext(ctx aws.Context, input *ListTopicRuleDestinationsInput, fn func(*ListTopicRuleDestinationsOutput, bool) bool, opts ...request.Option) error

ListTopicRuleDestinationsPagesWithContext same as ListTopicRuleDestinationsPages except it takes a Context and allows setting request options on the pages.

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) ListTopicRuleDestinationsRequest added in v1.25.38 

func (c *IoT) ListTopicRuleDestinationsRequest(input *ListTopicRuleDestinationsInput) (req *request.Request, output *ListTopicRuleDestinationsOutput)

ListTopicRuleDestinationsRequest generates a "aws/request.Request" representing the client's request for the ListTopicRuleDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListTopicRuleDestinations for more information on using the ListTopicRuleDestinations 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 ListTopicRuleDestinationsRequest method.
req, resp := client.ListTopicRuleDestinationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListTopicRuleDestinationsWithContext added in v1.25.38 

func (c *IoT) ListTopicRuleDestinationsWithContext(ctx aws.Context, input *ListTopicRuleDestinationsInput, opts ...request.Option) (*ListTopicRuleDestinationsOutput, error)

ListTopicRuleDestinationsWithContext is the same as ListTopicRuleDestinations with the addition of the ability to pass a context and additional request options.

See ListTopicRuleDestinations 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.

Requires permission to access the ListTopicRules (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListTopicRulesPages added in v1.34.3 

func (c *IoT) ListTopicRulesPages(input *ListTopicRulesInput, fn func(*ListTopicRulesOutput, bool) bool) error

ListTopicRulesPages iterates over the pages of a ListTopicRules operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTopicRules method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTopicRules operation.
pageNum := 0
err := client.ListTopicRulesPages(params,
    func(page *iot.ListTopicRulesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListTopicRulesPagesWithContext added in v1.34.3 

func (c *IoT) ListTopicRulesPagesWithContext(ctx aws.Context, input *ListTopicRulesInput, fn func(*ListTopicRulesOutput, bool) bool, opts ...request.Option) error

ListTopicRulesPagesWithContext same as ListTopicRulesPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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.

Requires permission to access the ListV2LoggingLevels (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • NotConfiguredException The resource is not configured.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) ListV2LoggingLevelsPages added in v1.34.3 

func (c *IoT) ListV2LoggingLevelsPages(input *ListV2LoggingLevelsInput, fn func(*ListV2LoggingLevelsOutput, bool) bool) error

ListV2LoggingLevelsPages iterates over the pages of a ListV2LoggingLevels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListV2LoggingLevels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListV2LoggingLevels operation.
pageNum := 0
err := client.ListV2LoggingLevelsPages(params,
    func(page *iot.ListV2LoggingLevelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListV2LoggingLevelsPagesWithContext added in v1.34.3 

func (c *IoT) ListV2LoggingLevelsPagesWithContext(ctx aws.Context, input *ListV2LoggingLevelsInput, fn func(*ListV2LoggingLevelsOutput, bool) bool, opts ...request.Option) error

ListV2LoggingLevelsPagesWithContext same as ListV2LoggingLevelsPages except it takes a Context and allows setting request options on the pages.

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) 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 successfully.

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) ListViolationEvents added in v1.15.2 

func (c *IoT) ListViolationEvents(input *ListViolationEventsInput) (*ListViolationEventsOutput, error)

ListViolationEvents API operation for AWS IoT.

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

Requires permission to access the ListViolationEvents (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ListViolationEvents for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ListViolationEventsPages added in v1.34.3 

func (c *IoT) ListViolationEventsPages(input *ListViolationEventsInput, fn func(*ListViolationEventsOutput, bool) bool) error

ListViolationEventsPages iterates over the pages of a ListViolationEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListViolationEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListViolationEvents operation.
pageNum := 0
err := client.ListViolationEventsPages(params,
    func(page *iot.ListViolationEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoT) ListViolationEventsPagesWithContext added in v1.34.3 

func (c *IoT) ListViolationEventsPagesWithContext(ctx aws.Context, input *ListViolationEventsInput, fn func(*ListViolationEventsOutput, bool) bool, opts ...request.Option) error

ListViolationEventsPagesWithContext same as ListViolationEventsPages except it takes a Context and allows setting request options on the pages.

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) ListViolationEventsRequest added in v1.15.2 

func (c *IoT) ListViolationEventsRequest(input *ListViolationEventsInput) (req *request.Request, output *ListViolationEventsOutput)

ListViolationEventsRequest generates a "aws/request.Request" representing the client's request for the ListViolationEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ListViolationEvents for more information on using the ListViolationEvents 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 ListViolationEventsRequest method.
req, resp := client.ListViolationEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ListViolationEventsWithContext added in v1.15.2 

func (c *IoT) ListViolationEventsWithContext(ctx aws.Context, input *ListViolationEventsInput, opts ...request.Option) (*ListViolationEventsOutput, error)

ListViolationEventsWithContext is the same as ListViolationEvents with the addition of the ability to pass a context and additional request options.

See ListViolationEvents 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) PutVerificationStateOnViolation added in v1.40.46 

func (c *IoT) PutVerificationStateOnViolation(input *PutVerificationStateOnViolationInput) (*PutVerificationStateOnViolationOutput, error)

PutVerificationStateOnViolation API operation for AWS IoT.

Set a verification state and provide a description of that verification state on a violation (detect alarm).

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 PutVerificationStateOnViolation for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) PutVerificationStateOnViolationRequest added in v1.40.46 

func (c *IoT) PutVerificationStateOnViolationRequest(input *PutVerificationStateOnViolationInput) (req *request.Request, output *PutVerificationStateOnViolationOutput)

PutVerificationStateOnViolationRequest generates a "aws/request.Request" representing the client's request for the PutVerificationStateOnViolation operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 PutVerificationStateOnViolation for more information on using the PutVerificationStateOnViolation 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 PutVerificationStateOnViolationRequest method.
req, resp := client.PutVerificationStateOnViolationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) PutVerificationStateOnViolationWithContext added in v1.40.46 

func (c *IoT) PutVerificationStateOnViolationWithContext(ctx aws.Context, input *PutVerificationStateOnViolationInput, opts ...request.Option) (*PutVerificationStateOnViolationOutput, error)

PutVerificationStateOnViolationWithContext is the same as PutVerificationStateOnViolation with the addition of the ability to pass a context and additional request options.

See PutVerificationStateOnViolation 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 Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceAlreadyExistsException The resource already exists.

  • RegistrationCodeValidationException The registration code is invalid.

  • InvalidRequestException The request is not valid.

  • CertificateValidationException The certificate is invalid.

  • ThrottlingException The rate exceeds the limit.

  • LimitExceededException A limit has been exceeded.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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 IoT in the same certificate mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) as the signing CA. 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.

Requires permission to access the RegisterCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceAlreadyExistsException The resource already exists.

  • InvalidRequestException The request is not valid.

  • CertificateValidationException The certificate is invalid.

  • CertificateStateException The certificate operation is not allowed.

  • 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.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) RegisterCertificateWithoutCA added in v1.30.18 

func (c *IoT) RegisterCertificateWithoutCA(input *RegisterCertificateWithoutCAInput) (*RegisterCertificateWithoutCAOutput, error)

RegisterCertificateWithoutCA API operation for AWS IoT.

Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms).

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 RegisterCertificateWithoutCA for usage and error information.

Returned Error Types:

  • ResourceAlreadyExistsException The resource already exists.

  • InvalidRequestException The request is not valid.

  • CertificateStateException The certificate operation is not allowed.

  • CertificateValidationException The certificate is invalid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) RegisterCertificateWithoutCARequest added in v1.30.18 

func (c *IoT) RegisterCertificateWithoutCARequest(input *RegisterCertificateWithoutCAInput) (req *request.Request, output *RegisterCertificateWithoutCAOutput)

RegisterCertificateWithoutCARequest generates a "aws/request.Request" representing the client's request for the RegisterCertificateWithoutCA operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 RegisterCertificateWithoutCA for more information on using the RegisterCertificateWithoutCA 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 RegisterCertificateWithoutCARequest method.
req, resp := client.RegisterCertificateWithoutCARequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) RegisterCertificateWithoutCAWithContext added in v1.30.18 

func (c *IoT) RegisterCertificateWithoutCAWithContext(ctx aws.Context, input *RegisterCertificateWithoutCAInput, opts ...request.Option) (*RegisterCertificateWithoutCAOutput, error)

RegisterCertificateWithoutCAWithContext is the same as RegisterCertificateWithoutCA with the addition of the ability to pass a context and additional request options.

See RegisterCertificateWithoutCA 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 in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot) and cause throttle errors. Please contact Amazon Web Services Customer Support (https://console.aws.amazon.com/support/home) to raise your throttling limits if necessary.

Requires permission to access the RegisterThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalFailureException An unexpected error has occurred.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InvalidRequestException The request is not valid.

  • UnauthorizedException You are not authorized to perform this operation.

  • ThrottlingException The rate exceeds the limit.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

  • 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 successfully.

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 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.

Requires permission to access the RejectCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • TransferAlreadyCompletedException You can't revert the certificate transfer because the transfer is already complete.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) RemoveThingFromBillingGroup added in v1.15.79 

func (c *IoT) RemoveThingFromBillingGroup(input *RemoveThingFromBillingGroupInput) (*RemoveThingFromBillingGroupOutput, error)

RemoveThingFromBillingGroup API operation for AWS IoT.

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

This call is asynchronous. It might take several seconds for the detachment to propagate.

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 RemoveThingFromBillingGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) RemoveThingFromBillingGroupRequest added in v1.15.79 

func (c *IoT) RemoveThingFromBillingGroupRequest(input *RemoveThingFromBillingGroupInput) (req *request.Request, output *RemoveThingFromBillingGroupOutput)

RemoveThingFromBillingGroupRequest generates a "aws/request.Request" representing the client's request for the RemoveThingFromBillingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 RemoveThingFromBillingGroup for more information on using the RemoveThingFromBillingGroup 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 RemoveThingFromBillingGroupRequest method.
req, resp := client.RemoveThingFromBillingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) RemoveThingFromBillingGroupWithContext added in v1.15.79 

func (c *IoT) RemoveThingFromBillingGroupWithContext(ctx aws.Context, input *RemoveThingFromBillingGroupInput, opts ...request.Option) (*RemoveThingFromBillingGroupOutput, error)

RemoveThingFromBillingGroupWithContext is the same as RemoveThingFromBillingGroup with the addition of the ability to pass a context and additional request options.

See RemoveThingFromBillingGroup 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.

You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

Requires permission to access the RemoveThingFromThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the ReplaceTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • SqlParseException The Rule-SQL expression can't be parsed correctly.

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

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 successfully.

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.

Requires permission to access the SearchIndex (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • 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 successfully.

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.

Requires permission to access the SetDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

Requires permission to access the SetLoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • 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 successfully.

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.

Requires permission to access the SetV2LoggingLevel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • NotConfiguredException The resource is not configured.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • LimitExceededException A limit has been exceeded.

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 successfully.

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.

Requires permission to access the SetV2LoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • 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 successfully.

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) StartAuditMitigationActionsTask added in v1.21.10 

func (c *IoT) StartAuditMitigationActionsTask(input *StartAuditMitigationActionsTaskInput) (*StartAuditMitigationActionsTaskOutput, error)

StartAuditMitigationActionsTask API operation for AWS IoT.

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 StartAuditMitigationActionsTask for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • TaskAlreadyExistsException This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) StartAuditMitigationActionsTaskRequest added in v1.21.10 

func (c *IoT) StartAuditMitigationActionsTaskRequest(input *StartAuditMitigationActionsTaskInput) (req *request.Request, output *StartAuditMitigationActionsTaskOutput)

StartAuditMitigationActionsTaskRequest generates a "aws/request.Request" representing the client's request for the StartAuditMitigationActionsTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 StartAuditMitigationActionsTask for more information on using the StartAuditMitigationActionsTask 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 StartAuditMitigationActionsTaskRequest method.
req, resp := client.StartAuditMitigationActionsTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) StartAuditMitigationActionsTaskWithContext added in v1.21.10 

func (c *IoT) StartAuditMitigationActionsTaskWithContext(ctx aws.Context, input *StartAuditMitigationActionsTaskInput, opts ...request.Option) (*StartAuditMitigationActionsTaskOutput, error)

StartAuditMitigationActionsTaskWithContext is the same as StartAuditMitigationActionsTask with the addition of the ability to pass a context and additional request options.

See StartAuditMitigationActionsTask 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) StartDetectMitigationActionsTask added in v1.36.9 

func (c *IoT) StartDetectMitigationActionsTask(input *StartDetectMitigationActionsTaskInput) (*StartDetectMitigationActionsTaskOutput, error)

StartDetectMitigationActionsTask API operation for AWS IoT.

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 StartDetectMitigationActionsTask for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • TaskAlreadyExistsException This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) StartDetectMitigationActionsTaskRequest added in v1.36.9 

func (c *IoT) StartDetectMitigationActionsTaskRequest(input *StartDetectMitigationActionsTaskInput) (req *request.Request, output *StartDetectMitigationActionsTaskOutput)

StartDetectMitigationActionsTaskRequest generates a "aws/request.Request" representing the client's request for the StartDetectMitigationActionsTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 StartDetectMitigationActionsTask for more information on using the StartDetectMitigationActionsTask 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 StartDetectMitigationActionsTaskRequest method.
req, resp := client.StartDetectMitigationActionsTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) StartDetectMitigationActionsTaskWithContext added in v1.36.9 

func (c *IoT) StartDetectMitigationActionsTaskWithContext(ctx aws.Context, input *StartDetectMitigationActionsTaskInput, opts ...request.Option) (*StartDetectMitigationActionsTaskOutput, error)

StartDetectMitigationActionsTaskWithContext is the same as StartDetectMitigationActionsTask with the addition of the ability to pass a context and additional request options.

See StartDetectMitigationActionsTask 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) StartOnDemandAuditTask added in v1.15.2 

func (c *IoT) StartOnDemandAuditTask(input *StartOnDemandAuditTaskInput) (*StartOnDemandAuditTaskOutput, error)

StartOnDemandAuditTask API operation for AWS IoT.

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 StartOnDemandAuditTask for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • LimitExceededException A limit has been exceeded.

func (*IoT) StartOnDemandAuditTaskRequest added in v1.15.2 

func (c *IoT) StartOnDemandAuditTaskRequest(input *StartOnDemandAuditTaskInput) (req *request.Request, output *StartOnDemandAuditTaskOutput)

StartOnDemandAuditTaskRequest generates a "aws/request.Request" representing the client's request for the StartOnDemandAuditTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 StartOnDemandAuditTask for more information on using the StartOnDemandAuditTask 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 StartOnDemandAuditTaskRequest method.
req, resp := client.StartOnDemandAuditTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) StartOnDemandAuditTaskWithContext added in v1.15.2 

func (c *IoT) StartOnDemandAuditTaskWithContext(ctx aws.Context, input *StartOnDemandAuditTaskInput, opts ...request.Option) (*StartOnDemandAuditTaskOutput, error)

StartOnDemandAuditTaskWithContext is the same as StartOnDemandAuditTask with the addition of the ability to pass a context and additional request options.

See StartOnDemandAuditTask 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.

Requires permission to access the StartThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • 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 successfully.

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.

Requires permission to access the StopThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) TagResource added in v1.15.79 

func (c *IoT) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT.

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

Requires permission to access the TagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 TagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • LimitExceededException A limit has been exceeded.

func (*IoT) TagResourceRequest added in v1.15.79 

func (c *IoT) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) TagResourceWithContext added in v1.15.79 

func (c *IoT) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource 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 IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestAuthorization (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 IoT device gateway.

Requires permission to access the TestInvokeAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 Amazon Web Services account.

Requires permission to access the TransferCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 action to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPolicy action 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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • CertificateStateException The certificate operation is not allowed.

  • TransferConflictException You can't transfer the certificate because authorization policies are still attached.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) UntagResource added in v1.15.79 

func (c *IoT) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT.

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UntagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) UntagResourceRequest added in v1.15.79 

func (c *IoT) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UntagResourceWithContext added in v1.15.79 

func (c *IoT) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource 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) UpdateAccountAuditConfiguration added in v1.15.2 

func (c *IoT) UpdateAccountAuditConfiguration(input *UpdateAccountAuditConfigurationInput) (*UpdateAccountAuditConfigurationOutput, error)

UpdateAccountAuditConfiguration API operation for AWS IoT.

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the UpdateAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateAccountAuditConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateAccountAuditConfigurationRequest added in v1.15.2 

func (c *IoT) UpdateAccountAuditConfigurationRequest(input *UpdateAccountAuditConfigurationInput) (req *request.Request, output *UpdateAccountAuditConfigurationOutput)

UpdateAccountAuditConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateAccountAuditConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateAccountAuditConfiguration for more information on using the UpdateAccountAuditConfiguration 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 UpdateAccountAuditConfigurationRequest method.
req, resp := client.UpdateAccountAuditConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateAccountAuditConfigurationWithContext added in v1.15.2 

func (c *IoT) UpdateAccountAuditConfigurationWithContext(ctx aws.Context, input *UpdateAccountAuditConfigurationInput, opts ...request.Option) (*UpdateAccountAuditConfigurationOutput, error)

UpdateAccountAuditConfigurationWithContext is the same as UpdateAccountAuditConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateAccountAuditConfiguration 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) UpdateAuditSuppression added in v1.34.3 

func (c *IoT) UpdateAuditSuppression(input *UpdateAuditSuppressionInput) (*UpdateAuditSuppressionOutput, error)

UpdateAuditSuppression API operation for AWS IoT.

Updates a Device Defender audit suppression.

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 UpdateAuditSuppression for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateAuditSuppressionRequest added in v1.34.3 

func (c *IoT) UpdateAuditSuppressionRequest(input *UpdateAuditSuppressionInput) (req *request.Request, output *UpdateAuditSuppressionOutput)

UpdateAuditSuppressionRequest generates a "aws/request.Request" representing the client's request for the UpdateAuditSuppression operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateAuditSuppression for more information on using the UpdateAuditSuppression 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 UpdateAuditSuppressionRequest method.
req, resp := client.UpdateAuditSuppressionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateAuditSuppressionWithContext added in v1.34.3 

func (c *IoT) UpdateAuditSuppressionWithContext(ctx aws.Context, input *UpdateAuditSuppressionInput, opts ...request.Option) (*UpdateAuditSuppressionOutput, error)

UpdateAuditSuppressionWithContext is the same as UpdateAuditSuppression with the addition of the ability to pass a context and additional request options.

See UpdateAuditSuppression 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.

Requires permission to access the UpdateAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • LimitExceededException A limit has been exceeded.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) UpdateBillingGroup added in v1.15.79 

func (c *IoT) UpdateBillingGroup(input *UpdateBillingGroupInput) (*UpdateBillingGroupOutput, error)

UpdateBillingGroup API operation for AWS IoT.

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateBillingGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

func (*IoT) UpdateBillingGroupRequest added in v1.15.79 

func (c *IoT) UpdateBillingGroupRequest(input *UpdateBillingGroupInput) (req *request.Request, output *UpdateBillingGroupOutput)

UpdateBillingGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateBillingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateBillingGroup for more information on using the UpdateBillingGroup 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 UpdateBillingGroupRequest method.
req, resp := client.UpdateBillingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateBillingGroupWithContext added in v1.15.79 

func (c *IoT) UpdateBillingGroupWithContext(ctx aws.Context, input *UpdateBillingGroupInput, opts ...request.Option) (*UpdateBillingGroupOutput, error)

UpdateBillingGroupWithContext is the same as UpdateBillingGroup with the addition of the ability to pass a context and additional request options.

See UpdateBillingGroup 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.

Requires permission to access the UpdateCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the UpdateCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • CertificateStateException The certificate operation is not allowed.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) UpdateCustomMetric added in v1.36.9 

func (c *IoT) UpdateCustomMetric(input *UpdateCustomMetricInput) (*UpdateCustomMetricOutput, error)

UpdateCustomMetric API operation for AWS IoT.

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateCustomMetric for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateCustomMetricRequest added in v1.36.9 

func (c *IoT) UpdateCustomMetricRequest(input *UpdateCustomMetricInput) (req *request.Request, output *UpdateCustomMetricOutput)

UpdateCustomMetricRequest generates a "aws/request.Request" representing the client's request for the UpdateCustomMetric operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateCustomMetric for more information on using the UpdateCustomMetric 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 UpdateCustomMetricRequest method.
req, resp := client.UpdateCustomMetricRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateCustomMetricWithContext added in v1.36.9 

func (c *IoT) UpdateCustomMetricWithContext(ctx aws.Context, input *UpdateCustomMetricInput, opts ...request.Option) (*UpdateCustomMetricOutput, error)

UpdateCustomMetricWithContext is the same as UpdateCustomMetric with the addition of the ability to pass a context and additional request options.

See UpdateCustomMetric 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) UpdateDimension added in v1.30.2 

func (c *IoT) UpdateDimension(input *UpdateDimensionInput) (*UpdateDimensionOutput, error)

UpdateDimension API operation for AWS IoT.

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateDimension for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

func (*IoT) UpdateDimensionRequest added in v1.30.2 

func (c *IoT) UpdateDimensionRequest(input *UpdateDimensionInput) (req *request.Request, output *UpdateDimensionOutput)

UpdateDimensionRequest generates a "aws/request.Request" representing the client's request for the UpdateDimension operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateDimension for more information on using the UpdateDimension 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 UpdateDimensionRequest method.
req, resp := client.UpdateDimensionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateDimensionWithContext added in v1.30.2 

func (c *IoT) UpdateDimensionWithContext(ctx aws.Context, input *UpdateDimensionInput, opts ...request.Option) (*UpdateDimensionOutput, error)

UpdateDimensionWithContext is the same as UpdateDimension with the addition of the ability to pass a context and additional request options.

See UpdateDimension 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) UpdateDomainConfiguration added in v1.25.42 

func (c *IoT) UpdateDomainConfiguration(input *UpdateDomainConfigurationInput) (*UpdateDomainConfigurationOutput, error)

UpdateDomainConfiguration API operation for AWS IoT.

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateDomainConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • CertificateValidationException The certificate is invalid.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateDomainConfigurationRequest added in v1.25.42 

func (c *IoT) UpdateDomainConfigurationRequest(input *UpdateDomainConfigurationInput) (req *request.Request, output *UpdateDomainConfigurationOutput)

UpdateDomainConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateDomainConfiguration for more information on using the UpdateDomainConfiguration 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 UpdateDomainConfigurationRequest method.
req, resp := client.UpdateDomainConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateDomainConfigurationWithContext added in v1.25.42 

func (c *IoT) UpdateDomainConfigurationWithContext(ctx aws.Context, input *UpdateDomainConfigurationInput, opts ...request.Option) (*UpdateDomainConfigurationOutput, error)

UpdateDomainConfigurationWithContext is the same as UpdateDomainConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateDomainConfiguration 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) UpdateDynamicThingGroup added in v1.15.79 

func (c *IoT) UpdateDynamicThingGroup(input *UpdateDynamicThingGroupInput) (*UpdateDynamicThingGroupOutput, error)

UpdateDynamicThingGroup API operation for AWS IoT.

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateDynamicThingGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

func (*IoT) UpdateDynamicThingGroupRequest added in v1.15.79 

func (c *IoT) UpdateDynamicThingGroupRequest(input *UpdateDynamicThingGroupInput) (req *request.Request, output *UpdateDynamicThingGroupOutput)

UpdateDynamicThingGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateDynamicThingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateDynamicThingGroup for more information on using the UpdateDynamicThingGroup 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 UpdateDynamicThingGroupRequest method.
req, resp := client.UpdateDynamicThingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateDynamicThingGroupWithContext added in v1.15.79 

func (c *IoT) UpdateDynamicThingGroupWithContext(ctx aws.Context, input *UpdateDynamicThingGroupInput, opts ...request.Option) (*UpdateDynamicThingGroupOutput, error)

UpdateDynamicThingGroupWithContext is the same as UpdateDynamicThingGroup with the addition of the ability to pass a context and additional request options.

See UpdateDynamicThingGroup 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.

Requires permission to access the UpdateEventConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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) UpdateFleetMetric added in v1.40.34 

func (c *IoT) UpdateFleetMetric(input *UpdateFleetMetricInput) (*UpdateFleetMetricOutput, error)

UpdateFleetMetric API operation for AWS IoT.

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateFleetMetric for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidQueryException The query is invalid.

  • InvalidAggregationException The aggregation is invalid.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • IndexNotReadyException The index is not ready.

func (*IoT) UpdateFleetMetricRequest added in v1.40.34 

func (c *IoT) UpdateFleetMetricRequest(input *UpdateFleetMetricInput) (req *request.Request, output *UpdateFleetMetricOutput)

UpdateFleetMetricRequest generates a "aws/request.Request" representing the client's request for the UpdateFleetMetric operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateFleetMetric for more information on using the UpdateFleetMetric 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 UpdateFleetMetricRequest method.
req, resp := client.UpdateFleetMetricRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateFleetMetricWithContext added in v1.40.34 

func (c *IoT) UpdateFleetMetricWithContext(ctx aws.Context, input *UpdateFleetMetricInput, opts ...request.Option) (*UpdateFleetMetricOutput, error)

UpdateFleetMetricWithContext is the same as UpdateFleetMetric with the addition of the ability to pass a context and additional request options.

See UpdateFleetMetric 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.

Requires permission to access the UpdateIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) UpdateJob added in v1.15.79 

func (c *IoT) UpdateJob(input *UpdateJobInput) (*UpdateJobOutput, error)

UpdateJob API operation for AWS IoT.

Updates supported fields of the specified job.

Requires permission to access the UpdateJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

func (*IoT) UpdateJobRequest added in v1.15.79 

func (c *IoT) UpdateJobRequest(input *UpdateJobInput) (req *request.Request, output *UpdateJobOutput)

UpdateJobRequest generates a "aws/request.Request" representing the client's request for the UpdateJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateJob for more information on using the UpdateJob 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 UpdateJobRequest method.
req, resp := client.UpdateJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateJobWithContext added in v1.15.79 

func (c *IoT) UpdateJobWithContext(ctx aws.Context, input *UpdateJobInput, opts ...request.Option) (*UpdateJobOutput, error)

UpdateJobWithContext is the same as UpdateJob with the addition of the ability to pass a context and additional request options.

See UpdateJob 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) UpdateMitigationAction added in v1.21.10 

func (c *IoT) UpdateMitigationAction(input *UpdateMitigationActionInput) (*UpdateMitigationActionOutput, error)

UpdateMitigationAction API operation for AWS IoT.

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateMitigationAction for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateMitigationActionRequest added in v1.21.10 

func (c *IoT) UpdateMitigationActionRequest(input *UpdateMitigationActionInput) (req *request.Request, output *UpdateMitigationActionOutput)

UpdateMitigationActionRequest generates a "aws/request.Request" representing the client's request for the UpdateMitigationAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateMitigationAction for more information on using the UpdateMitigationAction 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 UpdateMitigationActionRequest method.
req, resp := client.UpdateMitigationActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateMitigationActionWithContext added in v1.21.10 

func (c *IoT) UpdateMitigationActionWithContext(ctx aws.Context, input *UpdateMitigationActionInput, opts ...request.Option) (*UpdateMitigationActionOutput, error)

UpdateMitigationActionWithContext is the same as UpdateMitigationAction with the addition of the ability to pass a context and additional request options.

See UpdateMitigationAction 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) UpdateProvisioningTemplate added in v1.25.42 

func (c *IoT) UpdateProvisioningTemplate(input *UpdateProvisioningTemplateInput) (*UpdateProvisioningTemplateOutput, error)

UpdateProvisioningTemplate API operation for AWS IoT.

Updates a fleet provisioning template.

Requires permission to access the UpdateProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateProvisioningTemplate for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) UpdateProvisioningTemplateRequest added in v1.25.42 

func (c *IoT) UpdateProvisioningTemplateRequest(input *UpdateProvisioningTemplateInput) (req *request.Request, output *UpdateProvisioningTemplateOutput)

UpdateProvisioningTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateProvisioningTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateProvisioningTemplate for more information on using the UpdateProvisioningTemplate 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 UpdateProvisioningTemplateRequest method.
req, resp := client.UpdateProvisioningTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateProvisioningTemplateWithContext added in v1.25.42 

func (c *IoT) UpdateProvisioningTemplateWithContext(ctx aws.Context, input *UpdateProvisioningTemplateInput, opts ...request.Option) (*UpdateProvisioningTemplateOutput, error)

UpdateProvisioningTemplateWithContext is the same as UpdateProvisioningTemplate with the addition of the ability to pass a context and additional request options.

See UpdateProvisioningTemplate 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.

Requires permission to access the UpdateRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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) UpdateScheduledAudit added in v1.15.2 

func (c *IoT) UpdateScheduledAudit(input *UpdateScheduledAuditInput) (*UpdateScheduledAuditOutput, error)

UpdateScheduledAudit API operation for AWS IoT.

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateScheduledAudit for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateScheduledAuditRequest added in v1.15.2 

func (c *IoT) UpdateScheduledAuditRequest(input *UpdateScheduledAuditInput) (req *request.Request, output *UpdateScheduledAuditOutput)

UpdateScheduledAuditRequest generates a "aws/request.Request" representing the client's request for the UpdateScheduledAudit operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateScheduledAudit for more information on using the UpdateScheduledAudit 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 UpdateScheduledAuditRequest method.
req, resp := client.UpdateScheduledAuditRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateScheduledAuditWithContext added in v1.15.2 

func (c *IoT) UpdateScheduledAuditWithContext(ctx aws.Context, input *UpdateScheduledAuditInput, opts ...request.Option) (*UpdateScheduledAuditOutput, error)

UpdateScheduledAuditWithContext is the same as UpdateScheduledAudit with the addition of the ability to pass a context and additional request options.

See UpdateScheduledAudit 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) UpdateSecurityProfile added in v1.15.2 

func (c *IoT) UpdateSecurityProfile(input *UpdateSecurityProfileInput) (*UpdateSecurityProfileOutput, error)

UpdateSecurityProfile API operation for AWS IoT.

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateSecurityProfile for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) UpdateSecurityProfileRequest added in v1.15.2 

func (c *IoT) UpdateSecurityProfileRequest(input *UpdateSecurityProfileInput) (req *request.Request, output *UpdateSecurityProfileOutput)

UpdateSecurityProfileRequest generates a "aws/request.Request" representing the client's request for the UpdateSecurityProfile operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateSecurityProfile for more information on using the UpdateSecurityProfile 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 UpdateSecurityProfileRequest method.
req, resp := client.UpdateSecurityProfileRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateSecurityProfileWithContext added in v1.15.2 

func (c *IoT) UpdateSecurityProfileWithContext(ctx aws.Context, input *UpdateSecurityProfileInput, opts ...request.Option) (*UpdateSecurityProfileOutput, error)

UpdateSecurityProfileWithContext is the same as UpdateSecurityProfile with the addition of the ability to pass a context and additional request options.

See UpdateSecurityProfile 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.

Requires permission to access the UpdateStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • 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 successfully.

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.

Requires permission to access the UpdateThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • 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.

Requires permission to access the UpdateThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • VersionConflictException An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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.

Requires permission to access the UpdateThingGroupsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

  • 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 successfully.

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 successfully.

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.

func (*IoT) UpdateTopicRuleDestination added in v1.25.38 

func (c *IoT) UpdateTopicRuleDestination(input *UpdateTopicRuleDestinationInput) (*UpdateTopicRuleDestinationOutput, error)

UpdateTopicRuleDestination API operation for AWS IoT.

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

Requires permission to access the UpdateTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 UpdateTopicRuleDestination for usage and error information.

Returned Error Types:

  • InternalException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ServiceUnavailableException The service is temporarily unavailable.

  • UnauthorizedException You are not authorized to perform this operation.

  • ConflictingResourceUpdateException A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

func (*IoT) UpdateTopicRuleDestinationRequest added in v1.25.38 

func (c *IoT) UpdateTopicRuleDestinationRequest(input *UpdateTopicRuleDestinationInput) (req *request.Request, output *UpdateTopicRuleDestinationOutput)

UpdateTopicRuleDestinationRequest generates a "aws/request.Request" representing the client's request for the UpdateTopicRuleDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 UpdateTopicRuleDestination for more information on using the UpdateTopicRuleDestination 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 UpdateTopicRuleDestinationRequest method.
req, resp := client.UpdateTopicRuleDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) UpdateTopicRuleDestinationWithContext added in v1.25.38 

func (c *IoT) UpdateTopicRuleDestinationWithContext(ctx aws.Context, input *UpdateTopicRuleDestinationInput, opts ...request.Option) (*UpdateTopicRuleDestinationOutput, error)

UpdateTopicRuleDestinationWithContext is the same as UpdateTopicRuleDestination with the addition of the ability to pass a context and additional request options.

See UpdateTopicRuleDestination 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) ValidateSecurityProfileBehaviors added in v1.15.2 

func (c *IoT) ValidateSecurityProfileBehaviors(input *ValidateSecurityProfileBehaviorsInput) (*ValidateSecurityProfileBehaviorsOutput, error)

ValidateSecurityProfileBehaviors API operation for AWS IoT.

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

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 ValidateSecurityProfileBehaviors for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • InternalFailureException An unexpected error has occurred.

func (*IoT) ValidateSecurityProfileBehaviorsRequest added in v1.15.2 

func (c *IoT) ValidateSecurityProfileBehaviorsRequest(input *ValidateSecurityProfileBehaviorsInput) (req *request.Request, output *ValidateSecurityProfileBehaviorsOutput)

ValidateSecurityProfileBehaviorsRequest generates a "aws/request.Request" representing the client's request for the ValidateSecurityProfileBehaviors operation. The "output" return value will be populated with the request's response once the request completes successfully.

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 ValidateSecurityProfileBehaviors for more information on using the ValidateSecurityProfileBehaviors 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 ValidateSecurityProfileBehaviorsRequest method.
req, resp := client.ValidateSecurityProfileBehaviorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoT) ValidateSecurityProfileBehaviorsWithContext added in v1.15.2 

func (c *IoT) ValidateSecurityProfileBehaviorsWithContext(ctx aws.Context, input *ValidateSecurityProfileBehaviorsInput, opts ...request.Option) (*ValidateSecurityProfileBehaviorsOutput, error)

ValidateSecurityProfileBehaviorsWithContext is the same as ValidateSecurityProfileBehaviors with the addition of the ability to pass a context and additional request options.

See ValidateSecurityProfileBehaviors 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 {

	// Whether to process the action as a batch. The default value is false.
	//
	// When batchMode is true and the rule SQL statement evaluates to an Array,
	// each Array element is delivered as a separate message when passed by BatchPutMessage
	// (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html)
	// to the IoT Analytics channel. The resulting array can't have more than 100
	// messages.
	BatchMode *bool `locationName:"batchMode" type:"boolean"`

	// (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 message data to an IoT Analytics channel.

func (IotAnalyticsAction) GoString added in v1.13.35 

func (s IotAnalyticsAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotAnalyticsAction) SetBatchMode added in v1.35.27 

func (s *IotAnalyticsAction) SetBatchMode(v bool) *IotAnalyticsAction

SetBatchMode sets the BatchMode field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IotEventsAction added in v1.15.83 

type IotEventsAction struct {

	// Whether to process the event actions as a batch. The default value is false.
	//
	// When batchMode is true, you can't specify a messageId.
	//
	// When batchMode is true and the rule SQL statement evaluates to an Array,
	// each Array element is treated as a separate message when it's sent to IoT
	// Events by calling BatchPutMessage (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html).
	// The resulting array can't have more than 10 messages.
	BatchMode *bool `locationName:"batchMode" type:"boolean"`

	// The name of the IoT Events input.
	//
	// InputName is a required field
	InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`

	// The ID of the message. The default messageId is a new UUID value.
	//
	// When batchMode is true, you can't specify a messageId--a new UUID value will
	// be assigned.
	//
	// Assign a value to this property to ensure that only one input (message) with
	// a given messageId will be processed by an IoT Events detector.
	MessageId *string `locationName:"messageId" type:"string"`

	// The ARN of the role that grants IoT permission to send an input to an IoT
	// Events detector. ("Action":"iotevents:BatchPutMessage").
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Sends an input to an IoT Events detector.

func (IotEventsAction) GoString added in v1.15.83 

func (s IotEventsAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotEventsAction) SetBatchMode added in v1.35.27 

func (s *IotEventsAction) SetBatchMode(v bool) *IotEventsAction

SetBatchMode sets the BatchMode field's value.

func (*IotEventsAction) SetInputName added in v1.15.83 

func (s *IotEventsAction) SetInputName(v string) *IotEventsAction

SetInputName sets the InputName field's value.

func (*IotEventsAction) SetMessageId added in v1.15.83 

func (s *IotEventsAction) SetMessageId(v string) *IotEventsAction

SetMessageId sets the MessageId field's value.

func (*IotEventsAction) SetRoleArn added in v1.15.83 

func (s *IotEventsAction) SetRoleArn(v string) *IotEventsAction

SetRoleArn sets the RoleArn field's value.

func (IotEventsAction) String added in v1.15.83 

func (s IotEventsAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotEventsAction) Validate added in v1.15.83 

func (s *IotEventsAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IotSiteWiseAction added in v1.25.42 

type IotSiteWiseAction struct {

	// A list of asset property value entries.
	//
	// PutAssetPropertyValueEntries is a required field
	PutAssetPropertyValueEntries []*PutAssetPropertyValueEntry `locationName:"putAssetPropertyValueEntries" min:"1" type:"list" required:"true"`

	// The ARN of the role that grants IoT permission to send an asset property
	// value to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue").
	// The trust policy can restrict access to specific asset hierarchy paths.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.

func (IotSiteWiseAction) GoString added in v1.25.42 

func (s IotSiteWiseAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAction) SetPutAssetPropertyValueEntries added in v1.25.42 

func (s *IotSiteWiseAction) SetPutAssetPropertyValueEntries(v []*PutAssetPropertyValueEntry) *IotSiteWiseAction

SetPutAssetPropertyValueEntries sets the PutAssetPropertyValueEntries field's value.

func (*IotSiteWiseAction) SetRoleArn added in v1.25.42 

func (s *IotSiteWiseAction) SetRoleArn(v string) *IotSiteWiseAction

SetRoleArn sets the RoleArn field's value.

func (IotSiteWiseAction) String added in v1.25.42 

func (s IotSiteWiseAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAction) Validate added in v1.25.42 

func (s *IotSiteWiseAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Job added in v1.12.36 

type Job struct {

	// Configuration for criteria to abort the job.
	AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"`

	// If the job was updated, describes the reason for the update.
	Comment *string `locationName:"comment" type:"string"`

	// The time, in seconds since the epoch, when the job was completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp"`

	// The time, in seconds since the epoch, when the job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// A key-value map that pairs the patterns that need to be replaced in a managed
	// template job document schema. You can use the description of each key as
	// a guidance to specify the inputs during runtime when creating a job.
	//
	// documentParameters can only be used when creating jobs from Amazon Web Services
	// managed templates. This parameter can't be used with custom job templates
	// or to create jobs from them.
	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"`

	// Indicates whether a job is concurrent. Will be true when a job is rolling
	// out new job executions or canceling previously created executions, otherwise
	// false.
	IsConcurrent *bool `locationName:"isConcurrent" type:"boolean"`

	// An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
	JobArn *string `locationName:"jobArn" type:"string"`

	// The configuration for the criteria to retry the job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig `locationName:"jobExecutionsRetryConfig" type:"structure"`

	// 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 ARN of the job template used to create the job.
	JobTemplateArn *string `locationName:"jobTemplateArn" min:"1" type:"string"`

	// The time, in seconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `locationName:"namespaceId" min:"1" type:"string"`

	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"`

	// If the job was updated, provides the reason code for the update.
	ReasonCode *string `locationName:"reasonCode" type:"string"`

	// The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS
	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	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"`

	// Specifies the amount of time each device has to finish its execution of the
	// job. A timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// timer expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Job) SetAbortConfig added in v1.15.79 

func (s *Job) SetAbortConfig(v *AbortConfig) *Job

SetAbortConfig sets the AbortConfig field's value.

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) SetIsConcurrent added in v1.44.8 

func (s *Job) SetIsConcurrent(v bool) *Job

SetIsConcurrent sets the IsConcurrent 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) SetJobExecutionsRetryConfig added in v1.42.28 

func (s *Job) SetJobExecutionsRetryConfig(v *JobExecutionsRetryConfig) *Job

SetJobExecutionsRetryConfig sets the JobExecutionsRetryConfig 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) SetJobTemplateArn added in v1.38.47 

func (s *Job) SetJobTemplateArn(v string) *Job

SetJobTemplateArn sets the JobTemplateArn 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) SetNamespaceId added in v1.35.17 

func (s *Job) SetNamespaceId(v string) *Job

SetNamespaceId sets the NamespaceId 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) SetReasonCode added in v1.15.79 

func (s *Job) SetReasonCode(v string) *Job

SetReasonCode sets the ReasonCode 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) SetTimeoutConfig added in v1.15.50 

func (s *Job) SetTimeoutConfig(v *TimeoutConfig) *Job

SetTimeoutConfig sets the TimeoutConfig field's value.

func (Job) String added in v1.12.36 

func (s Job) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobExecution added in v1.12.36 

type JobExecution struct {

	// The estimated number of seconds that remain before the job execution status
	// will be changed to TIMED_OUT. The timeout interval can be anywhere between
	// 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout
	// can occur up to 60 seconds later than the estimated duration. This value
	// will not be included if the job execution has reached a terminal status.
	ApproximateSecondsBeforeTimedOut *int64 `locationName:"approximateSecondsBeforeTimedOut" type:"long"`

	// 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 seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The time, in seconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time `locationName:"queuedAt" type:"timestamp"`

	// The time, in seconds since the epoch, when the job execution started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp"`

	// The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED,
	// TIMED_OUT, 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecution) SetApproximateSecondsBeforeTimedOut added in v1.15.50 

func (s *JobExecution) SetApproximateSecondsBeforeTimedOut(v int64) *JobExecution

SetApproximateSecondsBeforeTimedOut sets the ApproximateSecondsBeforeTimedOut field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionStatusDetails) SetDetailsMap added in v1.12.36 

func (s *JobExecutionStatusDetails) SetDetailsMap(v map[string]*string) *JobExecutionStatusDetails

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The time, in seconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time `locationName:"queuedAt" type:"timestamp"`

	// The number that indicates how many retry attempts have been completed for
	// this job on this device.
	RetryAttempt *int64 `locationName:"retryAttempt" type:"integer"`

	// The time, in seconds since the epoch, when the job execution started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetRetryAttempt added in v1.42.28 

func (s *JobExecutionSummary) SetRetryAttempt(v int64) *JobExecutionSummary

SetRetryAttempt sets the RetryAttempt 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 

func (s *JobExecutionSummary) SetStatus(v string) *JobExecutionSummary

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionSummaryForJob) SetJobExecutionSummary added in v1.12.36 

func (s *JobExecutionSummaryForJob) SetJobExecutionSummary(v *JobExecutionSummary) *JobExecutionSummaryForJob

SetJobExecutionSummary sets the JobExecutionSummary field's value.

func (*JobExecutionSummaryForJob) SetThingArn added in v1.12.36 

func (s *JobExecutionSummaryForJob) SetThingArn(v string) *JobExecutionSummaryForJob

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionSummaryForThing) SetJobExecutionSummary added in v1.12.36 

func (s *JobExecutionSummaryForThing) SetJobExecutionSummary(v *JobExecutionSummary) *JobExecutionSummaryForThing

SetJobExecutionSummary sets the JobExecutionSummary field's value.

func (*JobExecutionSummaryForThing) SetJobId added in v1.12.36 

func (s *JobExecutionSummaryForThing) SetJobId(v string) *JobExecutionSummaryForThing

SetJobId sets the JobId field's value.

func (JobExecutionSummaryForThing) String added in v1.12.36 

func (s JobExecutionSummaryForThing) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobExecutionsRetryConfig added in v1.42.28 

type JobExecutionsRetryConfig struct {

	// The list of criteria that determines how many retries are allowed for each
	// failure type for a job.
	//
	// CriteriaList is a required field
	CriteriaList []*RetryCriteria `locationName:"criteriaList" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The configuration that determines how many retries are allowed for each failure type for a job.

func (JobExecutionsRetryConfig) GoString added in v1.42.28 

func (s JobExecutionsRetryConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionsRetryConfig) SetCriteriaList added in v1.42.28 

func (s *JobExecutionsRetryConfig) SetCriteriaList(v []*RetryCriteria) *JobExecutionsRetryConfig

SetCriteriaList sets the CriteriaList field's value.

func (JobExecutionsRetryConfig) String added in v1.42.28 

func (s JobExecutionsRetryConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionsRetryConfig) Validate added in v1.42.28 

func (s *JobExecutionsRetryConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobExecutionsRolloutConfig added in v1.12.36 

type JobExecutionsRolloutConfig struct {

	// The rate of increase for a job rollout. This parameter allows you to define
	// an exponential rate for a job rollout.
	ExponentialRate *ExponentialRolloutRate `locationName:"exponentialRate" type:"structure"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobExecutionsRolloutConfig) SetExponentialRate added in v1.15.79 

func (s *JobExecutionsRolloutConfig) SetExponentialRate(v *ExponentialRolloutRate) *JobExecutionsRolloutConfig

SetExponentialRate sets the ExponentialRate field's value.

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 

func (s JobExecutionsRolloutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 number of things whose job execution status is TIMED_OUT.
	NumberOfTimedOutThings *int64 `locationName:"numberOfTimedOutThings" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetNumberOfTimedOutThings added in v1.15.50 

func (s *JobProcessDetails) SetNumberOfTimedOutThings(v int64) *JobProcessDetails

SetNumberOfTimedOutThings sets the NumberOfTimedOutThings 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobSummary added in v1.12.36 

type JobSummary struct {

	// The time, in seconds since the epoch, when the job completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp"`

	// The time, in seconds since the epoch, when the job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Indicates whether a job is concurrent. Will be true when a job is rolling
	// out new job executions or canceling previously created executions, otherwise
	// false.
	IsConcurrent *bool `locationName:"isConcurrent" type:"boolean"`

	// 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 seconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIsConcurrent added in v1.44.8 

func (s *JobSummary) SetIsConcurrent(v bool) *JobSummary

SetIsConcurrent sets the IsConcurrent 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobTemplateSummary added in v1.38.47 

type JobTemplateSummary struct {

	// The time, in seconds since the epoch, when the job template was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A description of the job template.
	Description *string `locationName:"description" type:"string"`

	// The ARN of the job template.
	JobTemplateArn *string `locationName:"jobTemplateArn" min:"1" type:"string"`

	// The unique identifier of the job template.
	JobTemplateId *string `locationName:"jobTemplateId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about the job template.

func (JobTemplateSummary) GoString added in v1.38.47 

func (s JobTemplateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobTemplateSummary) SetCreatedAt added in v1.38.47 

func (s *JobTemplateSummary) SetCreatedAt(v time.Time) *JobTemplateSummary

SetCreatedAt sets the CreatedAt field's value.

func (*JobTemplateSummary) SetDescription added in v1.38.47 

func (s *JobTemplateSummary) SetDescription(v string) *JobTemplateSummary

SetDescription sets the Description field's value.

func (*JobTemplateSummary) SetJobTemplateArn added in v1.38.47 

func (s *JobTemplateSummary) SetJobTemplateArn(v string) *JobTemplateSummary

SetJobTemplateArn sets the JobTemplateArn field's value.

func (*JobTemplateSummary) SetJobTemplateId added in v1.38.47 

func (s *JobTemplateSummary) SetJobTemplateId(v string) *JobTemplateSummary

SetJobTemplateId sets the JobTemplateId field's value.

func (JobTemplateSummary) String added in v1.38.47 

func (s JobTemplateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KafkaAction added in v1.36.9 

type KafkaAction struct {

	// Properties of the Apache Kafka producer client.
	//
	// ClientProperties is a required field
	ClientProperties map[string]*string `locationName:"clientProperties" type:"map" required:"true"`

	// The ARN of Kafka action's VPC TopicRuleDestination.
	//
	// DestinationArn is a required field
	DestinationArn *string `locationName:"destinationArn" type:"string" required:"true"`

	// The Kafka message key.
	Key *string `locationName:"key" type:"string"`

	// The Kafka message partition.
	Partition *string `locationName:"partition" type:"string"`

	// The Kafka topic for messages to be sent to the Kafka broker.
	//
	// Topic is a required field
	Topic *string `locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

func (KafkaAction) GoString added in v1.36.9 

func (s KafkaAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KafkaAction) SetClientProperties added in v1.36.9 

func (s *KafkaAction) SetClientProperties(v map[string]*string) *KafkaAction

SetClientProperties sets the ClientProperties field's value.

func (*KafkaAction) SetDestinationArn added in v1.36.9 

func (s *KafkaAction) SetDestinationArn(v string) *KafkaAction

SetDestinationArn sets the DestinationArn field's value.

func (*KafkaAction) SetKey added in v1.36.9 

func (s *KafkaAction) SetKey(v string) *KafkaAction

SetKey sets the Key field's value.

func (*KafkaAction) SetPartition added in v1.36.9 

func (s *KafkaAction) SetPartition(v string) *KafkaAction

SetPartition sets the Partition field's value.

func (*KafkaAction) SetTopic added in v1.36.9 

func (s *KafkaAction) SetTopic(v string) *KafkaAction

SetTopic sets the Topic field's value.

func (KafkaAction) String added in v1.36.9 

func (s KafkaAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KafkaAction) Validate added in v1.36.9 

func (s *KafkaAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KeyPair 

type KeyPair struct {

	// The private key.
	//
	// PrivateKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KeyPair's
	// String and GoString methods.
	PrivateKey *string `min:"1" type:"string" sensitive:"true"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A limit has been exceeded.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListActiveViolationsInput added in v1.15.2 

type ListActiveViolationsInput struct {

	// The criteria for a behavior.
	BehaviorCriteriaType *string `location:"querystring" locationName:"behaviorCriteriaType" type:"string" enum:"BehaviorCriteriaType"`

	// A list of all suppressed alerts.
	ListSuppressedAlerts *bool `location:"querystring" locationName:"listSuppressedAlerts" type:"boolean"`

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The name of the Device Defender security profile for which violations are
	// listed.
	SecurityProfileName *string `location:"querystring" locationName:"securityProfileName" min:"1" type:"string"`

	// The name of the thing whose active violations are listed.
	ThingName *string `location:"querystring" locationName:"thingName" min:"1" type:"string"`

	// The verification state of the violation (detect alarm).
	VerificationState *string `location:"querystring" locationName:"verificationState" type:"string" enum:"VerificationState"`
	// contains filtered or unexported fields
}

func (ListActiveViolationsInput) GoString added in v1.15.2 

func (s ListActiveViolationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActiveViolationsInput) SetBehaviorCriteriaType added in v1.36.9 

func (s *ListActiveViolationsInput) SetBehaviorCriteriaType(v string) *ListActiveViolationsInput

SetBehaviorCriteriaType sets the BehaviorCriteriaType field's value.

func (*ListActiveViolationsInput) SetListSuppressedAlerts added in v1.36.9 

func (s *ListActiveViolationsInput) SetListSuppressedAlerts(v bool) *ListActiveViolationsInput

SetListSuppressedAlerts sets the ListSuppressedAlerts field's value.

func (*ListActiveViolationsInput) SetMaxResults added in v1.15.2 

func (s *ListActiveViolationsInput) SetMaxResults(v int64) *ListActiveViolationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListActiveViolationsInput) SetNextToken added in v1.15.2 

func (s *ListActiveViolationsInput) SetNextToken(v string) *ListActiveViolationsInput

SetNextToken sets the NextToken field's value.

func (*ListActiveViolationsInput) SetSecurityProfileName added in v1.15.2 

func (s *ListActiveViolationsInput) SetSecurityProfileName(v string) *ListActiveViolationsInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*ListActiveViolationsInput) SetThingName added in v1.15.2 

func (s *ListActiveViolationsInput) SetThingName(v string) *ListActiveViolationsInput

SetThingName sets the ThingName field's value.

func (*ListActiveViolationsInput) SetVerificationState added in v1.40.46 

func (s *ListActiveViolationsInput) SetVerificationState(v string) *ListActiveViolationsInput

SetVerificationState sets the VerificationState field's value.

func (ListActiveViolationsInput) String added in v1.15.2 

func (s ListActiveViolationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActiveViolationsInput) Validate added in v1.15.2 

func (s *ListActiveViolationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListActiveViolationsOutput added in v1.15.2 

type ListActiveViolationsOutput struct {

	// The list of active violations.
	ActiveViolations []*ActiveViolation `locationName:"activeViolations" type:"list"`

	// A token that can be used to retrieve 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 (ListActiveViolationsOutput) GoString added in v1.15.2 

func (s ListActiveViolationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActiveViolationsOutput) SetActiveViolations added in v1.15.2 

func (s *ListActiveViolationsOutput) SetActiveViolations(v []*ActiveViolation) *ListActiveViolationsOutput

SetActiveViolations sets the ActiveViolations field's value.

func (*ListActiveViolationsOutput) SetNextToken added in v1.15.2 

func (s *ListActiveViolationsOutput) SetNextToken(v string) *ListActiveViolationsOutput

SetNextToken sets the NextToken field's value.

func (ListActiveViolationsOutput) String added in v1.15.2 

func (s ListActiveViolationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 or principal for which the policies will be listed. Valid principals
	// are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedPoliciesInput) SetMarker added in v1.12.36 

func (s *ListAttachedPoliciesInput) SetMarker(v string) *ListAttachedPoliciesInput

SetMarker sets the Marker field's value.

func (*ListAttachedPoliciesInput) SetPageSize added in v1.12.36 

func (s *ListAttachedPoliciesInput) SetPageSize(v int64) *ListAttachedPoliciesInput

SetPageSize sets the PageSize field's value.

func (*ListAttachedPoliciesInput) SetRecursive added in v1.12.36 

func (s *ListAttachedPoliciesInput) SetRecursive(v bool) *ListAttachedPoliciesInput

SetRecursive sets the Recursive field's value.

func (*ListAttachedPoliciesInput) SetTarget added in v1.12.36 

func (s *ListAttachedPoliciesInput) SetTarget(v string) *ListAttachedPoliciesInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedPoliciesOutput) SetNextMarker added in v1.12.36 

func (s *ListAttachedPoliciesOutput) SetNextMarker(v string) *ListAttachedPoliciesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListAttachedPoliciesOutput) SetPolicies added in v1.12.36 

func (s *ListAttachedPoliciesOutput) SetPolicies(v []*Policy) *ListAttachedPoliciesOutput

SetPolicies sets the Policies field's value.

func (ListAttachedPoliciesOutput) String added in v1.12.36 

func (s ListAttachedPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAuditFindingsInput added in v1.15.2 

type ListAuditFindingsInput struct {

	// A filter to limit results to the findings for the specified audit check.
	CheckName *string `locationName:"checkName" type:"string"`

	// A filter to limit results to those found before the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// Boolean flag indicating whether only the suppressed findings or the unsuppressed
	// findings should be listed. If this parameter isn't provided, the response
	// will list both suppressed and unsuppressed findings.
	ListSuppressedFindings *bool `locationName:"listSuppressedFindings" type:"boolean"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Information identifying the noncompliant resource.
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure"`

	// A filter to limit results to those found after the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// A filter to limit results to the audit with the specified ID. You must specify
	// either the taskId or the startTime and endTime, but not both.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAuditFindingsInput) GoString added in v1.15.2 

func (s ListAuditFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditFindingsInput) SetCheckName added in v1.15.2 

func (s *ListAuditFindingsInput) SetCheckName(v string) *ListAuditFindingsInput

SetCheckName sets the CheckName field's value.

func (*ListAuditFindingsInput) SetEndTime added in v1.15.2 

func (s *ListAuditFindingsInput) SetEndTime(v time.Time) *ListAuditFindingsInput

SetEndTime sets the EndTime field's value.

func (*ListAuditFindingsInput) SetListSuppressedFindings added in v1.34.3 

func (s *ListAuditFindingsInput) SetListSuppressedFindings(v bool) *ListAuditFindingsInput

SetListSuppressedFindings sets the ListSuppressedFindings field's value.

func (*ListAuditFindingsInput) SetMaxResults added in v1.15.2 

func (s *ListAuditFindingsInput) SetMaxResults(v int64) *ListAuditFindingsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAuditFindingsInput) SetNextToken added in v1.15.2 

func (s *ListAuditFindingsInput) SetNextToken(v string) *ListAuditFindingsInput

SetNextToken sets the NextToken field's value.

func (*ListAuditFindingsInput) SetResourceIdentifier added in v1.15.2 

func (s *ListAuditFindingsInput) SetResourceIdentifier(v *ResourceIdentifier) *ListAuditFindingsInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*ListAuditFindingsInput) SetStartTime added in v1.15.2 

func (s *ListAuditFindingsInput) SetStartTime(v time.Time) *ListAuditFindingsInput

SetStartTime sets the StartTime field's value.

func (*ListAuditFindingsInput) SetTaskId added in v1.15.2 

func (s *ListAuditFindingsInput) SetTaskId(v string) *ListAuditFindingsInput

SetTaskId sets the TaskId field's value.

func (ListAuditFindingsInput) String added in v1.15.2 

func (s ListAuditFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditFindingsInput) Validate added in v1.15.2 

func (s *ListAuditFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAuditFindingsOutput added in v1.15.2 

type ListAuditFindingsOutput struct {

	// The findings (results) of the audit.
	Findings []*AuditFinding `locationName:"findings" type:"list"`

	// A token that can be used to retrieve 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 (ListAuditFindingsOutput) GoString added in v1.15.2 

func (s ListAuditFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditFindingsOutput) SetFindings added in v1.15.2 

func (s *ListAuditFindingsOutput) SetFindings(v []*AuditFinding) *ListAuditFindingsOutput

SetFindings sets the Findings field's value.

func (*ListAuditFindingsOutput) SetNextToken added in v1.15.2 

func (s *ListAuditFindingsOutput) SetNextToken(v string) *ListAuditFindingsOutput

SetNextToken sets the NextToken field's value.

func (ListAuditFindingsOutput) String added in v1.15.2 

func (s ListAuditFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAuditMitigationActionsExecutionsInput added in v1.21.10 

type ListAuditMitigationActionsExecutionsInput struct {

	// Specify this filter to limit results to those with a specific status.
	ActionStatus *string `location:"querystring" locationName:"actionStatus" type:"string" enum:"AuditMitigationActionsExecutionStatus"`

	// Specify this filter to limit results to those that were applied to a specific
	// audit finding.
	//
	// FindingId is a required field
	FindingId *string `location:"querystring" locationName:"findingId" min:"1" type:"string" required:"true"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Specify this filter to limit results to actions for a specific audit mitigation
	// actions task.
	//
	// TaskId is a required field
	TaskId *string `location:"querystring" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAuditMitigationActionsExecutionsInput) GoString added in v1.21.10 

func (s ListAuditMitigationActionsExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsExecutionsInput) SetActionStatus added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) SetActionStatus(v string) *ListAuditMitigationActionsExecutionsInput

SetActionStatus sets the ActionStatus field's value.

func (*ListAuditMitigationActionsExecutionsInput) SetFindingId added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) SetFindingId(v string) *ListAuditMitigationActionsExecutionsInput

SetFindingId sets the FindingId field's value.

func (*ListAuditMitigationActionsExecutionsInput) SetMaxResults added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) SetMaxResults(v int64) *ListAuditMitigationActionsExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAuditMitigationActionsExecutionsInput) SetNextToken added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) SetNextToken(v string) *ListAuditMitigationActionsExecutionsInput

SetNextToken sets the NextToken field's value.

func (*ListAuditMitigationActionsExecutionsInput) SetTaskId added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) SetTaskId(v string) *ListAuditMitigationActionsExecutionsInput

SetTaskId sets the TaskId field's value.

func (ListAuditMitigationActionsExecutionsInput) String added in v1.21.10 

func (s ListAuditMitigationActionsExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsExecutionsInput) Validate added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAuditMitigationActionsExecutionsOutput added in v1.21.10 

type ListAuditMitigationActionsExecutionsOutput struct {

	// A set of task execution results based on the input parameters. Details include
	// the mitigation action applied, start time, and task status.
	ActionsExecutions []*AuditMitigationActionExecutionMetadata `locationName:"actionsExecutions" type:"list"`

	// The token for the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAuditMitigationActionsExecutionsOutput) GoString added in v1.21.10 

func (s ListAuditMitigationActionsExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsExecutionsOutput) SetActionsExecutions added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsOutput) SetActionsExecutions(v []*AuditMitigationActionExecutionMetadata) *ListAuditMitigationActionsExecutionsOutput

SetActionsExecutions sets the ActionsExecutions field's value.

func (*ListAuditMitigationActionsExecutionsOutput) SetNextToken added in v1.21.10 

func (s *ListAuditMitigationActionsExecutionsOutput) SetNextToken(v string) *ListAuditMitigationActionsExecutionsOutput

SetNextToken sets the NextToken field's value.

func (ListAuditMitigationActionsExecutionsOutput) String added in v1.21.10 

func (s ListAuditMitigationActionsExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAuditMitigationActionsTasksInput added in v1.21.10 

type ListAuditMitigationActionsTasksInput struct {

	// Specify this filter to limit results to tasks that were applied to results
	// for a specific audit.
	AuditTaskId *string `location:"querystring" locationName:"auditTaskId" min:"1" type:"string"`

	// Specify this filter to limit results to tasks that were completed or canceled
	// on or before a specific date and time.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" required:"true"`

	// Specify this filter to limit results to tasks that were applied to a specific
	// audit finding.
	FindingId *string `location:"querystring" locationName:"findingId" min:"1" type:"string"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Specify this filter to limit results to tasks that began on or after a specific
	// date and time.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" required:"true"`

	// Specify this filter to limit results to tasks that are in a specific state.
	TaskStatus *string `location:"querystring" locationName:"taskStatus" type:"string" enum:"AuditMitigationActionsTaskStatus"`
	// contains filtered or unexported fields
}

func (ListAuditMitigationActionsTasksInput) GoString added in v1.21.10 

func (s ListAuditMitigationActionsTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsTasksInput) SetAuditTaskId added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetAuditTaskId(v string) *ListAuditMitigationActionsTasksInput

SetAuditTaskId sets the AuditTaskId field's value.

func (*ListAuditMitigationActionsTasksInput) SetEndTime added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetEndTime(v time.Time) *ListAuditMitigationActionsTasksInput

SetEndTime sets the EndTime field's value.

func (*ListAuditMitigationActionsTasksInput) SetFindingId added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetFindingId(v string) *ListAuditMitigationActionsTasksInput

SetFindingId sets the FindingId field's value.

func (*ListAuditMitigationActionsTasksInput) SetMaxResults added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetMaxResults(v int64) *ListAuditMitigationActionsTasksInput

SetMaxResults sets the MaxResults field's value.

func (*ListAuditMitigationActionsTasksInput) SetNextToken added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetNextToken(v string) *ListAuditMitigationActionsTasksInput

SetNextToken sets the NextToken field's value.

func (*ListAuditMitigationActionsTasksInput) SetStartTime added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetStartTime(v time.Time) *ListAuditMitigationActionsTasksInput

SetStartTime sets the StartTime field's value.

func (*ListAuditMitigationActionsTasksInput) SetTaskStatus added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) SetTaskStatus(v string) *ListAuditMitigationActionsTasksInput

SetTaskStatus sets the TaskStatus field's value.

func (ListAuditMitigationActionsTasksInput) String added in v1.21.10 

func (s ListAuditMitigationActionsTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsTasksInput) Validate added in v1.21.10 

func (s *ListAuditMitigationActionsTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAuditMitigationActionsTasksOutput added in v1.21.10 

type ListAuditMitigationActionsTasksOutput struct {

	// The token for the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The collection of audit mitigation tasks that matched the filter criteria.
	Tasks []*AuditMitigationActionsTaskMetadata `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (ListAuditMitigationActionsTasksOutput) GoString added in v1.21.10 

func (s ListAuditMitigationActionsTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditMitigationActionsTasksOutput) SetNextToken added in v1.21.10 

func (s *ListAuditMitigationActionsTasksOutput) SetNextToken(v string) *ListAuditMitigationActionsTasksOutput

SetNextToken sets the NextToken field's value.

func (*ListAuditMitigationActionsTasksOutput) SetTasks added in v1.21.10 

func (s *ListAuditMitigationActionsTasksOutput) SetTasks(v []*AuditMitigationActionsTaskMetadata) *ListAuditMitigationActionsTasksOutput

SetTasks sets the Tasks field's value.

func (ListAuditMitigationActionsTasksOutput) String added in v1.21.10 

func (s ListAuditMitigationActionsTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAuditSuppressionsInput added in v1.34.3 

type ListAuditSuppressionsInput struct {

	// Determines whether suppressions are listed in ascending order by expiration
	// date or not. If parameter isn't provided, ascendingOrder=true.
	AscendingOrder *bool `locationName:"ascendingOrder" type:"boolean"`

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	CheckName *string `locationName:"checkName" type:"string"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure"`
	// contains filtered or unexported fields
}

func (ListAuditSuppressionsInput) GoString added in v1.34.3 

func (s ListAuditSuppressionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditSuppressionsInput) SetAscendingOrder added in v1.34.3 

func (s *ListAuditSuppressionsInput) SetAscendingOrder(v bool) *ListAuditSuppressionsInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListAuditSuppressionsInput) SetCheckName added in v1.34.3 

func (s *ListAuditSuppressionsInput) SetCheckName(v string) *ListAuditSuppressionsInput

SetCheckName sets the CheckName field's value.

func (*ListAuditSuppressionsInput) SetMaxResults added in v1.34.3 

func (s *ListAuditSuppressionsInput) SetMaxResults(v int64) *ListAuditSuppressionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAuditSuppressionsInput) SetNextToken added in v1.34.3 

func (s *ListAuditSuppressionsInput) SetNextToken(v string) *ListAuditSuppressionsInput

SetNextToken sets the NextToken field's value.

func (*ListAuditSuppressionsInput) SetResourceIdentifier added in v1.34.3 

func (s *ListAuditSuppressionsInput) SetResourceIdentifier(v *ResourceIdentifier) *ListAuditSuppressionsInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ListAuditSuppressionsInput) String added in v1.34.3 

func (s ListAuditSuppressionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditSuppressionsInput) Validate added in v1.34.3 

func (s *ListAuditSuppressionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAuditSuppressionsOutput added in v1.34.3 

type ListAuditSuppressionsOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// List of audit suppressions.
	Suppressions []*AuditSuppression `locationName:"suppressions" type:"list"`
	// contains filtered or unexported fields
}

func (ListAuditSuppressionsOutput) GoString added in v1.34.3 

func (s ListAuditSuppressionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditSuppressionsOutput) SetNextToken added in v1.34.3 

func (s *ListAuditSuppressionsOutput) SetNextToken(v string) *ListAuditSuppressionsOutput

SetNextToken sets the NextToken field's value.

func (*ListAuditSuppressionsOutput) SetSuppressions added in v1.34.3 

func (s *ListAuditSuppressionsOutput) SetSuppressions(v []*AuditSuppression) *ListAuditSuppressionsOutput

SetSuppressions sets the Suppressions field's value.

func (ListAuditSuppressionsOutput) String added in v1.34.3 

func (s ListAuditSuppressionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAuditTasksInput added in v1.15.2 

type ListAuditTasksInput struct {

	// The end of the time period.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" required:"true"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The beginning of the time period. Audit information is retained for a limited
	// time (90 days). Requesting a start time prior to what is retained results
	// in an "InvalidRequestException".
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" required:"true"`

	// A filter to limit the output to audits with the specified completion status:
	// can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
	TaskStatus *string `location:"querystring" locationName:"taskStatus" type:"string" enum:"AuditTaskStatus"`

	// A filter to limit the output to the specified type of audit: can be one of
	// "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
	TaskType *string `location:"querystring" locationName:"taskType" type:"string" enum:"AuditTaskType"`
	// contains filtered or unexported fields
}

func (ListAuditTasksInput) GoString added in v1.15.2 

func (s ListAuditTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditTasksInput) SetEndTime added in v1.15.2 

func (s *ListAuditTasksInput) SetEndTime(v time.Time) *ListAuditTasksInput

SetEndTime sets the EndTime field's value.

func (*ListAuditTasksInput) SetMaxResults added in v1.15.2 

func (s *ListAuditTasksInput) SetMaxResults(v int64) *ListAuditTasksInput

SetMaxResults sets the MaxResults field's value.

func (*ListAuditTasksInput) SetNextToken added in v1.15.2 

func (s *ListAuditTasksInput) SetNextToken(v string) *ListAuditTasksInput

SetNextToken sets the NextToken field's value.

func (*ListAuditTasksInput) SetStartTime added in v1.15.2 

func (s *ListAuditTasksInput) SetStartTime(v time.Time) *ListAuditTasksInput

SetStartTime sets the StartTime field's value.

func (*ListAuditTasksInput) SetTaskStatus added in v1.15.2 

func (s *ListAuditTasksInput) SetTaskStatus(v string) *ListAuditTasksInput

SetTaskStatus sets the TaskStatus field's value.

func (*ListAuditTasksInput) SetTaskType added in v1.15.2 

func (s *ListAuditTasksInput) SetTaskType(v string) *ListAuditTasksInput

SetTaskType sets the TaskType field's value.

func (ListAuditTasksInput) String added in v1.15.2 

func (s ListAuditTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditTasksInput) Validate added in v1.15.2 

func (s *ListAuditTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAuditTasksOutput added in v1.15.2 

type ListAuditTasksOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The audits that were performed during the specified time period.
	Tasks []*AuditTaskMetadata `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (ListAuditTasksOutput) GoString added in v1.15.2 

func (s ListAuditTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuditTasksOutput) SetNextToken added in v1.15.2 

func (s *ListAuditTasksOutput) SetNextToken(v string) *ListAuditTasksOutput

SetNextToken sets the NextToken field's value.

func (*ListAuditTasksOutput) SetTasks added in v1.15.2 

func (s *ListAuditTasksOutput) SetTasks(v []*AuditTaskMetadata) *ListAuditTasksOutput

SetTasks sets the Tasks field's value.

func (ListAuditTasksOutput) String added in v1.15.2 

func (s ListAuditTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListAuthorizersInput) SetMarker(v string) *ListAuthorizersInput

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 

func (s *ListAuthorizersInput) SetStatus(v string) *ListAuthorizersInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAuthorizersOutput) SetAuthorizers added in v1.12.36 

func (s *ListAuthorizersOutput) SetAuthorizers(v []*AuthorizerSummary) *ListAuthorizersOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBillingGroupsInput added in v1.15.79 

type ListBillingGroupsInput struct {

	// The maximum number of results to return per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Limit the results to billing groups whose names have the given prefix.
	NamePrefixFilter *string `location:"querystring" locationName:"namePrefixFilter" min:"1" type:"string"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBillingGroupsInput) GoString added in v1.15.79 

func (s ListBillingGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBillingGroupsInput) SetMaxResults added in v1.15.79 

func (s *ListBillingGroupsInput) SetMaxResults(v int64) *ListBillingGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListBillingGroupsInput) SetNamePrefixFilter added in v1.15.79 

func (s *ListBillingGroupsInput) SetNamePrefixFilter(v string) *ListBillingGroupsInput

SetNamePrefixFilter sets the NamePrefixFilter field's value.

func (*ListBillingGroupsInput) SetNextToken added in v1.15.79 

func (s *ListBillingGroupsInput) SetNextToken(v string) *ListBillingGroupsInput

SetNextToken sets the NextToken field's value.

func (ListBillingGroupsInput) String added in v1.15.79 

func (s ListBillingGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBillingGroupsInput) Validate added in v1.15.79 

func (s *ListBillingGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBillingGroupsOutput added in v1.15.79 

type ListBillingGroupsOutput struct {

	// The list of billing groups.
	BillingGroups []*GroupNameAndArn `locationName:"billingGroups" type:"list"`

	// The token to use 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 (ListBillingGroupsOutput) GoString added in v1.15.79 

func (s ListBillingGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBillingGroupsOutput) SetBillingGroups added in v1.15.79 

func (s *ListBillingGroupsOutput) SetBillingGroups(v []*GroupNameAndArn) *ListBillingGroupsOutput

SetBillingGroups sets the BillingGroups field's value.

func (*ListBillingGroupsOutput) SetNextToken added in v1.15.79 

func (s *ListBillingGroupsOutput) SetNextToken(v string) *ListBillingGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListBillingGroupsOutput) String added in v1.15.79 

func (s ListBillingGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListCACertificatesInput) SetMarker(v string) *ListCACertificatesInput

SetMarker sets the Marker field's value.

func (*ListCACertificatesInput) SetPageSize added in v1.5.0 

func (s *ListCACertificatesInput) SetPageSize(v int64) *ListCACertificatesInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCACertificatesOutput) SetCertificates added in v1.5.0 

func (s *ListCACertificatesOutput) SetCertificates(v []*CACertificate) *ListCACertificatesOutput

SetCertificates sets the Certificates field's value.

func (*ListCACertificatesOutput) SetNextMarker added in v1.5.0 

func (s *ListCACertificatesOutput) SetNextMarker(v string) *ListCACertificatesOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListCertificatesByCAInput) SetCaCertificateId(v string) *ListCertificatesByCAInput

SetCaCertificateId sets the CaCertificateId field's value.

func (*ListCertificatesByCAInput) SetMarker added in v1.5.0 

func (s *ListCertificatesByCAInput) SetMarker(v string) *ListCertificatesByCAInput

SetMarker sets the Marker field's value.

func (*ListCertificatesByCAInput) SetPageSize added in v1.5.0 

func (s *ListCertificatesByCAInput) SetPageSize(v int64) *ListCertificatesByCAInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCertificatesByCAOutput) SetCertificates added in v1.5.0 

func (s *ListCertificatesByCAOutput) SetCertificates(v []*Certificate) *ListCertificatesByCAOutput

SetCertificates sets the Certificates field's value.

func (*ListCertificatesByCAOutput) SetNextMarker added in v1.5.0 

func (s *ListCertificatesByCAOutput) SetNextMarker(v string) *ListCertificatesByCAOutput

SetNextMarker sets the NextMarker field's value.

func (ListCertificatesByCAOutput) String added in v1.1.18 

func (s ListCertificatesByCAOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListCertificatesInput) SetMarker(v string) *ListCertificatesInput

SetMarker sets the Marker field's value.

func (*ListCertificatesInput) SetPageSize added in v1.5.0 

func (s *ListCertificatesInput) SetPageSize(v int64) *ListCertificatesInput

SetPageSize sets the PageSize field's value.

func (ListCertificatesInput) String 

func (s ListCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListCertificatesOutput) SetNextMarker(v string) *ListCertificatesOutput

SetNextMarker sets the NextMarker field's value.

func (ListCertificatesOutput) String 

func (s ListCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCustomMetricsInput added in v1.36.9 

type ListCustomMetricsInput struct {

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCustomMetricsInput) GoString added in v1.36.9 

func (s ListCustomMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCustomMetricsInput) SetMaxResults added in v1.36.9 

func (s *ListCustomMetricsInput) SetMaxResults(v int64) *ListCustomMetricsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCustomMetricsInput) SetNextToken added in v1.36.9 

func (s *ListCustomMetricsInput) SetNextToken(v string) *ListCustomMetricsInput

SetNextToken sets the NextToken field's value.

func (ListCustomMetricsInput) String added in v1.36.9 

func (s ListCustomMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCustomMetricsInput) Validate added in v1.36.9 

func (s *ListCustomMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCustomMetricsOutput added in v1.36.9 

type ListCustomMetricsOutput struct {

	// The name of the custom metric.
	MetricNames []*string `locationName:"metricNames" type:"list"`

	// A token that can be used to retrieve 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 (ListCustomMetricsOutput) GoString added in v1.36.9 

func (s ListCustomMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCustomMetricsOutput) SetMetricNames added in v1.36.9 

func (s *ListCustomMetricsOutput) SetMetricNames(v []*string) *ListCustomMetricsOutput

SetMetricNames sets the MetricNames field's value.

func (*ListCustomMetricsOutput) SetNextToken added in v1.36.9 

func (s *ListCustomMetricsOutput) SetNextToken(v string) *ListCustomMetricsOutput

SetNextToken sets the NextToken field's value.

func (ListCustomMetricsOutput) String added in v1.36.9 

func (s ListCustomMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDetectMitigationActionsExecutionsInput added in v1.36.9 

type ListDetectMitigationActionsExecutionsInput struct {

	// The end of the time period for which ML Detect mitigation actions executions
	// are returned.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// A filter to limit results to those found after the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp"`

	// The unique identifier of the task.
	TaskId *string `location:"querystring" locationName:"taskId" min:"1" type:"string"`

	// The name of the thing whose mitigation actions are listed.
	ThingName *string `location:"querystring" locationName:"thingName" min:"1" type:"string"`

	// The unique identifier of the violation.
	ViolationId *string `location:"querystring" locationName:"violationId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectMitigationActionsExecutionsInput) GoString added in v1.36.9 

func (s ListDetectMitigationActionsExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsExecutionsInput) SetEndTime added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetEndTime(v time.Time) *ListDetectMitigationActionsExecutionsInput

SetEndTime sets the EndTime field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetMaxResults added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetMaxResults(v int64) *ListDetectMitigationActionsExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetNextToken added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetNextToken(v string) *ListDetectMitigationActionsExecutionsInput

SetNextToken sets the NextToken field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetStartTime added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetStartTime(v time.Time) *ListDetectMitigationActionsExecutionsInput

SetStartTime sets the StartTime field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetTaskId added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetTaskId(v string) *ListDetectMitigationActionsExecutionsInput

SetTaskId sets the TaskId field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetThingName added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetThingName(v string) *ListDetectMitigationActionsExecutionsInput

SetThingName sets the ThingName field's value.

func (*ListDetectMitigationActionsExecutionsInput) SetViolationId added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) SetViolationId(v string) *ListDetectMitigationActionsExecutionsInput

SetViolationId sets the ViolationId field's value.

func (ListDetectMitigationActionsExecutionsInput) String added in v1.36.9 

func (s ListDetectMitigationActionsExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsExecutionsInput) Validate added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDetectMitigationActionsExecutionsOutput added in v1.36.9 

type ListDetectMitigationActionsExecutionsOutput struct {

	// List of actions executions.
	ActionsExecutions []*DetectMitigationActionExecution `locationName:"actionsExecutions" type:"list"`

	// A token that can be used to retrieve 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 (ListDetectMitigationActionsExecutionsOutput) GoString added in v1.36.9 

func (s ListDetectMitigationActionsExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsExecutionsOutput) SetActionsExecutions added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsOutput) SetActionsExecutions(v []*DetectMitigationActionExecution) *ListDetectMitigationActionsExecutionsOutput

SetActionsExecutions sets the ActionsExecutions field's value.

func (*ListDetectMitigationActionsExecutionsOutput) SetNextToken added in v1.36.9 

func (s *ListDetectMitigationActionsExecutionsOutput) SetNextToken(v string) *ListDetectMitigationActionsExecutionsOutput

SetNextToken sets the NextToken field's value.

func (ListDetectMitigationActionsExecutionsOutput) String added in v1.36.9 

func (s ListDetectMitigationActionsExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDetectMitigationActionsTasksInput added in v1.36.9 

type ListDetectMitigationActionsTasksInput struct {

	// The end of the time period for which ML Detect mitigation actions tasks are
	// returned.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" required:"true"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// A filter to limit results to those found after the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (ListDetectMitigationActionsTasksInput) GoString added in v1.36.9 

func (s ListDetectMitigationActionsTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsTasksInput) SetEndTime added in v1.36.9 

func (s *ListDetectMitigationActionsTasksInput) SetEndTime(v time.Time) *ListDetectMitigationActionsTasksInput

SetEndTime sets the EndTime field's value.

func (*ListDetectMitigationActionsTasksInput) SetMaxResults added in v1.36.9 

func (s *ListDetectMitigationActionsTasksInput) SetMaxResults(v int64) *ListDetectMitigationActionsTasksInput

SetMaxResults sets the MaxResults field's value.

func (*ListDetectMitigationActionsTasksInput) SetNextToken added in v1.36.9 

func (s *ListDetectMitigationActionsTasksInput) SetNextToken(v string) *ListDetectMitigationActionsTasksInput

SetNextToken sets the NextToken field's value.

func (*ListDetectMitigationActionsTasksInput) SetStartTime added in v1.36.9 

func (s *ListDetectMitigationActionsTasksInput) SetStartTime(v time.Time) *ListDetectMitigationActionsTasksInput

SetStartTime sets the StartTime field's value.

func (ListDetectMitigationActionsTasksInput) String added in v1.36.9 

func (s ListDetectMitigationActionsTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsTasksInput) Validate added in v1.36.9 

func (s *ListDetectMitigationActionsTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDetectMitigationActionsTasksOutput added in v1.36.9 

type ListDetectMitigationActionsTasksOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The collection of ML Detect mitigation tasks that matched the filter criteria.
	Tasks []*DetectMitigationActionsTaskSummary `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (ListDetectMitigationActionsTasksOutput) GoString added in v1.36.9 

func (s ListDetectMitigationActionsTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectMitigationActionsTasksOutput) SetNextToken added in v1.36.9 

func (s *ListDetectMitigationActionsTasksOutput) SetNextToken(v string) *ListDetectMitigationActionsTasksOutput

SetNextToken sets the NextToken field's value.

func (*ListDetectMitigationActionsTasksOutput) SetTasks added in v1.36.9 

func (s *ListDetectMitigationActionsTasksOutput) SetTasks(v []*DetectMitigationActionsTaskSummary) *ListDetectMitigationActionsTasksOutput

SetTasks sets the Tasks field's value.

func (ListDetectMitigationActionsTasksOutput) String added in v1.36.9 

func (s ListDetectMitigationActionsTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDimensionsInput added in v1.30.2 

type ListDimensionsInput struct {

	// The maximum number of results to retrieve at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDimensionsInput) GoString added in v1.30.2 

func (s ListDimensionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDimensionsInput) SetMaxResults added in v1.30.2 

func (s *ListDimensionsInput) SetMaxResults(v int64) *ListDimensionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDimensionsInput) SetNextToken added in v1.30.2 

func (s *ListDimensionsInput) SetNextToken(v string) *ListDimensionsInput

SetNextToken sets the NextToken field's value.

func (ListDimensionsInput) String added in v1.30.2 

func (s ListDimensionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDimensionsInput) Validate added in v1.30.2 

func (s *ListDimensionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDimensionsOutput added in v1.30.2 

type ListDimensionsOutput struct {

	// A list of the names of the defined dimensions. Use DescribeDimension to get
	// details for a dimension.
	DimensionNames []*string `locationName:"dimensionNames" type:"list"`

	// A token that can be used to retrieve 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 (ListDimensionsOutput) GoString added in v1.30.2 

func (s ListDimensionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDimensionsOutput) SetDimensionNames added in v1.30.2 

func (s *ListDimensionsOutput) SetDimensionNames(v []*string) *ListDimensionsOutput

SetDimensionNames sets the DimensionNames field's value.

func (*ListDimensionsOutput) SetNextToken added in v1.30.2 

func (s *ListDimensionsOutput) SetNextToken(v string) *ListDimensionsOutput

SetNextToken sets the NextToken field's value.

func (ListDimensionsOutput) String added in v1.30.2 

func (s ListDimensionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainConfigurationsInput added in v1.25.42 

type ListDomainConfigurationsInput struct {

	// 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 type of service delivered by the endpoint.
	ServiceType *string `location:"querystring" locationName:"serviceType" type:"string" enum:"ServiceType"`
	// contains filtered or unexported fields
}

func (ListDomainConfigurationsInput) GoString added in v1.25.42 

func (s ListDomainConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainConfigurationsInput) SetMarker added in v1.25.42 

func (s *ListDomainConfigurationsInput) SetMarker(v string) *ListDomainConfigurationsInput

SetMarker sets the Marker field's value.

func (*ListDomainConfigurationsInput) SetPageSize added in v1.25.42 

func (s *ListDomainConfigurationsInput) SetPageSize(v int64) *ListDomainConfigurationsInput

SetPageSize sets the PageSize field's value.

func (*ListDomainConfigurationsInput) SetServiceType added in v1.25.42 

func (s *ListDomainConfigurationsInput) SetServiceType(v string) *ListDomainConfigurationsInput

SetServiceType sets the ServiceType field's value.

func (ListDomainConfigurationsInput) String added in v1.25.42 

func (s ListDomainConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainConfigurationsInput) Validate added in v1.25.42 

func (s *ListDomainConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDomainConfigurationsOutput added in v1.25.42 

type ListDomainConfigurationsOutput struct {

	// A list of objects that contain summary information about the user's domain
	// configurations.
	DomainConfigurations []*DomainConfigurationSummary `locationName:"domainConfigurations" type:"list"`

	// The marker for the next set of results.
	NextMarker *string `locationName:"nextMarker" type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainConfigurationsOutput) GoString added in v1.25.42 

func (s ListDomainConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainConfigurationsOutput) SetDomainConfigurations added in v1.25.42 

func (s *ListDomainConfigurationsOutput) SetDomainConfigurations(v []*DomainConfigurationSummary) *ListDomainConfigurationsOutput

SetDomainConfigurations sets the DomainConfigurations field's value.

func (*ListDomainConfigurationsOutput) SetNextMarker added in v1.25.42 

func (s *ListDomainConfigurationsOutput) SetNextMarker(v string) *ListDomainConfigurationsOutput

SetNextMarker sets the NextMarker field's value.

func (ListDomainConfigurationsOutput) String added in v1.25.42 

func (s ListDomainConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFleetMetricsInput added in v1.40.34 

type ListFleetMetricsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFleetMetricsInput) GoString added in v1.40.34 

func (s ListFleetMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFleetMetricsInput) SetMaxResults added in v1.40.34 

func (s *ListFleetMetricsInput) SetMaxResults(v int64) *ListFleetMetricsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFleetMetricsInput) SetNextToken added in v1.40.34 

func (s *ListFleetMetricsInput) SetNextToken(v string) *ListFleetMetricsInput

SetNextToken sets the NextToken field's value.

func (ListFleetMetricsInput) String added in v1.40.34 

func (s ListFleetMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFleetMetricsInput) Validate added in v1.40.34 

func (s *ListFleetMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFleetMetricsOutput added in v1.40.34 

type ListFleetMetricsOutput struct {

	// The list of fleet metrics objects.
	FleetMetrics []*FleetMetricNameAndArn `locationName:"fleetMetrics" type:"list"`

	// The token for the next set of results. Will not be returned if the operation
	// has returned all results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFleetMetricsOutput) GoString added in v1.40.34 

func (s ListFleetMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFleetMetricsOutput) SetFleetMetrics added in v1.40.34 

func (s *ListFleetMetricsOutput) SetFleetMetrics(v []*FleetMetricNameAndArn) *ListFleetMetricsOutput

SetFleetMetrics sets the FleetMetrics field's value.

func (*ListFleetMetricsOutput) SetNextToken added in v1.40.34 

func (s *ListFleetMetricsOutput) SetNextToken(v string) *ListFleetMetricsOutput

SetNextToken sets the NextToken field's value.

func (ListFleetMetricsOutput) String added in v1.40.34 

func (s ListFleetMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobExecutionsForJobInput) SetJobId added in v1.12.36 

func (s *ListJobExecutionsForJobInput) SetJobId(v string) *ListJobExecutionsForJobInput

SetJobId sets the JobId field's value.

func (*ListJobExecutionsForJobInput) SetMaxResults added in v1.12.36 

func (s *ListJobExecutionsForJobInput) SetMaxResults(v int64) *ListJobExecutionsForJobInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobExecutionsForJobInput) SetNextToken added in v1.12.36 

func (s *ListJobExecutionsForJobInput) SetNextToken(v string) *ListJobExecutionsForJobInput

SetNextToken sets the NextToken field's value.

func (*ListJobExecutionsForJobInput) SetStatus added in v1.12.36 

func (s *ListJobExecutionsForJobInput) SetStatus(v string) *ListJobExecutionsForJobInput

SetStatus sets the Status field's value.

func (ListJobExecutionsForJobInput) String added in v1.12.36 

func (s ListJobExecutionsForJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s ListJobExecutionsForJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobExecutionsForJobOutput) SetExecutionSummaries added in v1.12.36 

func (s *ListJobExecutionsForJobOutput) SetExecutionSummaries(v []*JobExecutionSummaryForJob) *ListJobExecutionsForJobOutput

SetExecutionSummaries sets the ExecutionSummaries field's value.

func (*ListJobExecutionsForJobOutput) SetNextToken added in v1.12.36 

func (s *ListJobExecutionsForJobOutput) SetNextToken(v string) *ListJobExecutionsForJobOutput

SetNextToken sets the NextToken field's value.

func (ListJobExecutionsForJobOutput) String added in v1.12.36 

func (s ListJobExecutionsForJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListJobExecutionsForThingInput added in v1.12.36 

type ListJobExecutionsForThingInput struct {

	// The unique identifier you assigned to this job when it was created.
	JobId *string `location:"querystring" locationName:"jobId" min:"1" type:"string"`

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`

	// 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 

func (s ListJobExecutionsForThingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobExecutionsForThingInput) SetJobId added in v1.42.28 

func (s *ListJobExecutionsForThingInput) SetJobId(v string) *ListJobExecutionsForThingInput

SetJobId sets the JobId field's value.

func (*ListJobExecutionsForThingInput) SetMaxResults added in v1.12.36 

func (s *ListJobExecutionsForThingInput) SetMaxResults(v int64) *ListJobExecutionsForThingInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobExecutionsForThingInput) SetNamespaceId added in v1.35.17 

func (s *ListJobExecutionsForThingInput) SetNamespaceId(v string) *ListJobExecutionsForThingInput

SetNamespaceId sets the NamespaceId field's value.

func (*ListJobExecutionsForThingInput) SetNextToken added in v1.12.36 

func (s *ListJobExecutionsForThingInput) SetNextToken(v string) *ListJobExecutionsForThingInput

SetNextToken sets the NextToken field's value.

func (*ListJobExecutionsForThingInput) SetStatus added in v1.12.36 

func (s *ListJobExecutionsForThingInput) SetStatus(v string) *ListJobExecutionsForThingInput

SetStatus sets the Status field's value.

func (*ListJobExecutionsForThingInput) SetThingName added in v1.12.36 

func (s *ListJobExecutionsForThingInput) SetThingName(v string) *ListJobExecutionsForThingInput

SetThingName sets the ThingName field's value.

func (ListJobExecutionsForThingInput) String added in v1.12.36 

func (s ListJobExecutionsForThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s ListJobExecutionsForThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobExecutionsForThingOutput) SetExecutionSummaries added in v1.12.36 

func (s *ListJobExecutionsForThingOutput) SetExecutionSummaries(v []*JobExecutionSummaryForThing) *ListJobExecutionsForThingOutput

SetExecutionSummaries sets the ExecutionSummaries field's value.

func (*ListJobExecutionsForThingOutput) SetNextToken added in v1.12.36 

func (s *ListJobExecutionsForThingOutput) SetNextToken(v string) *ListJobExecutionsForThingOutput

SetNextToken sets the NextToken field's value.

func (ListJobExecutionsForThingOutput) String added in v1.12.36 

func (s ListJobExecutionsForThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListJobTemplatesInput added in v1.38.47 

type ListJobTemplatesInput struct {

	// The maximum number of results to return in the list.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to use to return the next set of results in the list.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListJobTemplatesInput) GoString added in v1.38.47 

func (s ListJobTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobTemplatesInput) SetMaxResults added in v1.38.47 

func (s *ListJobTemplatesInput) SetMaxResults(v int64) *ListJobTemplatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobTemplatesInput) SetNextToken added in v1.38.47 

func (s *ListJobTemplatesInput) SetNextToken(v string) *ListJobTemplatesInput

SetNextToken sets the NextToken field's value.

func (ListJobTemplatesInput) String added in v1.38.47 

func (s ListJobTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobTemplatesInput) Validate added in v1.38.47 

func (s *ListJobTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobTemplatesOutput added in v1.38.47 

type ListJobTemplatesOutput struct {

	// A list of objects that contain information about the job templates.
	JobTemplates []*JobTemplateSummary `locationName:"jobTemplates" 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 (ListJobTemplatesOutput) GoString added in v1.38.47 

func (s ListJobTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobTemplatesOutput) SetJobTemplates added in v1.38.47 

func (s *ListJobTemplatesOutput) SetJobTemplates(v []*JobTemplateSummary) *ListJobTemplatesOutput

SetJobTemplates sets the JobTemplates field's value.

func (*ListJobTemplatesOutput) SetNextToken added in v1.38.47 

func (s *ListJobTemplatesOutput) SetNextToken(v string) *ListJobTemplatesOutput

SetNextToken sets the NextToken field's value.

func (ListJobTemplatesOutput) String added in v1.38.47 

func (s ListJobTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`

	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobsInput) SetMaxResults added in v1.12.36 

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNamespaceId added in v1.35.17 

func (s *ListJobsInput) SetNamespaceId(v string) *ListJobsInput

SetNamespaceId sets the NamespaceId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListManagedJobTemplatesInput added in v1.42.11 

type ListManagedJobTemplatesInput struct {

	// Maximum number of entries that can be returned.
	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 parameter for template name. If specified, only the versions
	// of the managed job templates that have the specified template name will be
	// returned.
	TemplateName *string `location:"querystring" locationName:"templateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListManagedJobTemplatesInput) GoString added in v1.42.11 

func (s ListManagedJobTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListManagedJobTemplatesInput) SetMaxResults added in v1.42.11 

func (s *ListManagedJobTemplatesInput) SetMaxResults(v int64) *ListManagedJobTemplatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListManagedJobTemplatesInput) SetNextToken added in v1.42.11 

func (s *ListManagedJobTemplatesInput) SetNextToken(v string) *ListManagedJobTemplatesInput

SetNextToken sets the NextToken field's value.

func (*ListManagedJobTemplatesInput) SetTemplateName added in v1.42.11 

func (s *ListManagedJobTemplatesInput) SetTemplateName(v string) *ListManagedJobTemplatesInput

SetTemplateName sets the TemplateName field's value.

func (ListManagedJobTemplatesInput) String added in v1.42.11 

func (s ListManagedJobTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListManagedJobTemplatesInput) Validate added in v1.42.11 

func (s *ListManagedJobTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListManagedJobTemplatesOutput added in v1.42.11 

type ListManagedJobTemplatesOutput struct {

	// A list of managed job templates that are returned.
	ManagedJobTemplates []*ManagedJobTemplateSummary `locationName:"managedJobTemplates" type:"list"`

	// The token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListManagedJobTemplatesOutput) GoString added in v1.42.11 

func (s ListManagedJobTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListManagedJobTemplatesOutput) SetManagedJobTemplates added in v1.42.11 

func (s *ListManagedJobTemplatesOutput) SetManagedJobTemplates(v []*ManagedJobTemplateSummary) *ListManagedJobTemplatesOutput

SetManagedJobTemplates sets the ManagedJobTemplates field's value.

func (*ListManagedJobTemplatesOutput) SetNextToken added in v1.42.11 

func (s *ListManagedJobTemplatesOutput) SetNextToken(v string) *ListManagedJobTemplatesOutput

SetNextToken sets the NextToken field's value.

func (ListManagedJobTemplatesOutput) String added in v1.42.11 

func (s ListManagedJobTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMetricValuesInput added in v1.43.32 

type ListMetricValuesInput struct {

	// The dimension name.
	DimensionName *string `location:"querystring" locationName:"dimensionName" min:"1" type:"string"`

	// The dimension value operator.
	DimensionValueOperator *string `location:"querystring" locationName:"dimensionValueOperator" type:"string" enum:"DimensionValueOperator"`

	// The end of the time period for which metric values are returned.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" required:"true"`

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The name of the security profile metric for which values are returned.
	//
	// MetricName is a required field
	MetricName *string `location:"querystring" locationName:"metricName" type:"string" required:"true"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The start of the time period for which metric values are returned.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" required:"true"`

	// The name of the thing for which security profile metric values are returned.
	//
	// ThingName is a required field
	ThingName *string `location:"querystring" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListMetricValuesInput) GoString added in v1.43.32 

func (s ListMetricValuesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMetricValuesInput) SetDimensionName added in v1.43.32 

func (s *ListMetricValuesInput) SetDimensionName(v string) *ListMetricValuesInput

SetDimensionName sets the DimensionName field's value.

func (*ListMetricValuesInput) SetDimensionValueOperator added in v1.43.32 

func (s *ListMetricValuesInput) SetDimensionValueOperator(v string) *ListMetricValuesInput

SetDimensionValueOperator sets the DimensionValueOperator field's value.

func (*ListMetricValuesInput) SetEndTime added in v1.43.32 

func (s *ListMetricValuesInput) SetEndTime(v time.Time) *ListMetricValuesInput

SetEndTime sets the EndTime field's value.

func (*ListMetricValuesInput) SetMaxResults added in v1.43.32 

func (s *ListMetricValuesInput) SetMaxResults(v int64) *ListMetricValuesInput

SetMaxResults sets the MaxResults field's value.

func (*ListMetricValuesInput) SetMetricName added in v1.43.32 

func (s *ListMetricValuesInput) SetMetricName(v string) *ListMetricValuesInput

SetMetricName sets the MetricName field's value.

func (*ListMetricValuesInput) SetNextToken added in v1.43.32 

func (s *ListMetricValuesInput) SetNextToken(v string) *ListMetricValuesInput

SetNextToken sets the NextToken field's value.

func (*ListMetricValuesInput) SetStartTime added in v1.43.32 

func (s *ListMetricValuesInput) SetStartTime(v time.Time) *ListMetricValuesInput

SetStartTime sets the StartTime field's value.

func (*ListMetricValuesInput) SetThingName added in v1.43.32 

func (s *ListMetricValuesInput) SetThingName(v string) *ListMetricValuesInput

SetThingName sets the ThingName field's value.

func (ListMetricValuesInput) String added in v1.43.32 

func (s ListMetricValuesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMetricValuesInput) Validate added in v1.43.32 

func (s *ListMetricValuesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMetricValuesOutput added in v1.43.32 

type ListMetricValuesOutput struct {

	// The data the thing reports for the metric during the specified time period.
	MetricDatumList []*MetricDatum `locationName:"metricDatumList" type:"list"`

	// A token that can be used to retrieve 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 (ListMetricValuesOutput) GoString added in v1.43.32 

func (s ListMetricValuesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMetricValuesOutput) SetMetricDatumList added in v1.43.32 

func (s *ListMetricValuesOutput) SetMetricDatumList(v []*MetricDatum) *ListMetricValuesOutput

SetMetricDatumList sets the MetricDatumList field's value.

func (*ListMetricValuesOutput) SetNextToken added in v1.43.32 

func (s *ListMetricValuesOutput) SetNextToken(v string) *ListMetricValuesOutput

SetNextToken sets the NextToken field's value.

func (ListMetricValuesOutput) String added in v1.43.32 

func (s ListMetricValuesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMitigationActionsInput added in v1.21.10 

type ListMitigationActionsInput struct {

	// Specify a value to limit the result to mitigation actions with a specific
	// action type.
	ActionType *string `location:"querystring" locationName:"actionType" type:"string" enum:"MitigationActionType"`

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMitigationActionsInput) GoString added in v1.21.10 

func (s ListMitigationActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMitigationActionsInput) SetActionType added in v1.21.10 

func (s *ListMitigationActionsInput) SetActionType(v string) *ListMitigationActionsInput

SetActionType sets the ActionType field's value.

func (*ListMitigationActionsInput) SetMaxResults added in v1.21.10 

func (s *ListMitigationActionsInput) SetMaxResults(v int64) *ListMitigationActionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMitigationActionsInput) SetNextToken added in v1.21.10 

func (s *ListMitigationActionsInput) SetNextToken(v string) *ListMitigationActionsInput

SetNextToken sets the NextToken field's value.

func (ListMitigationActionsInput) String added in v1.21.10 

func (s ListMitigationActionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMitigationActionsInput) Validate added in v1.21.10 

func (s *ListMitigationActionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMitigationActionsOutput added in v1.21.10 

type ListMitigationActionsOutput struct {

	// A set of actions that matched the specified filter criteria.
	ActionIdentifiers []*MitigationActionIdentifier `locationName:"actionIdentifiers" type:"list"`

	// The token for the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMitigationActionsOutput) GoString added in v1.21.10 

func (s ListMitigationActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMitigationActionsOutput) SetActionIdentifiers added in v1.21.10 

func (s *ListMitigationActionsOutput) SetActionIdentifiers(v []*MitigationActionIdentifier) *ListMitigationActionsOutput

SetActionIdentifiers sets the ActionIdentifiers field's value.

func (*ListMitigationActionsOutput) SetNextToken added in v1.21.10 

func (s *ListMitigationActionsOutput) SetNextToken(v string) *ListMitigationActionsOutput

SetNextToken sets the NextToken field's value.

func (ListMitigationActionsOutput) String added in v1.21.10 

func (s ListMitigationActionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListOTAUpdatesOutput) SetOtaUpdates(v []*OTAUpdateSummary) *ListOTAUpdatesOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s ListOutgoingCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListOutgoingCertificatesInput) SetAscendingOrder added in v1.5.0 

func (s *ListOutgoingCertificatesInput) SetAscendingOrder(v bool) *ListOutgoingCertificatesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListOutgoingCertificatesInput) SetMarker added in v1.5.0 

func (s *ListOutgoingCertificatesInput) SetMarker(v string) *ListOutgoingCertificatesInput

SetMarker sets the Marker field's value.

func (*ListOutgoingCertificatesInput) SetPageSize added in v1.5.0 

func (s *ListOutgoingCertificatesInput) SetPageSize(v int64) *ListOutgoingCertificatesInput

SetPageSize sets the PageSize field's value.

func (ListOutgoingCertificatesInput) String added in v1.3.0 

func (s ListOutgoingCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s ListOutgoingCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListOutgoingCertificatesOutput) SetNextMarker added in v1.5.0 

func (s *ListOutgoingCertificatesOutput) SetNextMarker(v string) *ListOutgoingCertificatesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListOutgoingCertificatesOutput) SetOutgoingCertificates added in v1.5.0 

func (s *ListOutgoingCertificatesOutput) SetOutgoingCertificates(v []*OutgoingCertificate) *ListOutgoingCertificatesOutput

SetOutgoingCertificates sets the OutgoingCertificates field's value.

func (ListOutgoingCertificatesOutput) String added in v1.3.0 

func (s ListOutgoingCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListPolicyPrincipalsInput) SetMarker(v string) *ListPolicyPrincipalsInput

SetMarker sets the Marker field's value.

func (*ListPolicyPrincipalsInput) SetPageSize added in v1.5.0 

func (s *ListPolicyPrincipalsInput) SetPageSize(v int64) *ListPolicyPrincipalsInput

SetPageSize sets the PageSize field's value.

func (*ListPolicyPrincipalsInput) SetPolicyName added in v1.5.0 

func (s *ListPolicyPrincipalsInput) SetPolicyName(v string) *ListPolicyPrincipalsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPolicyPrincipalsOutput) SetNextMarker added in v1.5.0 

func (s *ListPolicyPrincipalsOutput) SetNextMarker(v string) *ListPolicyPrincipalsOutput

SetNextMarker sets the NextMarker field's value.

func (*ListPolicyPrincipalsOutput) SetPrincipals added in v1.5.0 

func (s *ListPolicyPrincipalsOutput) SetPrincipals(v []*string) *ListPolicyPrincipalsOutput

SetPrincipals sets the Principals field's value.

func (ListPolicyPrincipalsOutput) String added in v1.1.33 

func (s ListPolicyPrincipalsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPolicyVersionsInput) SetPolicyName added in v1.5.0 

func (s *ListPolicyVersionsInput) SetPolicyName(v string) *ListPolicyVersionsInput

SetPolicyName sets the PolicyName field's value.

func (ListPolicyVersionsInput) String 

func (s ListPolicyVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPolicyVersionsOutput) SetPolicyVersions added in v1.5.0 

func (s *ListPolicyVersionsOutput) SetPolicyVersions(v []*PolicyVersion) *ListPolicyVersionsOutput

SetPolicyVersions sets the PolicyVersions field's value.

func (ListPolicyVersionsOutput) String 

func (s ListPolicyVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
	// thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId
	// (region: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 ListPrincipalPolicies operation.

func (ListPrincipalPoliciesInput) GoString 

func (s ListPrincipalPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPrincipalPoliciesInput) SetAscendingOrder added in v1.5.0 

func (s *ListPrincipalPoliciesInput) SetAscendingOrder(v bool) *ListPrincipalPoliciesInput

SetAscendingOrder sets the AscendingOrder field's value.

func (*ListPrincipalPoliciesInput) SetMarker added in v1.5.0 

func (s *ListPrincipalPoliciesInput) SetMarker(v string) *ListPrincipalPoliciesInput

SetMarker sets the Marker field's value.

func (*ListPrincipalPoliciesInput) SetPageSize added in v1.5.0 

func (s *ListPrincipalPoliciesInput) SetPageSize(v int64) *ListPrincipalPoliciesInput

SetPageSize sets the PageSize field's value.

func (*ListPrincipalPoliciesInput) SetPrincipal added in v1.5.0 

func (s *ListPrincipalPoliciesInput) SetPrincipal(v string) *ListPrincipalPoliciesInput

SetPrincipal sets the Principal field's value.

func (ListPrincipalPoliciesInput) String 

func (s ListPrincipalPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPrincipalPoliciesOutput) SetNextMarker added in v1.5.0 

func (s *ListPrincipalPoliciesOutput) SetNextMarker(v string) *ListPrincipalPoliciesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListPrincipalPoliciesOutput) SetPolicies added in v1.5.0 

func (s *ListPrincipalPoliciesOutput) SetPolicies(v []*Policy) *ListPrincipalPoliciesOutput

SetPolicies sets the Policies field's value.

func (ListPrincipalPoliciesOutput) String 

func (s ListPrincipalPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPrincipalThingsInput) SetMaxResults added in v1.5.0 

func (s *ListPrincipalThingsInput) SetMaxResults(v int64) *ListPrincipalThingsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPrincipalThingsInput) SetNextToken added in v1.5.0 

func (s *ListPrincipalThingsInput) SetNextToken(v string) *ListPrincipalThingsInput

SetNextToken sets the NextToken field's value.

func (*ListPrincipalThingsInput) SetPrincipal added in v1.5.0 

func (s *ListPrincipalThingsInput) SetPrincipal(v string) *ListPrincipalThingsInput

SetPrincipal sets the Principal field's value.

func (ListPrincipalThingsInput) String 

func (s ListPrincipalThingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPrincipalThingsOutput) SetNextToken added in v1.5.0 

func (s *ListPrincipalThingsOutput) SetNextToken(v string) *ListPrincipalThingsOutput

SetNextToken sets the NextToken field's value.

func (*ListPrincipalThingsOutput) SetThings added in v1.5.0 

func (s *ListPrincipalThingsOutput) SetThings(v []*string) *ListPrincipalThingsOutput

SetThings sets the Things field's value.

func (ListPrincipalThingsOutput) String 

func (s ListPrincipalThingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListProvisioningTemplateVersionsInput added in v1.25.42 

type ListProvisioningTemplateVersionsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The name of the fleet provisioning template.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListProvisioningTemplateVersionsInput) GoString added in v1.25.42 

func (s ListProvisioningTemplateVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplateVersionsInput) SetMaxResults added in v1.25.42 

func (s *ListProvisioningTemplateVersionsInput) SetMaxResults(v int64) *ListProvisioningTemplateVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListProvisioningTemplateVersionsInput) SetNextToken added in v1.25.42 

func (s *ListProvisioningTemplateVersionsInput) SetNextToken(v string) *ListProvisioningTemplateVersionsInput

SetNextToken sets the NextToken field's value.

func (*ListProvisioningTemplateVersionsInput) SetTemplateName added in v1.25.42 

func (s *ListProvisioningTemplateVersionsInput) SetTemplateName(v string) *ListProvisioningTemplateVersionsInput

SetTemplateName sets the TemplateName field's value.

func (ListProvisioningTemplateVersionsInput) String added in v1.25.42 

func (s ListProvisioningTemplateVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplateVersionsInput) Validate added in v1.25.42 

func (s *ListProvisioningTemplateVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProvisioningTemplateVersionsOutput added in v1.25.42 

type ListProvisioningTemplateVersionsOutput struct {

	// A token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of fleet provisioning template versions.
	Versions []*ProvisioningTemplateVersionSummary `locationName:"versions" type:"list"`
	// contains filtered or unexported fields
}

func (ListProvisioningTemplateVersionsOutput) GoString added in v1.25.42 

func (s ListProvisioningTemplateVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplateVersionsOutput) SetNextToken added in v1.25.42 

func (s *ListProvisioningTemplateVersionsOutput) SetNextToken(v string) *ListProvisioningTemplateVersionsOutput

SetNextToken sets the NextToken field's value.

func (*ListProvisioningTemplateVersionsOutput) SetVersions added in v1.25.42 

func (s *ListProvisioningTemplateVersionsOutput) SetVersions(v []*ProvisioningTemplateVersionSummary) *ListProvisioningTemplateVersionsOutput

SetVersions sets the Versions field's value.

func (ListProvisioningTemplateVersionsOutput) String added in v1.25.42 

func (s ListProvisioningTemplateVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListProvisioningTemplatesInput added in v1.25.42 

type ListProvisioningTemplatesInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListProvisioningTemplatesInput) GoString added in v1.25.42 

func (s ListProvisioningTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplatesInput) SetMaxResults added in v1.25.42 

func (s *ListProvisioningTemplatesInput) SetMaxResults(v int64) *ListProvisioningTemplatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListProvisioningTemplatesInput) SetNextToken added in v1.25.42 

func (s *ListProvisioningTemplatesInput) SetNextToken(v string) *ListProvisioningTemplatesInput

SetNextToken sets the NextToken field's value.

func (ListProvisioningTemplatesInput) String added in v1.25.42 

func (s ListProvisioningTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplatesInput) Validate added in v1.25.42 

func (s *ListProvisioningTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProvisioningTemplatesOutput added in v1.25.42 

type ListProvisioningTemplatesOutput struct {

	// A token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of fleet provisioning templates
	Templates []*ProvisioningTemplateSummary `locationName:"templates" type:"list"`
	// contains filtered or unexported fields
}

func (ListProvisioningTemplatesOutput) GoString added in v1.25.42 

func (s ListProvisioningTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProvisioningTemplatesOutput) SetNextToken added in v1.25.42 

func (s *ListProvisioningTemplatesOutput) SetNextToken(v string) *ListProvisioningTemplatesOutput

SetNextToken sets the NextToken field's value.

func (*ListProvisioningTemplatesOutput) SetTemplates added in v1.25.42 

func (s *ListProvisioningTemplatesOutput) SetTemplates(v []*ProvisioningTemplateSummary) *ListProvisioningTemplatesOutput

SetTemplates sets the Templates field's value.

func (ListProvisioningTemplatesOutput) String added in v1.25.42 

func (s ListProvisioningTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListRoleAliasesInput) SetMarker(v string) *ListRoleAliasesInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScheduledAuditsInput added in v1.15.2 

type ListScheduledAuditsInput struct {

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListScheduledAuditsInput) GoString added in v1.15.2 

func (s ListScheduledAuditsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledAuditsInput) SetMaxResults added in v1.15.2 

func (s *ListScheduledAuditsInput) SetMaxResults(v int64) *ListScheduledAuditsInput

SetMaxResults sets the MaxResults field's value.

func (*ListScheduledAuditsInput) SetNextToken added in v1.15.2 

func (s *ListScheduledAuditsInput) SetNextToken(v string) *ListScheduledAuditsInput

SetNextToken sets the NextToken field's value.

func (ListScheduledAuditsInput) String added in v1.15.2 

func (s ListScheduledAuditsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledAuditsInput) Validate added in v1.15.2 

func (s *ListScheduledAuditsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListScheduledAuditsOutput added in v1.15.2 

type ListScheduledAuditsOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of scheduled audits.
	ScheduledAudits []*ScheduledAuditMetadata `locationName:"scheduledAudits" type:"list"`
	// contains filtered or unexported fields
}

func (ListScheduledAuditsOutput) GoString added in v1.15.2 

func (s ListScheduledAuditsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledAuditsOutput) SetNextToken added in v1.15.2 

func (s *ListScheduledAuditsOutput) SetNextToken(v string) *ListScheduledAuditsOutput

SetNextToken sets the NextToken field's value.

func (*ListScheduledAuditsOutput) SetScheduledAudits added in v1.15.2 

func (s *ListScheduledAuditsOutput) SetScheduledAudits(v []*ScheduledAuditMetadata) *ListScheduledAuditsOutput

SetScheduledAudits sets the ScheduledAudits field's value.

func (ListScheduledAuditsOutput) String added in v1.15.2 

func (s ListScheduledAuditsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSecurityProfilesForTargetInput added in v1.15.2 

type ListSecurityProfilesForTargetInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// If true, return child groups too.
	Recursive *bool `location:"querystring" locationName:"recursive" type:"boolean"`

	// The ARN of the target (thing group) whose attached security profiles you
	// want to get.
	//
	// SecurityProfileTargetArn is a required field
	SecurityProfileTargetArn *string `location:"querystring" locationName:"securityProfileTargetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesForTargetInput) GoString added in v1.15.2 

func (s ListSecurityProfilesForTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesForTargetInput) SetMaxResults added in v1.15.2 

func (s *ListSecurityProfilesForTargetInput) SetMaxResults(v int64) *ListSecurityProfilesForTargetInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityProfilesForTargetInput) SetNextToken added in v1.15.2 

func (s *ListSecurityProfilesForTargetInput) SetNextToken(v string) *ListSecurityProfilesForTargetInput

SetNextToken sets the NextToken field's value.

func (*ListSecurityProfilesForTargetInput) SetRecursive added in v1.15.2 

func (s *ListSecurityProfilesForTargetInput) SetRecursive(v bool) *ListSecurityProfilesForTargetInput

SetRecursive sets the Recursive field's value.

func (*ListSecurityProfilesForTargetInput) SetSecurityProfileTargetArn added in v1.15.2 

func (s *ListSecurityProfilesForTargetInput) SetSecurityProfileTargetArn(v string) *ListSecurityProfilesForTargetInput

SetSecurityProfileTargetArn sets the SecurityProfileTargetArn field's value.

func (ListSecurityProfilesForTargetInput) String added in v1.15.2 

func (s ListSecurityProfilesForTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesForTargetInput) Validate added in v1.15.2 

func (s *ListSecurityProfilesForTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSecurityProfilesForTargetOutput added in v1.15.2 

type ListSecurityProfilesForTargetOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of security profiles and their associated targets.
	SecurityProfileTargetMappings []*SecurityProfileTargetMapping `locationName:"securityProfileTargetMappings" type:"list"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesForTargetOutput) GoString added in v1.15.2 

func (s ListSecurityProfilesForTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesForTargetOutput) SetNextToken added in v1.15.2 

func (s *ListSecurityProfilesForTargetOutput) SetNextToken(v string) *ListSecurityProfilesForTargetOutput

SetNextToken sets the NextToken field's value.

func (*ListSecurityProfilesForTargetOutput) SetSecurityProfileTargetMappings added in v1.15.2 

func (s *ListSecurityProfilesForTargetOutput) SetSecurityProfileTargetMappings(v []*SecurityProfileTargetMapping) *ListSecurityProfilesForTargetOutput

SetSecurityProfileTargetMappings sets the SecurityProfileTargetMappings field's value.

func (ListSecurityProfilesForTargetOutput) String added in v1.15.2 

func (s ListSecurityProfilesForTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSecurityProfilesInput added in v1.15.2 

type ListSecurityProfilesInput struct {

	// A filter to limit results to the security profiles that use the defined dimension.
	// Cannot be used with metricName
	DimensionName *string `location:"querystring" locationName:"dimensionName" min:"1" type:"string"`

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The name of the custom metric. Cannot be used with dimensionName.
	MetricName *string `location:"querystring" locationName:"metricName" min:"1" type:"string"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesInput) GoString added in v1.15.2 

func (s ListSecurityProfilesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesInput) SetDimensionName added in v1.30.2 

func (s *ListSecurityProfilesInput) SetDimensionName(v string) *ListSecurityProfilesInput

SetDimensionName sets the DimensionName field's value.

func (*ListSecurityProfilesInput) SetMaxResults added in v1.15.2 

func (s *ListSecurityProfilesInput) SetMaxResults(v int64) *ListSecurityProfilesInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityProfilesInput) SetMetricName added in v1.36.9 

func (s *ListSecurityProfilesInput) SetMetricName(v string) *ListSecurityProfilesInput

SetMetricName sets the MetricName field's value.

func (*ListSecurityProfilesInput) SetNextToken added in v1.15.2 

func (s *ListSecurityProfilesInput) SetNextToken(v string) *ListSecurityProfilesInput

SetNextToken sets the NextToken field's value.

func (ListSecurityProfilesInput) String added in v1.15.2 

func (s ListSecurityProfilesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesInput) Validate added in v1.15.2 

func (s *ListSecurityProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSecurityProfilesOutput added in v1.15.2 

type ListSecurityProfilesOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of security profile identifiers (names and ARNs).
	SecurityProfileIdentifiers []*SecurityProfileIdentifier `locationName:"securityProfileIdentifiers" type:"list"`
	// contains filtered or unexported fields
}

func (ListSecurityProfilesOutput) GoString added in v1.15.2 

func (s ListSecurityProfilesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityProfilesOutput) SetNextToken added in v1.15.2 

func (s *ListSecurityProfilesOutput) SetNextToken(v string) *ListSecurityProfilesOutput

SetNextToken sets the NextToken field's value.

func (*ListSecurityProfilesOutput) SetSecurityProfileIdentifiers added in v1.15.2 

func (s *ListSecurityProfilesOutput) SetSecurityProfileIdentifiers(v []*SecurityProfileIdentifier) *ListSecurityProfilesOutput

SetSecurityProfileIdentifiers sets the SecurityProfileIdentifiers field's value.

func (ListSecurityProfilesOutput) String added in v1.15.2 

func (s ListSecurityProfilesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.15.79 

type ListTagsForResourceInput struct {

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.15.79 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetNextToken added in v1.15.79 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn added in v1.15.79 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.15.79 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.15.79 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.15.79 

type ListTagsForResourceOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of tags assigned to the resource.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.15.79 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken added in v1.15.79 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.15.79 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.15.79 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsForPolicyInput) SetMarker added in v1.12.36 

func (s *ListTargetsForPolicyInput) SetMarker(v string) *ListTargetsForPolicyInput

SetMarker sets the Marker field's value.

func (*ListTargetsForPolicyInput) SetPageSize added in v1.12.36 

func (s *ListTargetsForPolicyInput) SetPageSize(v int64) *ListTargetsForPolicyInput

SetPageSize sets the PageSize field's value.

func (*ListTargetsForPolicyInput) SetPolicyName added in v1.12.36 

func (s *ListTargetsForPolicyInput) SetPolicyName(v string) *ListTargetsForPolicyInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsForPolicyOutput) SetNextMarker added in v1.12.36 

func (s *ListTargetsForPolicyOutput) SetNextMarker(v string) *ListTargetsForPolicyOutput

SetNextMarker sets the NextMarker field's value.

func (*ListTargetsForPolicyOutput) SetTargets added in v1.12.36 

func (s *ListTargetsForPolicyOutput) SetTargets(v []*string) *ListTargetsForPolicyOutput

SetTargets sets the Targets field's value.

func (ListTargetsForPolicyOutput) String added in v1.12.36 

func (s ListTargetsForPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTargetsForSecurityProfileInput added in v1.15.2 

type ListTargetsForSecurityProfileInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The security profile.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTargetsForSecurityProfileInput) GoString added in v1.15.2 

func (s ListTargetsForSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsForSecurityProfileInput) SetMaxResults added in v1.15.2 

func (s *ListTargetsForSecurityProfileInput) SetMaxResults(v int64) *ListTargetsForSecurityProfileInput

SetMaxResults sets the MaxResults field's value.

func (*ListTargetsForSecurityProfileInput) SetNextToken added in v1.15.2 

func (s *ListTargetsForSecurityProfileInput) SetNextToken(v string) *ListTargetsForSecurityProfileInput

SetNextToken sets the NextToken field's value.

func (*ListTargetsForSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *ListTargetsForSecurityProfileInput) SetSecurityProfileName(v string) *ListTargetsForSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (ListTargetsForSecurityProfileInput) String added in v1.15.2 

func (s ListTargetsForSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsForSecurityProfileInput) Validate added in v1.15.2 

func (s *ListTargetsForSecurityProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTargetsForSecurityProfileOutput added in v1.15.2 

type ListTargetsForSecurityProfileOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The thing groups to which the security profile is attached.
	SecurityProfileTargets []*SecurityProfileTarget `locationName:"securityProfileTargets" type:"list"`
	// contains filtered or unexported fields
}

func (ListTargetsForSecurityProfileOutput) GoString added in v1.15.2 

func (s ListTargetsForSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsForSecurityProfileOutput) SetNextToken added in v1.15.2 

func (s *ListTargetsForSecurityProfileOutput) SetNextToken(v string) *ListTargetsForSecurityProfileOutput

SetNextToken sets the NextToken field's value.

func (*ListTargetsForSecurityProfileOutput) SetSecurityProfileTargets added in v1.15.2 

func (s *ListTargetsForSecurityProfileOutput) SetSecurityProfileTargets(v []*SecurityProfileTarget) *ListTargetsForSecurityProfileOutput

SetSecurityProfileTargets sets the SecurityProfileTargets field's value.

func (ListTargetsForSecurityProfileOutput) String added in v1.15.2 

func (s ListTargetsForSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingGroupsForThingInput) SetMaxResults added in v1.12.36 

func (s *ListThingGroupsForThingInput) SetMaxResults(v int64) *ListThingGroupsForThingInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingGroupsForThingInput) SetNextToken added in v1.12.36 

func (s *ListThingGroupsForThingInput) SetNextToken(v string) *ListThingGroupsForThingInput

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsForThingInput) SetThingName added in v1.12.36 

func (s *ListThingGroupsForThingInput) SetThingName(v string) *ListThingGroupsForThingInput

SetThingName sets the ThingName field's value.

func (ListThingGroupsForThingInput) String added in v1.12.36 

func (s ListThingGroupsForThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use 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 

func (s ListThingGroupsForThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingGroupsForThingOutput) SetNextToken added in v1.12.36 

func (s *ListThingGroupsForThingOutput) SetNextToken(v string) *ListThingGroupsForThingOutput

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsForThingOutput) SetThingGroups added in v1.12.36 

func (s *ListThingGroupsForThingOutput) SetThingGroups(v []*GroupNameAndArn) *ListThingGroupsForThingOutput

SetThingGroups sets the ThingGroups field's value.

func (ListThingGroupsForThingOutput) String added in v1.12.36 

func (s ListThingGroupsForThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use to get the next set of results. Will not be returned if
	// operation has returned all 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingGroupsOutput) SetNextToken added in v1.12.36 

func (s *ListThingGroupsOutput) SetNextToken(v string) *ListThingGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListThingGroupsOutput) SetThingGroups added in v1.12.36 

func (s *ListThingGroupsOutput) SetThingGroups(v []*GroupNameAndArn) *ListThingGroupsOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListThingPrincipalsInput 

type ListThingPrincipalsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingPrincipalsInput) SetMaxResults added in v1.35.21 

func (s *ListThingPrincipalsInput) SetMaxResults(v int64) *ListThingPrincipalsInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingPrincipalsInput) SetNextToken added in v1.35.21 

func (s *ListThingPrincipalsInput) SetNextToken(v string) *ListThingPrincipalsInput

SetNextToken sets the NextToken field's value.

func (*ListThingPrincipalsInput) SetThingName added in v1.5.0 

func (s *ListThingPrincipalsInput) SetThingName(v string) *ListThingPrincipalsInput

SetThingName sets the ThingName field's value.

func (ListThingPrincipalsInput) String 

func (s ListThingPrincipalsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingPrincipalsOutput) SetNextToken added in v1.35.21 

func (s *ListThingPrincipalsOutput) SetNextToken(v string) *ListThingPrincipalsOutput

SetNextToken sets the NextToken field's value.

func (*ListThingPrincipalsOutput) SetPrincipals added in v1.5.0 

func (s *ListThingPrincipalsOutput) SetPrincipals(v []*string) *ListThingPrincipalsOutput

SetPrincipals sets the Principals field's value.

func (ListThingPrincipalsOutput) String 

func (s ListThingPrincipalsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first 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 

func (s ListThingRegistrationTaskReportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingRegistrationTaskReportsInput) SetMaxResults added in v1.12.36 

func (s *ListThingRegistrationTaskReportsInput) SetMaxResults(v int64) *ListThingRegistrationTaskReportsInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingRegistrationTaskReportsInput) SetNextToken added in v1.12.36 

func (s *ListThingRegistrationTaskReportsInput) SetNextToken(v string) *ListThingRegistrationTaskReportsInput

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTaskReportsInput) SetReportType added in v1.12.36 

func (s *ListThingRegistrationTaskReportsInput) SetReportType(v string) *ListThingRegistrationTaskReportsInput

SetReportType sets the ReportType field's value.

func (*ListThingRegistrationTaskReportsInput) SetTaskId added in v1.12.36 

func (s *ListThingRegistrationTaskReportsInput) SetTaskId(v string) *ListThingRegistrationTaskReportsInput

SetTaskId sets the TaskId field's value.

func (ListThingRegistrationTaskReportsInput) String added in v1.12.36 

func (s ListThingRegistrationTaskReportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingRegistrationTaskReportsInput) Validate added in v1.12.36 

func (s *ListThingRegistrationTaskReportsInput) Validate() error

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 use to get the next set of results, or null if there are no
	// additional 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 

func (s ListThingRegistrationTaskReportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingRegistrationTaskReportsOutput) SetNextToken added in v1.12.36 

func (s *ListThingRegistrationTaskReportsOutput) SetNextToken(v string) *ListThingRegistrationTaskReportsOutput

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTaskReportsOutput) SetReportType added in v1.12.36 

func (s *ListThingRegistrationTaskReportsOutput) SetReportType(v string) *ListThingRegistrationTaskReportsOutput

SetReportType sets the ReportType field's value. 

func (s *ListThingRegistrationTaskReportsOutput) SetResourceLinks(v []*string) *ListThingRegistrationTaskReportsOutput

SetResourceLinks sets the ResourceLinks field's value.

func (ListThingRegistrationTaskReportsOutput) String added in v1.12.36 

func (s ListThingRegistrationTaskReportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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 

func (s ListThingRegistrationTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingRegistrationTasksInput) SetMaxResults added in v1.12.36 

func (s *ListThingRegistrationTasksInput) SetMaxResults(v int64) *ListThingRegistrationTasksInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingRegistrationTasksInput) SetNextToken added in v1.12.36 

func (s *ListThingRegistrationTasksInput) SetNextToken(v string) *ListThingRegistrationTasksInput

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTasksInput) SetStatus added in v1.12.36 

func (s *ListThingRegistrationTasksInput) SetStatus(v string) *ListThingRegistrationTasksInput

SetStatus sets the Status field's value.

func (ListThingRegistrationTasksInput) String added in v1.12.36 

func (s ListThingRegistrationTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use 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 

func (s ListThingRegistrationTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingRegistrationTasksOutput) SetNextToken added in v1.12.36 

func (s *ListThingRegistrationTasksOutput) SetNextToken(v string) *ListThingRegistrationTasksOutput

SetNextToken sets the NextToken field's value.

func (*ListThingRegistrationTasksOutput) SetTaskIds added in v1.12.36 

func (s *ListThingRegistrationTasksOutput) SetTaskIds(v []*string) *ListThingRegistrationTasksOutput

SetTaskIds sets the TaskIds field's value.

func (ListThingRegistrationTasksOutput) String added in v1.12.36 

func (s ListThingRegistrationTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Will not be returned if operation
	// has returned all 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListThingTypesOutput) SetThingTypes(v []*ThingTypeDefinition) *ListThingTypesOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListThingsInBillingGroupInput added in v1.15.79 

type ListThingsInBillingGroupInput struct {

	// The name of the billing group.
	//
	// BillingGroupName is a required field
	BillingGroupName *string `location:"uri" locationName:"billingGroupName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListThingsInBillingGroupInput) GoString added in v1.15.79 

func (s ListThingsInBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingsInBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *ListThingsInBillingGroupInput) SetBillingGroupName(v string) *ListThingsInBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*ListThingsInBillingGroupInput) SetMaxResults added in v1.15.79 

func (s *ListThingsInBillingGroupInput) SetMaxResults(v int64) *ListThingsInBillingGroupInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingsInBillingGroupInput) SetNextToken added in v1.15.79 

func (s *ListThingsInBillingGroupInput) SetNextToken(v string) *ListThingsInBillingGroupInput

SetNextToken sets the NextToken field's value.

func (ListThingsInBillingGroupInput) String added in v1.15.79 

func (s ListThingsInBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingsInBillingGroupInput) Validate added in v1.15.79 

func (s *ListThingsInBillingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListThingsInBillingGroupOutput added in v1.15.79 

type ListThingsInBillingGroupOutput struct {

	// The token to use to get the next set of results. Will not be returned if
	// operation has returned all results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of things in the billing group.
	Things []*string `locationName:"things" type:"list"`
	// contains filtered or unexported fields
}

func (ListThingsInBillingGroupOutput) GoString added in v1.15.79 

func (s ListThingsInBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingsInBillingGroupOutput) SetNextToken added in v1.15.79 

func (s *ListThingsInBillingGroupOutput) SetNextToken(v string) *ListThingsInBillingGroupOutput

SetNextToken sets the NextToken field's value.

func (*ListThingsInBillingGroupOutput) SetThings added in v1.15.79 

func (s *ListThingsInBillingGroupOutput) SetThings(v []*string) *ListThingsInBillingGroupOutput

SetThings sets the Things field's value.

func (ListThingsInBillingGroupOutput) String added in v1.15.79 

func (s ListThingsInBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingsInThingGroupInput) SetMaxResults added in v1.12.36 

func (s *ListThingsInThingGroupInput) SetMaxResults(v int64) *ListThingsInThingGroupInput

SetMaxResults sets the MaxResults field's value.

func (*ListThingsInThingGroupInput) SetNextToken added in v1.12.36 

func (s *ListThingsInThingGroupInput) SetNextToken(v string) *ListThingsInThingGroupInput

SetNextToken sets the NextToken field's value.

func (*ListThingsInThingGroupInput) SetRecursive added in v1.12.36 

func (s *ListThingsInThingGroupInput) SetRecursive(v bool) *ListThingsInThingGroupInput

SetRecursive sets the Recursive field's value.

func (*ListThingsInThingGroupInput) SetThingGroupName added in v1.12.36 

func (s *ListThingsInThingGroupInput) SetThingGroupName(v string) *ListThingsInThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (ListThingsInThingGroupInput) String added in v1.12.36 

func (s ListThingsInThingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThingsInThingGroupOutput) SetNextToken added in v1.12.36 

func (s *ListThingsInThingGroupOutput) SetNextToken(v string) *ListThingsInThingGroupOutput

SetNextToken sets the NextToken field's value.

func (*ListThingsInThingGroupOutput) SetThings added in v1.12.36 

func (s *ListThingsInThingGroupOutput) SetThings(v []*string) *ListThingsInThingGroupOutput

SetThings sets the Things field's value.

func (ListThingsInThingGroupOutput) String added in v1.12.36 

func (s ListThingsInThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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"`

	// When true, the action returns the thing resources with attribute values that
	// start with the attributeValue provided.
	//
	// When false, or not present, the action returns only the thing resources with
	// attribute values that match the entire attributeValue provided.
	UsePrefixAttributeValue *bool `location:"querystring" locationName:"usePrefixAttributeValue" type:"boolean"`
	// contains filtered or unexported fields
}

The input for the ListThings operation.

func (ListThingsInput) GoString 

func (s ListThingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetUsePrefixAttributeValue added in v1.38.10 

func (s *ListThingsInput) SetUsePrefixAttributeValue(v bool) *ListThingsInput

SetUsePrefixAttributeValue sets the UsePrefixAttributeValue field's value.

func (ListThingsInput) String 

func (s ListThingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use to get the next set of results. Will not be returned if
	// operation has returned all 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTopicRuleDestinationsInput added in v1.25.38 

type ListTopicRuleDestinationsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListTopicRuleDestinationsInput) GoString added in v1.25.38 

func (s ListTopicRuleDestinationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicRuleDestinationsInput) SetMaxResults added in v1.25.38 

func (s *ListTopicRuleDestinationsInput) SetMaxResults(v int64) *ListTopicRuleDestinationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTopicRuleDestinationsInput) SetNextToken added in v1.25.38 

func (s *ListTopicRuleDestinationsInput) SetNextToken(v string) *ListTopicRuleDestinationsInput

SetNextToken sets the NextToken field's value.

func (ListTopicRuleDestinationsInput) String added in v1.25.38 

func (s ListTopicRuleDestinationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicRuleDestinationsInput) Validate added in v1.25.38 

func (s *ListTopicRuleDestinationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTopicRuleDestinationsOutput added in v1.25.38 

type ListTopicRuleDestinationsOutput struct {

	// Information about a topic rule destination.
	DestinationSummaries []*TopicRuleDestinationSummary `locationName:"destinationSummaries" type:"list"`

	// The token to use 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 (ListTopicRuleDestinationsOutput) GoString added in v1.25.38 

func (s ListTopicRuleDestinationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicRuleDestinationsOutput) SetDestinationSummaries added in v1.25.38 

func (s *ListTopicRuleDestinationsOutput) SetDestinationSummaries(v []*TopicRuleDestinationSummary) *ListTopicRuleDestinationsOutput

SetDestinationSummaries sets the DestinationSummaries field's value.

func (*ListTopicRuleDestinationsOutput) SetNextToken added in v1.25.38 

func (s *ListTopicRuleDestinationsOutput) SetNextToken(v string) *ListTopicRuleDestinationsOutput

SetNextToken sets the NextToken field's value.

func (ListTopicRuleDestinationsOutput) String added in v1.25.38 

func (s ListTopicRuleDestinationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTopicRulesInput 

type ListTopicRulesInput struct {

	// The maximum number of results to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListTopicRulesInput) SetTopic(v string) *ListTopicRulesInput

SetTopic sets the Topic field's value.

func (ListTopicRulesInput) String 

func (s ListTopicRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListTopicRulesOutput) SetRules(v []*TopicRuleListItem) *ListTopicRulesOutput

SetRules sets the Rules field's value.

func (ListTopicRulesOutput) String 

func (s ListTopicRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListV2LoggingLevelsInput) SetMaxResults added in v1.12.36 

func (s *ListV2LoggingLevelsInput) SetMaxResults(v int64) *ListV2LoggingLevelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListV2LoggingLevelsInput) SetNextToken added in v1.12.36 

func (s *ListV2LoggingLevelsInput) SetNextToken(v string) *ListV2LoggingLevelsInput

SetNextToken sets the NextToken field's value.

func (*ListV2LoggingLevelsInput) SetTargetType added in v1.12.36 

func (s *ListV2LoggingLevelsInput) SetTargetType(v string) *ListV2LoggingLevelsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to use 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *ListV2LoggingLevelsOutput) SetNextToken(v string) *ListV2LoggingLevelsOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListViolationEventsInput added in v1.15.2 

type ListViolationEventsInput struct {

	// The criteria for a behavior.
	BehaviorCriteriaType *string `location:"querystring" locationName:"behaviorCriteriaType" type:"string" enum:"BehaviorCriteriaType"`

	// The end time for the alerts to be listed.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" required:"true"`

	// A list of all suppressed alerts.
	ListSuppressedAlerts *bool `location:"querystring" locationName:"listSuppressedAlerts" type:"boolean"`

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// A filter to limit results to those alerts generated by the specified security
	// profile.
	SecurityProfileName *string `location:"querystring" locationName:"securityProfileName" min:"1" type:"string"`

	// The start time for the alerts to be listed.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" required:"true"`

	// A filter to limit results to those alerts caused by the specified thing.
	ThingName *string `location:"querystring" locationName:"thingName" min:"1" type:"string"`

	// The verification state of the violation (detect alarm).
	VerificationState *string `location:"querystring" locationName:"verificationState" type:"string" enum:"VerificationState"`
	// contains filtered or unexported fields
}

func (ListViolationEventsInput) GoString added in v1.15.2 

func (s ListViolationEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViolationEventsInput) SetBehaviorCriteriaType added in v1.36.9 

func (s *ListViolationEventsInput) SetBehaviorCriteriaType(v string) *ListViolationEventsInput

SetBehaviorCriteriaType sets the BehaviorCriteriaType field's value.

func (*ListViolationEventsInput) SetEndTime added in v1.15.2 

func (s *ListViolationEventsInput) SetEndTime(v time.Time) *ListViolationEventsInput

SetEndTime sets the EndTime field's value.

func (*ListViolationEventsInput) SetListSuppressedAlerts added in v1.36.9 

func (s *ListViolationEventsInput) SetListSuppressedAlerts(v bool) *ListViolationEventsInput

SetListSuppressedAlerts sets the ListSuppressedAlerts field's value.

func (*ListViolationEventsInput) SetMaxResults added in v1.15.2 

func (s *ListViolationEventsInput) SetMaxResults(v int64) *ListViolationEventsInput

SetMaxResults sets the MaxResults field's value.

func (*ListViolationEventsInput) SetNextToken added in v1.15.2 

func (s *ListViolationEventsInput) SetNextToken(v string) *ListViolationEventsInput

SetNextToken sets the NextToken field's value.

func (*ListViolationEventsInput) SetSecurityProfileName added in v1.15.2 

func (s *ListViolationEventsInput) SetSecurityProfileName(v string) *ListViolationEventsInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*ListViolationEventsInput) SetStartTime added in v1.15.2 

func (s *ListViolationEventsInput) SetStartTime(v time.Time) *ListViolationEventsInput

SetStartTime sets the StartTime field's value.

func (*ListViolationEventsInput) SetThingName added in v1.15.2 

func (s *ListViolationEventsInput) SetThingName(v string) *ListViolationEventsInput

SetThingName sets the ThingName field's value.

func (*ListViolationEventsInput) SetVerificationState added in v1.40.46 

func (s *ListViolationEventsInput) SetVerificationState(v string) *ListViolationEventsInput

SetVerificationState sets the VerificationState field's value.

func (ListViolationEventsInput) String added in v1.15.2 

func (s ListViolationEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViolationEventsInput) Validate added in v1.15.2 

func (s *ListViolationEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListViolationEventsOutput added in v1.15.2 

type ListViolationEventsOutput struct {

	// A token that can be used to retrieve the next set of results, or null if
	// there are no additional results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The security profile violation alerts issued for this account during the
	// given time period, potentially filtered by security profile, behavior violated,
	// or thing (device) violating.
	ViolationEvents []*ViolationEvent `locationName:"violationEvents" type:"list"`
	// contains filtered or unexported fields
}

func (ListViolationEventsOutput) GoString added in v1.15.2 

func (s ListViolationEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViolationEventsOutput) SetNextToken added in v1.15.2 

func (s *ListViolationEventsOutput) SetNextToken(v string) *ListViolationEventsOutput

SetNextToken sets the NextToken field's value.

func (*ListViolationEventsOutput) SetViolationEvents added in v1.15.2 

func (s *ListViolationEventsOutput) SetViolationEvents(v []*ViolationEvent) *ListViolationEventsOutput

SetViolationEvents sets the ViolationEvents field's value.

func (ListViolationEventsOutput) String added in v1.15.2 

func (s ListViolationEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogTargetConfiguration) SetLogLevel added in v1.12.36 

func (s *LogTargetConfiguration) SetLogLevel(v string) *LogTargetConfiguration

SetLogLevel sets the LogLevel field's value.

func (*LogTargetConfiguration) SetLogTarget added in v1.12.36 

func (s *LogTargetConfiguration) SetLogTarget(v *LogTarget) *LogTargetConfiguration

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingOptionsPayload) SetLogLevel added in v1.5.0 

func (s *LoggingOptionsPayload) SetLogLevel(v string) *LoggingOptionsPayload

SetLogLevel sets the LogLevel field's value.

func (*LoggingOptionsPayload) SetRoleArn added in v1.5.0 

func (s *LoggingOptionsPayload) SetRoleArn(v string) *LoggingOptionsPayload

SetRoleArn sets the RoleArn field's value.

func (LoggingOptionsPayload) String 

func (s LoggingOptionsPayload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 MachineLearningDetectionConfig added in v1.36.9 

type MachineLearningDetectionConfig struct {

	// The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or
	// High.
	//
	// ConfidenceLevel is a required field
	ConfidenceLevel *string `locationName:"confidenceLevel" type:"string" required:"true" enum:"ConfidenceLevel"`
	// contains filtered or unexported fields
}

The configuration of an ML Detect Security Profile.

func (MachineLearningDetectionConfig) GoString added in v1.36.9 

func (s MachineLearningDetectionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MachineLearningDetectionConfig) SetConfidenceLevel added in v1.36.9 

func (s *MachineLearningDetectionConfig) SetConfidenceLevel(v string) *MachineLearningDetectionConfig

SetConfidenceLevel sets the ConfidenceLevel field's value.

func (MachineLearningDetectionConfig) String added in v1.36.9 

func (s MachineLearningDetectionConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MachineLearningDetectionConfig) Validate added in v1.36.9 

func (s *MachineLearningDetectionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MalformedPolicyException added in v1.28.0 

type MalformedPolicyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The policy documentation is not valid.

func (*MalformedPolicyException) Code added in v1.28.0 

func (s *MalformedPolicyException) Code() string

Code returns the exception type name.

func (*MalformedPolicyException) Error added in v1.28.0 

func (s *MalformedPolicyException) Error() string

func (MalformedPolicyException) GoString added in v1.28.0 

func (s MalformedPolicyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MalformedPolicyException) Message added in v1.28.0 

func (s *MalformedPolicyException) Message() string

Message returns the exception's message.

func (*MalformedPolicyException) OrigErr added in v1.28.0 

func (s *MalformedPolicyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MalformedPolicyException) RequestID added in v1.28.0 

func (s *MalformedPolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MalformedPolicyException) StatusCode added in v1.28.0 

func (s *MalformedPolicyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MalformedPolicyException) String added in v1.28.0 

func (s MalformedPolicyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ManagedJobTemplateSummary added in v1.42.11 

type ManagedJobTemplateSummary struct {

	// The description for a managed template.
	Description *string `locationName:"description" type:"string"`

	// A list of environments that are supported with the managed job template.
	Environments []*string `locationName:"environments" type:"list"`

	// The Amazon Resource Name (ARN) for a managed template.
	TemplateArn *string `locationName:"templateArn" min:"1" type:"string"`

	// The unique Name for a managed template.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`

	// The version for a managed template.
	TemplateVersion *string `locationName:"templateVersion" type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about the managed template.

func (ManagedJobTemplateSummary) GoString added in v1.42.11 

func (s ManagedJobTemplateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedJobTemplateSummary) SetDescription added in v1.42.11 

func (s *ManagedJobTemplateSummary) SetDescription(v string) *ManagedJobTemplateSummary

SetDescription sets the Description field's value.

func (*ManagedJobTemplateSummary) SetEnvironments added in v1.42.11 

func (s *ManagedJobTemplateSummary) SetEnvironments(v []*string) *ManagedJobTemplateSummary

SetEnvironments sets the Environments field's value.

func (*ManagedJobTemplateSummary) SetTemplateArn added in v1.42.11 

func (s *ManagedJobTemplateSummary) SetTemplateArn(v string) *ManagedJobTemplateSummary

SetTemplateArn sets the TemplateArn field's value.

func (*ManagedJobTemplateSummary) SetTemplateName added in v1.42.11 

func (s *ManagedJobTemplateSummary) SetTemplateName(v string) *ManagedJobTemplateSummary

SetTemplateName sets the TemplateName field's value.

func (*ManagedJobTemplateSummary) SetTemplateVersion added in v1.42.11 

func (s *ManagedJobTemplateSummary) SetTemplateVersion(v string) *ManagedJobTemplateSummary

SetTemplateVersion sets the TemplateVersion field's value.

func (ManagedJobTemplateSummary) String added in v1.42.11 

func (s ManagedJobTemplateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDatum added in v1.43.32 

type MetricDatum struct {

	// The time the metric value was reported.
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp"`

	// The value reported for the metric.
	Value *MetricValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

A metric.

func (MetricDatum) GoString added in v1.43.32 

func (s MetricDatum) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDatum) SetTimestamp added in v1.43.32 

func (s *MetricDatum) SetTimestamp(v time.Time) *MetricDatum

SetTimestamp sets the Timestamp field's value.

func (*MetricDatum) SetValue added in v1.43.32 

func (s *MetricDatum) SetValue(v *MetricValue) *MetricDatum

SetValue sets the Value field's value.

func (MetricDatum) String added in v1.43.32 

func (s MetricDatum) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDimension added in v1.30.2 

type MetricDimension struct {

	// A unique identifier for the dimension.
	//
	// DimensionName is a required field
	DimensionName *string `locationName:"dimensionName" min:"1" type:"string" required:"true"`

	// Defines how the dimensionValues of a dimension are interpreted. For example,
	// for dimension type TOPIC_FILTER, the IN operator, a message will be counted
	// only if its topic matches one of the topic filters. With NOT_IN operator,
	// a message will be counted only if it doesn't match any of the topic filters.
	// The operator is optional: if it's not provided (is null), it will be interpreted
	// as IN.
	Operator *string `locationName:"operator" type:"string" enum:"DimensionValueOperator"`
	// contains filtered or unexported fields
}

The dimension of a metric.

func (MetricDimension) GoString added in v1.30.2 

func (s MetricDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) SetDimensionName added in v1.30.2 

func (s *MetricDimension) SetDimensionName(v string) *MetricDimension

SetDimensionName sets the DimensionName field's value.

func (*MetricDimension) SetOperator added in v1.30.2 

func (s *MetricDimension) SetOperator(v string) *MetricDimension

SetOperator sets the Operator field's value.

func (MetricDimension) String added in v1.30.2 

func (s MetricDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) Validate added in v1.30.2 

func (s *MetricDimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricToRetain added in v1.30.2 

type MetricToRetain struct {

	// What is measured by the behavior.
	//
	// Metric is a required field
	Metric *string `locationName:"metric" type:"string" required:"true"`

	// The dimension of a metric. This can't be used with custom metrics.
	MetricDimension *MetricDimension `locationName:"metricDimension" type:"structure"`
	// contains filtered or unexported fields
}

The metric you want to retain. Dimensions are optional.

func (MetricToRetain) GoString added in v1.30.2 

func (s MetricToRetain) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricToRetain) SetMetric added in v1.30.2 

func (s *MetricToRetain) SetMetric(v string) *MetricToRetain

SetMetric sets the Metric field's value.

func (*MetricToRetain) SetMetricDimension added in v1.30.2 

func (s *MetricToRetain) SetMetricDimension(v *MetricDimension) *MetricToRetain

SetMetricDimension sets the MetricDimension field's value.

func (MetricToRetain) String added in v1.30.2 

func (s MetricToRetain) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricToRetain) Validate added in v1.30.2 

func (s *MetricToRetain) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricValue added in v1.15.2 

type MetricValue struct {

	// If the comparisonOperator calls for a set of CIDRs, use this to specify that
	// set to be compared with the metric.
	Cidrs []*string `locationName:"cidrs" type:"list"`

	// If the comparisonOperator calls for a numeric value, use this to specify
	// that numeric value to be compared with the metric.
	Count *int64 `locationName:"count" type:"long"`

	// The numeral value of a metric.
	Number *float64 `locationName:"number" type:"double"`

	// The numeral values of a metric.
	Numbers []*float64 `locationName:"numbers" type:"list"`

	// If the comparisonOperator calls for a set of ports, use this to specify that
	// set to be compared with the metric.
	Ports []*int64 `locationName:"ports" type:"list"`

	// The string values of a metric.
	Strings []*string `locationName:"strings" type:"list"`
	// contains filtered or unexported fields
}

The value to be compared with the metric.

func (MetricValue) GoString added in v1.15.2 

func (s MetricValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricValue) SetCidrs added in v1.15.2 

func (s *MetricValue) SetCidrs(v []*string) *MetricValue

SetCidrs sets the Cidrs field's value.

func (*MetricValue) SetCount added in v1.15.2 

func (s *MetricValue) SetCount(v int64) *MetricValue

SetCount sets the Count field's value.

func (*MetricValue) SetNumber added in v1.36.9 

func (s *MetricValue) SetNumber(v float64) *MetricValue

SetNumber sets the Number field's value.

func (*MetricValue) SetNumbers added in v1.36.9 

func (s *MetricValue) SetNumbers(v []*float64) *MetricValue

SetNumbers sets the Numbers field's value.

func (*MetricValue) SetPorts added in v1.15.2 

func (s *MetricValue) SetPorts(v []*int64) *MetricValue

SetPorts sets the Ports field's value.

func (*MetricValue) SetStrings added in v1.36.9 

func (s *MetricValue) SetStrings(v []*string) *MetricValue

SetStrings sets the Strings field's value.

func (MetricValue) String added in v1.15.2 

func (s MetricValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MitigationAction added in v1.21.10 

type MitigationAction struct {

	// The set of parameters for this mitigation action. The parameters vary, depending
	// on the kind of action you apply.
	ActionParams *MitigationActionParams `locationName:"actionParams" type:"structure"`

	// A unique identifier for the mitigation action.
	Id *string `locationName:"id" type:"string"`

	// A user-friendly name for the mitigation action.
	Name *string `locationName:"name" type:"string"`

	// The IAM role ARN used to apply this mitigation action.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Describes which changes should be applied as part of a mitigation action.

func (MitigationAction) GoString added in v1.21.10 

func (s MitigationAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MitigationAction) SetActionParams added in v1.21.10 

func (s *MitigationAction) SetActionParams(v *MitigationActionParams) *MitigationAction

SetActionParams sets the ActionParams field's value.

func (*MitigationAction) SetId added in v1.21.10 

func (s *MitigationAction) SetId(v string) *MitigationAction

SetId sets the Id field's value.

func (*MitigationAction) SetName added in v1.21.10 

func (s *MitigationAction) SetName(v string) *MitigationAction

SetName sets the Name field's value.

func (*MitigationAction) SetRoleArn added in v1.21.10 

func (s *MitigationAction) SetRoleArn(v string) *MitigationAction

SetRoleArn sets the RoleArn field's value.

func (MitigationAction) String added in v1.21.10 

func (s MitigationAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MitigationActionIdentifier added in v1.21.10 

type MitigationActionIdentifier struct {

	// The IAM role ARN used to apply this mitigation action.
	ActionArn *string `locationName:"actionArn" type:"string"`

	// The friendly name of the mitigation action.
	ActionName *string `locationName:"actionName" type:"string"`

	// The date when this mitigation action was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`
	// contains filtered or unexported fields
}

Information that identifies a mitigation action. This information is returned by ListMitigationActions.

func (MitigationActionIdentifier) GoString added in v1.21.10 

func (s MitigationActionIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MitigationActionIdentifier) SetActionArn added in v1.21.10 

func (s *MitigationActionIdentifier) SetActionArn(v string) *MitigationActionIdentifier

SetActionArn sets the ActionArn field's value.

func (*MitigationActionIdentifier) SetActionName added in v1.21.10 

func (s *MitigationActionIdentifier) SetActionName(v string) *MitigationActionIdentifier

SetActionName sets the ActionName field's value.

func (*MitigationActionIdentifier) SetCreationDate added in v1.21.10 

func (s *MitigationActionIdentifier) SetCreationDate(v time.Time) *MitigationActionIdentifier

SetCreationDate sets the CreationDate field's value.

func (MitigationActionIdentifier) String added in v1.21.10 

func (s MitigationActionIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MitigationActionParams added in v1.21.10 

type MitigationActionParams struct {

	// Parameters to define a mitigation action that moves devices associated with
	// a certificate to one or more specified thing groups, typically for quarantine.
	AddThingsToThingGroupParams *AddThingsToThingGroupParams `locationName:"addThingsToThingGroupParams" type:"structure"`

	// Parameters to define a mitigation action that enables Amazon Web Services
	// IoT Core logging at a specified level of detail.
	EnableIoTLoggingParams *EnableIoTLoggingParams `locationName:"enableIoTLoggingParams" type:"structure"`

	// Parameters to define a mitigation action that publishes findings to Amazon
	// Simple Notification Service (Amazon SNS. You can implement your own custom
	// actions in response to the Amazon SNS messages.
	PublishFindingToSnsParams *PublishFindingToSnsParams `locationName:"publishFindingToSnsParams" type:"structure"`

	// Parameters to define a mitigation action that adds a blank policy to restrict
	// permissions.
	ReplaceDefaultPolicyVersionParams *ReplaceDefaultPolicyVersionParams `locationName:"replaceDefaultPolicyVersionParams" type:"structure"`

	// Parameters to define a mitigation action that changes the state of the CA
	// certificate to inactive.
	UpdateCACertificateParams *UpdateCACertificateParams `locationName:"updateCACertificateParams" type:"structure"`

	// Parameters to define a mitigation action that changes the state of the device
	// certificate to inactive.
	UpdateDeviceCertificateParams *UpdateDeviceCertificateParams `locationName:"updateDeviceCertificateParams" type:"structure"`
	// contains filtered or unexported fields
}

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

func (MitigationActionParams) GoString added in v1.21.10 

func (s MitigationActionParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MitigationActionParams) SetAddThingsToThingGroupParams added in v1.21.10 

func (s *MitigationActionParams) SetAddThingsToThingGroupParams(v *AddThingsToThingGroupParams) *MitigationActionParams

SetAddThingsToThingGroupParams sets the AddThingsToThingGroupParams field's value.

func (*MitigationActionParams) SetEnableIoTLoggingParams added in v1.21.10 

func (s *MitigationActionParams) SetEnableIoTLoggingParams(v *EnableIoTLoggingParams) *MitigationActionParams

SetEnableIoTLoggingParams sets the EnableIoTLoggingParams field's value.

func (*MitigationActionParams) SetPublishFindingToSnsParams added in v1.21.10 

func (s *MitigationActionParams) SetPublishFindingToSnsParams(v *PublishFindingToSnsParams) *MitigationActionParams

SetPublishFindingToSnsParams sets the PublishFindingToSnsParams field's value.

func (*MitigationActionParams) SetReplaceDefaultPolicyVersionParams added in v1.21.10 

func (s *MitigationActionParams) SetReplaceDefaultPolicyVersionParams(v *ReplaceDefaultPolicyVersionParams) *MitigationActionParams

SetReplaceDefaultPolicyVersionParams sets the ReplaceDefaultPolicyVersionParams field's value.

func (*MitigationActionParams) SetUpdateCACertificateParams added in v1.21.10 

func (s *MitigationActionParams) SetUpdateCACertificateParams(v *UpdateCACertificateParams) *MitigationActionParams

SetUpdateCACertificateParams sets the UpdateCACertificateParams field's value.

func (*MitigationActionParams) SetUpdateDeviceCertificateParams added in v1.21.10 

func (s *MitigationActionParams) SetUpdateDeviceCertificateParams(v *UpdateDeviceCertificateParams) *MitigationActionParams

SetUpdateDeviceCertificateParams sets the UpdateDeviceCertificateParams field's value.

func (MitigationActionParams) String added in v1.21.10 

func (s MitigationActionParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MitigationActionParams) Validate added in v1.21.10 

func (s *MitigationActionParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MqttContext added in v1.25.42 

type MqttContext struct {

	// The value of the clientId key in an MQTT authorization request.
	ClientId *string `locationName:"clientId" min:"1" type:"string"`

	// The value of the password key in an MQTT authorization request.
	// Password is automatically base64 encoded/decoded by the SDK.
	Password []byte `locationName:"password" min:"1" type:"blob"`

	// The value of the username key in an MQTT authorization request.
	Username *string `locationName:"username" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the MQTT context to use for the test authorizer request

func (MqttContext) GoString added in v1.25.42 

func (s MqttContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MqttContext) SetClientId added in v1.25.42 

func (s *MqttContext) SetClientId(v string) *MqttContext

SetClientId sets the ClientId field's value.

func (*MqttContext) SetPassword added in v1.25.42 

func (s *MqttContext) SetPassword(v []byte) *MqttContext

SetPassword sets the Password field's value.

func (*MqttContext) SetUsername added in v1.25.42 

func (s *MqttContext) SetUsername(v string) *MqttContext

SetUsername sets the Username field's value.

func (MqttContext) String added in v1.25.42 

func (s MqttContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MqttContext) Validate added in v1.25.42 

func (s *MqttContext) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NonCompliantResource added in v1.15.2 

type NonCompliantResource struct {

	// Other information about the noncompliant resource.
	AdditionalInfo map[string]*string `locationName:"additionalInfo" type:"map"`

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure"`

	// The type of the noncompliant resource.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Information about the resource that was noncompliant with the audit check.

func (NonCompliantResource) GoString added in v1.15.2 

func (s NonCompliantResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NonCompliantResource) SetAdditionalInfo added in v1.15.2 

func (s *NonCompliantResource) SetAdditionalInfo(v map[string]*string) *NonCompliantResource

SetAdditionalInfo sets the AdditionalInfo field's value.

func (*NonCompliantResource) SetResourceIdentifier added in v1.15.2 

func (s *NonCompliantResource) SetResourceIdentifier(v *ResourceIdentifier) *NonCompliantResource

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*NonCompliantResource) SetResourceType added in v1.15.2 

func (s *NonCompliantResource) SetResourceType(v string) *NonCompliantResource

SetResourceType sets the ResourceType field's value.

func (NonCompliantResource) String added in v1.15.2 

func (s NonCompliantResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotConfiguredException added in v1.28.0 

type NotConfiguredException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource is not configured.

func (*NotConfiguredException) Code added in v1.28.0 

func (s *NotConfiguredException) Code() string

Code returns the exception type name.

func (*NotConfiguredException) Error added in v1.28.0 

func (s *NotConfiguredException) Error() string

func (NotConfiguredException) GoString added in v1.28.0 

func (s NotConfiguredException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotConfiguredException) Message added in v1.28.0 

func (s *NotConfiguredException) Message() string

Message returns the exception's message.

func (*NotConfiguredException) OrigErr added in v1.28.0 

func (s *NotConfiguredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotConfiguredException) RequestID added in v1.28.0 

func (s *NotConfiguredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotConfiguredException) StatusCode added in v1.28.0 

func (s *NotConfiguredException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotConfiguredException) String added in v1.28.0 

func (s NotConfiguredException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 location of the updated firmware.
	FileLocation *FileLocation `locationName:"fileLocation" type:"structure"`

	// The name of the file.
	FileName *string `locationName:"fileName" type:"string"`

	// An integer value you can include in the job document to allow your devices
	// to identify the type of file received from the cloud.
	FileType *int64 `locationName:"fileType" type:"integer"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetFileLocation added in v1.15.22 

func (s *OTAUpdateFile) SetFileLocation(v *FileLocation) *OTAUpdateFile

SetFileLocation sets the FileLocation 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) SetFileType added in v1.35.34 

func (s *OTAUpdateFile) SetFileType(v int64) *OTAUpdateFile

SetFileType sets the FileType 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IoT job ARN associated with the OTA update.
	AwsIotJobArn *string `locationName:"awsIotJobArn" type:"string"`

	// The IoT job ID associated with the OTA update.
	AwsIotJobId *string `locationName:"awsIotJobId" type:"string"`

	// Configuration for the rollout of OTA updates.
	AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig `locationName:"awsJobExecutionsRolloutConfig" type:"structure"`

	// Configuration information for pre-signed URLs. Valid when protocols contains
	// HTTP.
	AwsJobPresignedUrlConfig *AwsJobPresignedUrlConfig `locationName:"awsJobPresignedUrlConfig" type:"structure"`

	// The date when the OTA update was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// 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"`

	// 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"`

	// The protocol used to transfer the OTA update image. Valid values are [HTTP],
	// [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device
	// can choose the protocol.
	Protocols []*string `locationName:"protocols" min:"1" type:"list" enum:"Protocol"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetAwsJobExecutionsRolloutConfig added in v1.15.22 

func (s *OTAUpdateInfo) SetAwsJobExecutionsRolloutConfig(v *AwsJobExecutionsRolloutConfig) *OTAUpdateInfo

SetAwsJobExecutionsRolloutConfig sets the AwsJobExecutionsRolloutConfig field's value.

func (*OTAUpdateInfo) SetAwsJobPresignedUrlConfig added in v1.26.4 

func (s *OTAUpdateInfo) SetAwsJobPresignedUrlConfig(v *AwsJobPresignedUrlConfig) *OTAUpdateInfo

SetAwsJobPresignedUrlConfig sets the AwsJobPresignedUrlConfig 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) SetProtocols added in v1.26.4 

func (s *OTAUpdateInfo) SetProtocols(v []*string) *OTAUpdateInfo

SetProtocols sets the Protocols 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OpenSearchAction added in v1.40.42 

type OpenSearchAction struct {

	// The endpoint of your OpenSearch 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 OpenSearch 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 OpenSearch.
	//
	// 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 OpenSearch Service domain.

func (OpenSearchAction) GoString added in v1.40.42 

func (s OpenSearchAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchAction) SetEndpoint added in v1.40.42 

func (s *OpenSearchAction) SetEndpoint(v string) *OpenSearchAction

SetEndpoint sets the Endpoint field's value.

func (*OpenSearchAction) SetId added in v1.40.42 

func (s *OpenSearchAction) SetId(v string) *OpenSearchAction

SetId sets the Id field's value.

func (*OpenSearchAction) SetIndex added in v1.40.42 

func (s *OpenSearchAction) SetIndex(v string) *OpenSearchAction

SetIndex sets the Index field's value.

func (*OpenSearchAction) SetRoleArn added in v1.40.42 

func (s *OpenSearchAction) SetRoleArn(v string) *OpenSearchAction

SetRoleArn sets the RoleArn field's value.

func (*OpenSearchAction) SetType added in v1.40.42 

func (s *OpenSearchAction) SetType(v string) *OpenSearchAction

SetType sets the Type field's value.

func (OpenSearchAction) String added in v1.40.42 

func (s OpenSearchAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchAction) Validate added in v1.40.42 

func (s *OpenSearchAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OutgoingCertificate added in v1.3.0 

type OutgoingCertificate struct {

	// The certificate ARN.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The certificate ID.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`

	// The certificate creation date.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The date the transfer was initiated.
	TransferDate *time.Time `locationName:"transferDate" type:"timestamp"`

	// The transfer message.
	TransferMessage *string `locationName:"transferMessage" type:"string"`

	// The Amazon Web Services account to which the transfer was made.
	TransferredTo *string `locationName:"transferredTo" min:"12" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PercentPair added in v1.25.34 

type PercentPair struct {

	// The percentile.
	Percent *float64 `locationName:"percent" type:"double"`

	// The value of the percentile.
	Value *float64 `locationName:"value" type:"double"`
	// contains filtered or unexported fields
}

Describes the percentile and percentile value.

func (PercentPair) GoString added in v1.25.34 

func (s PercentPair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PercentPair) SetPercent added in v1.25.34 

func (s *PercentPair) SetPercent(v float64) *PercentPair

SetPercent sets the Percent field's value.

func (*PercentPair) SetValue added in v1.25.34 

func (s *PercentPair) SetValue(v float64) *PercentPair

SetValue sets the Value field's value.

func (PercentPair) String added in v1.25.34 

func (s PercentPair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IoT policy.

func (Policy) GoString 

func (s Policy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PolicyVersion 

type PolicyVersion struct {

	// The date and time the policy was created.
	CreateDate *time.Time `locationName:"createDate" type:"timestamp"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PolicyVersionIdentifier added in v1.15.2 

type PolicyVersionIdentifier struct {

	// The name of the policy.
	PolicyName *string `locationName:"policyName" min:"1" type:"string"`

	// The ID of the version of the policy associated with the resource.
	PolicyVersionId *string `locationName:"policyVersionId" type:"string"`
	// contains filtered or unexported fields
}

Information about the version of the policy associated with the resource.

func (PolicyVersionIdentifier) GoString added in v1.15.2 

func (s PolicyVersionIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyVersionIdentifier) SetPolicyName added in v1.15.2 

func (s *PolicyVersionIdentifier) SetPolicyName(v string) *PolicyVersionIdentifier

SetPolicyName sets the PolicyName field's value.

func (*PolicyVersionIdentifier) SetPolicyVersionId added in v1.15.2 

func (s *PolicyVersionIdentifier) SetPolicyVersionId(v string) *PolicyVersionIdentifier

SetPolicyVersionId sets the PolicyVersionId field's value.

func (PolicyVersionIdentifier) String added in v1.15.2 

func (s PolicyVersionIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyVersionIdentifier) Validate added in v1.15.2 

func (s *PolicyVersionIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// For information about addressing the confused deputy problem, see cross-service
	// confused deputy prevention (https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html)
	// in the Amazon Web Services IoT Core developer guide.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ProvisioningHook added in v1.30.18 

type ProvisioningHook struct {

	// The payload that was sent to the target function.
	//
	// Note: Only Lambda functions are currently supported.
	PayloadVersion *string `locationName:"payloadVersion" min:"10" type:"string"`

	// The ARN of the target function.
	//
	// Note: Only Lambda functions are currently supported.
	//
	// TargetArn is a required field
	TargetArn *string `locationName:"targetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Structure that contains payloadVersion and targetArn.

func (ProvisioningHook) GoString added in v1.30.18 

func (s ProvisioningHook) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisioningHook) SetPayloadVersion added in v1.30.18 

func (s *ProvisioningHook) SetPayloadVersion(v string) *ProvisioningHook

SetPayloadVersion sets the PayloadVersion field's value.

func (*ProvisioningHook) SetTargetArn added in v1.30.18 

func (s *ProvisioningHook) SetTargetArn(v string) *ProvisioningHook

SetTargetArn sets the TargetArn field's value.

func (ProvisioningHook) String added in v1.30.18 

func (s ProvisioningHook) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisioningHook) Validate added in v1.30.18 

func (s *ProvisioningHook) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ProvisioningTemplateSummary added in v1.25.42 

type ProvisioningTemplateSummary struct {

	// The date when the fleet provisioning template summary was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The description of the fleet provisioning template.
	Description *string `locationName:"description" type:"string"`

	// True if the fleet provision template is enabled, otherwise false.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The date when the fleet provisioning template summary was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The ARN of the fleet provisioning template.
	TemplateArn *string `locationName:"templateArn" type:"string"`

	// The name of the fleet provisioning template.
	TemplateName *string `locationName:"templateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A summary of information about a fleet provisioning template.

func (ProvisioningTemplateSummary) GoString added in v1.25.42 

func (s ProvisioningTemplateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisioningTemplateSummary) SetCreationDate added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetCreationDate(v time.Time) *ProvisioningTemplateSummary

SetCreationDate sets the CreationDate field's value.

func (*ProvisioningTemplateSummary) SetDescription added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetDescription(v string) *ProvisioningTemplateSummary

SetDescription sets the Description field's value.

func (*ProvisioningTemplateSummary) SetEnabled added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetEnabled(v bool) *ProvisioningTemplateSummary

SetEnabled sets the Enabled field's value.

func (*ProvisioningTemplateSummary) SetLastModifiedDate added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetLastModifiedDate(v time.Time) *ProvisioningTemplateSummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ProvisioningTemplateSummary) SetTemplateArn added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetTemplateArn(v string) *ProvisioningTemplateSummary

SetTemplateArn sets the TemplateArn field's value.

func (*ProvisioningTemplateSummary) SetTemplateName added in v1.25.42 

func (s *ProvisioningTemplateSummary) SetTemplateName(v string) *ProvisioningTemplateSummary

SetTemplateName sets the TemplateName field's value.

func (ProvisioningTemplateSummary) String added in v1.25.42 

func (s ProvisioningTemplateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProvisioningTemplateVersionSummary added in v1.25.42 

type ProvisioningTemplateVersionSummary struct {

	// The date when the fleet provisioning template version was created
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// True if the fleet provisioning template version is the default version, otherwise
	// false.
	IsDefaultVersion *bool `locationName:"isDefaultVersion" type:"boolean"`

	// The ID of the fleet privisioning template version.
	VersionId *int64 `locationName:"versionId" type:"integer"`
	// contains filtered or unexported fields
}

A summary of information about a fleet provision template version.

func (ProvisioningTemplateVersionSummary) GoString added in v1.25.42 

func (s ProvisioningTemplateVersionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisioningTemplateVersionSummary) SetCreationDate added in v1.25.42 

func (s *ProvisioningTemplateVersionSummary) SetCreationDate(v time.Time) *ProvisioningTemplateVersionSummary

SetCreationDate sets the CreationDate field's value.

func (*ProvisioningTemplateVersionSummary) SetIsDefaultVersion added in v1.25.42 

func (s *ProvisioningTemplateVersionSummary) SetIsDefaultVersion(v bool) *ProvisioningTemplateVersionSummary

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*ProvisioningTemplateVersionSummary) SetVersionId added in v1.25.42 

func (s *ProvisioningTemplateVersionSummary) SetVersionId(v int64) *ProvisioningTemplateVersionSummary

SetVersionId sets the VersionId field's value.

func (ProvisioningTemplateVersionSummary) String added in v1.25.42 

func (s ProvisioningTemplateVersionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PublishFindingToSnsParams added in v1.21.10 

type PublishFindingToSnsParams struct {

	// The ARN of the topic to which you want to publish the findings.
	//
	// TopicArn is a required field
	TopicArn *string `locationName:"topicArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

func (PublishFindingToSnsParams) GoString added in v1.21.10 

func (s PublishFindingToSnsParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishFindingToSnsParams) SetTopicArn added in v1.21.10 

func (s *PublishFindingToSnsParams) SetTopicArn(v string) *PublishFindingToSnsParams

SetTopicArn sets the TopicArn field's value.

func (PublishFindingToSnsParams) String added in v1.21.10 

func (s PublishFindingToSnsParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishFindingToSnsParams) Validate added in v1.21.10 

func (s *PublishFindingToSnsParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAssetPropertyValueEntry added in v1.25.42 

type PutAssetPropertyValueEntry struct {

	// The ID of the IoT SiteWise asset. You must specify either a propertyAlias
	// or both an aliasId and a propertyId. Accepts substitution templates.
	AssetId *string `locationName:"assetId" type:"string"`

	// Optional. A unique identifier for this entry that you can define to better
	// track which message caused an error in case of failure. Accepts substitution
	// templates. Defaults to a new UUID.
	EntryId *string `locationName:"entryId" type:"string"`

	// The name of the property alias associated with your asset property. You must
	// specify either a propertyAlias or both an aliasId and a propertyId. Accepts
	// substitution templates.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset's property. You must specify either a propertyAlias or
	// both an aliasId and a propertyId. Accepts substitution templates.
	PropertyId *string `locationName:"propertyId" type:"string"`

	// A list of property values to insert that each contain timestamp, quality,
	// and value (TQV) information.
	//
	// PropertyValues is a required field
	PropertyValues []*AssetPropertyValue `locationName:"propertyValues" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

An asset property value entry containing the following information.

func (PutAssetPropertyValueEntry) GoString added in v1.25.42 

func (s PutAssetPropertyValueEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAssetPropertyValueEntry) SetAssetId added in v1.25.42 

func (s *PutAssetPropertyValueEntry) SetAssetId(v string) *PutAssetPropertyValueEntry

SetAssetId sets the AssetId field's value.

func (*PutAssetPropertyValueEntry) SetEntryId added in v1.25.42 

func (s *PutAssetPropertyValueEntry) SetEntryId(v string) *PutAssetPropertyValueEntry

SetEntryId sets the EntryId field's value.

func (*PutAssetPropertyValueEntry) SetPropertyAlias added in v1.25.42 

func (s *PutAssetPropertyValueEntry) SetPropertyAlias(v string) *PutAssetPropertyValueEntry

SetPropertyAlias sets the PropertyAlias field's value.

func (*PutAssetPropertyValueEntry) SetPropertyId added in v1.25.42 

func (s *PutAssetPropertyValueEntry) SetPropertyId(v string) *PutAssetPropertyValueEntry

SetPropertyId sets the PropertyId field's value.

func (*PutAssetPropertyValueEntry) SetPropertyValues added in v1.25.42 

func (s *PutAssetPropertyValueEntry) SetPropertyValues(v []*AssetPropertyValue) *PutAssetPropertyValueEntry

SetPropertyValues sets the PropertyValues field's value.

func (PutAssetPropertyValueEntry) String added in v1.25.42 

func (s PutAssetPropertyValueEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAssetPropertyValueEntry) Validate added in v1.25.42 

func (s *PutAssetPropertyValueEntry) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 PutVerificationStateOnViolationInput added in v1.40.46 

type PutVerificationStateOnViolationInput struct {

	// The verification state of the violation.
	//
	// VerificationState is a required field
	VerificationState *string `locationName:"verificationState" type:"string" required:"true" enum:"VerificationState"`

	// The description of the verification state of the violation (detect alarm).
	VerificationStateDescription *string `locationName:"verificationStateDescription" type:"string"`

	// The violation ID.
	//
	// ViolationId is a required field
	ViolationId *string `location:"uri" locationName:"violationId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutVerificationStateOnViolationInput) GoString added in v1.40.46 

func (s PutVerificationStateOnViolationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutVerificationStateOnViolationInput) SetVerificationState added in v1.40.46 

func (s *PutVerificationStateOnViolationInput) SetVerificationState(v string) *PutVerificationStateOnViolationInput

SetVerificationState sets the VerificationState field's value.

func (*PutVerificationStateOnViolationInput) SetVerificationStateDescription added in v1.40.46 

func (s *PutVerificationStateOnViolationInput) SetVerificationStateDescription(v string) *PutVerificationStateOnViolationInput

SetVerificationStateDescription sets the VerificationStateDescription field's value.

func (*PutVerificationStateOnViolationInput) SetViolationId added in v1.40.46 

func (s *PutVerificationStateOnViolationInput) SetViolationId(v string) *PutVerificationStateOnViolationInput

SetViolationId sets the ViolationId field's value.

func (PutVerificationStateOnViolationInput) String added in v1.40.46 

func (s PutVerificationStateOnViolationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutVerificationStateOnViolationInput) Validate added in v1.40.46 

func (s *PutVerificationStateOnViolationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutVerificationStateOnViolationOutput added in v1.40.46 

type PutVerificationStateOnViolationOutput struct {
	// contains filtered or unexported fields
}

func (PutVerificationStateOnViolationOutput) GoString added in v1.40.46 

func (s PutVerificationStateOnViolationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutVerificationStateOnViolationOutput) String added in v1.40.46 

func (s PutVerificationStateOnViolationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RateIncreaseCriteria added in v1.15.79 

type RateIncreaseCriteria struct {

	// The threshold for number of notified things that will initiate the increase
	// in rate of rollout.
	NumberOfNotifiedThings *int64 `locationName:"numberOfNotifiedThings" min:"1" type:"integer"`

	// The threshold for number of succeeded things that will initiate the increase
	// in rate of rollout.
	NumberOfSucceededThings *int64 `locationName:"numberOfSucceededThings" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

func (RateIncreaseCriteria) GoString added in v1.15.79 

func (s RateIncreaseCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RateIncreaseCriteria) SetNumberOfNotifiedThings added in v1.15.79 

func (s *RateIncreaseCriteria) SetNumberOfNotifiedThings(v int64) *RateIncreaseCriteria

SetNumberOfNotifiedThings sets the NumberOfNotifiedThings field's value.

func (*RateIncreaseCriteria) SetNumberOfSucceededThings added in v1.15.79 

func (s *RateIncreaseCriteria) SetNumberOfSucceededThings(v int64) *RateIncreaseCriteria

SetNumberOfSucceededThings sets the NumberOfSucceededThings field's value.

func (RateIncreaseCriteria) String added in v1.15.79 

func (s RateIncreaseCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RateIncreaseCriteria) Validate added in v1.15.79 

func (s *RateIncreaseCriteria) 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"`

	// Describes the certificate mode in which the Certificate Authority (CA) will
	// be registered. If the verificationCertificate field is not provided, set
	// certificateMode to be SNI_ONLY. If the verificationCertificate field is provided,
	// set certificateMode to be DEFAULT. When certificateMode is not provided,
	// it defaults to DEFAULT. All the device certificates that are registered using
	// this CA will be registered in the same certificate mode as the CA. For more
	// information about certificate mode for device certificates, see certificate
	// mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode).
	CertificateMode *string `locationName:"certificateMode" type:"string" enum:"CertificateMode"`

	// Information about the registration configuration.
	RegistrationConfig *RegistrationConfig `locationName:"registrationConfig" type:"structure"`

	// A boolean value that specifies if the CA certificate is set to active.
	//
	// Valid values: ACTIVE | INACTIVE
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" type:"boolean"`

	// Metadata which can be used to manage the CA certificate.
	//
	// For URI Request parameters use format: ...key1=value1&key2=value2...
	//
	// For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	//
	// For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*Tag `locationName:"tags" type:"list"`

	// The private key verification certificate. If certificateMode is SNI_ONLY,
	// the verificationCertificate field must be empty. If certificateMode is DEFAULT
	// or not provided, the verificationCertificate field must not be empty.
	VerificationCertificate *string `locationName:"verificationCertificate" min:"1" type:"string"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *RegisterCACertificateInput) SetCaCertificate(v string) *RegisterCACertificateInput

SetCaCertificate sets the CaCertificate field's value.

func (*RegisterCACertificateInput) SetCertificateMode added in v1.44.50 

func (s *RegisterCACertificateInput) SetCertificateMode(v string) *RegisterCACertificateInput

SetCertificateMode sets the CertificateMode field's value.

func (*RegisterCACertificateInput) SetRegistrationConfig added in v1.12.36 

func (s *RegisterCACertificateInput) SetRegistrationConfig(v *RegistrationConfig) *RegisterCACertificateInput

SetRegistrationConfig sets the RegistrationConfig field's value.

func (*RegisterCACertificateInput) SetSetAsActive added in v1.5.0 

func (s *RegisterCACertificateInput) SetSetAsActive(v bool) *RegisterCACertificateInput

SetSetAsActive sets the SetAsActive field's value.

func (*RegisterCACertificateInput) SetTags added in v1.30.18 

func (s *RegisterCACertificateInput) SetTags(v []*Tag) *RegisterCACertificateInput

SetTags sets the Tags 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 

func (s RegisterCACertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterCACertificateOutput) SetCertificateArn added in v1.5.0 

func (s *RegisterCACertificateOutput) SetCertificateArn(v string) *RegisterCACertificateOutput

SetCertificateArn sets the CertificateArn field's value.

func (*RegisterCACertificateOutput) SetCertificateId added in v1.5.0 

func (s *RegisterCACertificateOutput) SetCertificateId(v string) *RegisterCACertificateOutput

SetCertificateId sets the CertificateId field's value.

func (RegisterCACertificateOutput) String added in v1.1.18 

func (s RegisterCACertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 certificate is set to active.
	//
	// Valid values: ACTIVE | INACTIVE
	//
	// Deprecated: SetAsActive has been deprecated
	SetAsActive *bool `location:"querystring" locationName:"setAsActive" deprecated:"true" type:"boolean"`

	// The status of the register certificate request. Valid values that you can
	// use include ACTIVE, INACTIVE, and REVOKED.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *RegisterCertificateInput) SetSetAsActive(v bool) *RegisterCertificateInput

SetSetAsActive sets the SetAsActive field's value.

func (*RegisterCertificateInput) SetStatus added in v1.5.0 

func (s *RegisterCertificateInput) SetStatus(v string) *RegisterCertificateInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterCertificateOutput) SetCertificateArn added in v1.5.0 

func (s *RegisterCertificateOutput) SetCertificateArn(v string) *RegisterCertificateOutput

SetCertificateArn sets the CertificateArn field's value.

func (*RegisterCertificateOutput) SetCertificateId added in v1.5.0 

func (s *RegisterCertificateOutput) SetCertificateId(v string) *RegisterCertificateOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterCertificateWithoutCAInput added in v1.30.18 

type RegisterCertificateWithoutCAInput struct {

	// The certificate data, in PEM format.
	//
	// CertificatePem is a required field
	CertificatePem *string `locationName:"certificatePem" min:"1" type:"string" required:"true"`

	// The status of the register certificate request.
	Status *string `locationName:"status" type:"string" enum:"CertificateStatus"`
	// contains filtered or unexported fields
}

func (RegisterCertificateWithoutCAInput) GoString added in v1.30.18 

func (s RegisterCertificateWithoutCAInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterCertificateWithoutCAInput) SetCertificatePem added in v1.30.18 

func (s *RegisterCertificateWithoutCAInput) SetCertificatePem(v string) *RegisterCertificateWithoutCAInput

SetCertificatePem sets the CertificatePem field's value.

func (*RegisterCertificateWithoutCAInput) SetStatus added in v1.30.18 

func (s *RegisterCertificateWithoutCAInput) SetStatus(v string) *RegisterCertificateWithoutCAInput

SetStatus sets the Status field's value.

func (RegisterCertificateWithoutCAInput) String added in v1.30.18 

func (s RegisterCertificateWithoutCAInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterCertificateWithoutCAInput) Validate added in v1.30.18 

func (s *RegisterCertificateWithoutCAInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterCertificateWithoutCAOutput added in v1.30.18 

type RegisterCertificateWithoutCAOutput struct {

	// The Amazon Resource Name (ARN) of the registered certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The ID of the registered certificate. (The last part of the certificate ARN
	// contains the certificate ID.
	CertificateId *string `locationName:"certificateId" min:"64" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterCertificateWithoutCAOutput) GoString added in v1.30.18 

func (s RegisterCertificateWithoutCAOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterCertificateWithoutCAOutput) SetCertificateArn added in v1.30.18 

func (s *RegisterCertificateWithoutCAOutput) SetCertificateArn(v string) *RegisterCertificateWithoutCAOutput

SetCertificateArn sets the CertificateArn field's value.

func (*RegisterCertificateWithoutCAOutput) SetCertificateId added in v1.30.18 

func (s *RegisterCertificateWithoutCAOutput) SetCertificateId(v string) *RegisterCertificateWithoutCAOutput

SetCertificateId sets the CertificateId field's value.

func (RegisterCertificateWithoutCAOutput) String added in v1.30.18 

func (s RegisterCertificateWithoutCAOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterThingInput added in v1.12.36 

type RegisterThingInput struct {

	// The parameters for provisioning a thing. See Provisioning Templates (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html)
	// for more information.
	Parameters map[string]*string `locationName:"parameters" type:"map"`

	// The provisioning template. See Provisioning Devices That Have Device Certificates
	// (https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 certificate data, in PEM format.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegistrationCodeValidationException added in v1.28.0 

type RegistrationCodeValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Additional information about the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The registration code is invalid.

func (*RegistrationCodeValidationException) Code added in v1.28.0 

func (s *RegistrationCodeValidationException) Code() string

Code returns the exception type name.

func (*RegistrationCodeValidationException) Error added in v1.28.0 

func (s *RegistrationCodeValidationException) Error() string

func (RegistrationCodeValidationException) GoString added in v1.28.0 

func (s RegistrationCodeValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegistrationCodeValidationException) Message added in v1.28.0 

func (s *RegistrationCodeValidationException) Message() string

Message returns the exception's message.

func (*RegistrationCodeValidationException) OrigErr added in v1.28.0 

func (s *RegistrationCodeValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RegistrationCodeValidationException) RequestID added in v1.28.0 

func (s *RegistrationCodeValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RegistrationCodeValidationException) StatusCode added in v1.28.0 

func (s *RegistrationCodeValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RegistrationCodeValidationException) String added in v1.28.0 

func (s RegistrationCodeValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s RejectCertificateTransferInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectCertificateTransferInput) SetCertificateId added in v1.5.0 

func (s *RejectCertificateTransferInput) SetCertificateId(v string) *RejectCertificateTransferInput

SetCertificateId sets the CertificateId field's value.

func (*RejectCertificateTransferInput) SetRejectReason added in v1.5.0 

func (s *RejectCertificateTransferInput) SetRejectReason(v string) *RejectCertificateTransferInput

SetRejectReason sets the RejectReason field's value.

func (RejectCertificateTransferInput) String 

func (s RejectCertificateTransferInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s RejectCertificateTransferOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RejectCertificateTransferOutput) String 

func (s RejectCertificateTransferOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelatedResource added in v1.15.2 

type RelatedResource struct {

	// Other information about the resource.
	AdditionalInfo map[string]*string `locationName:"additionalInfo" type:"map"`

	// Information that identifies the resource.
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure"`

	// The type of resource.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Information about a related resource.

func (RelatedResource) GoString added in v1.15.2 

func (s RelatedResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelatedResource) SetAdditionalInfo added in v1.15.2 

func (s *RelatedResource) SetAdditionalInfo(v map[string]*string) *RelatedResource

SetAdditionalInfo sets the AdditionalInfo field's value.

func (*RelatedResource) SetResourceIdentifier added in v1.15.2 

func (s *RelatedResource) SetResourceIdentifier(v *ResourceIdentifier) *RelatedResource

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*RelatedResource) SetResourceType added in v1.15.2 

func (s *RelatedResource) SetResourceType(v string) *RelatedResource

SetResourceType sets the ResourceType field's value.

func (RelatedResource) String added in v1.15.2 

func (s RelatedResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveThingFromBillingGroupInput added in v1.15.79 

type RemoveThingFromBillingGroupInput struct {

	// The ARN of the billing group.
	BillingGroupArn *string `locationName:"billingGroupArn" type:"string"`

	// The name of the billing group.
	BillingGroupName *string `locationName:"billingGroupName" min:"1" type:"string"`

	// The ARN of the thing to be removed from the billing group.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The name of the thing to be removed from the billing group.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RemoveThingFromBillingGroupInput) GoString added in v1.15.79 

func (s RemoveThingFromBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveThingFromBillingGroupInput) SetBillingGroupArn added in v1.15.79 

func (s *RemoveThingFromBillingGroupInput) SetBillingGroupArn(v string) *RemoveThingFromBillingGroupInput

SetBillingGroupArn sets the BillingGroupArn field's value.

func (*RemoveThingFromBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *RemoveThingFromBillingGroupInput) SetBillingGroupName(v string) *RemoveThingFromBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*RemoveThingFromBillingGroupInput) SetThingArn added in v1.15.79 

func (s *RemoveThingFromBillingGroupInput) SetThingArn(v string) *RemoveThingFromBillingGroupInput

SetThingArn sets the ThingArn field's value.

func (*RemoveThingFromBillingGroupInput) SetThingName added in v1.15.79 

func (s *RemoveThingFromBillingGroupInput) SetThingName(v string) *RemoveThingFromBillingGroupInput

SetThingName sets the ThingName field's value.

func (RemoveThingFromBillingGroupInput) String added in v1.15.79 

func (s RemoveThingFromBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveThingFromBillingGroupInput) Validate added in v1.15.79 

func (s *RemoveThingFromBillingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveThingFromBillingGroupOutput added in v1.15.79 

type RemoveThingFromBillingGroupOutput struct {
	// contains filtered or unexported fields
}

func (RemoveThingFromBillingGroupOutput) GoString added in v1.15.79 

func (s RemoveThingFromBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveThingFromBillingGroupOutput) String added in v1.15.79 

func (s RemoveThingFromBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s RemoveThingFromThingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveThingFromThingGroupInput) SetThingArn added in v1.12.36 

func (s *RemoveThingFromThingGroupInput) SetThingArn(v string) *RemoveThingFromThingGroupInput

SetThingArn sets the ThingArn field's value.

func (*RemoveThingFromThingGroupInput) SetThingGroupArn added in v1.12.36 

func (s *RemoveThingFromThingGroupInput) SetThingGroupArn(v string) *RemoveThingFromThingGroupInput

SetThingGroupArn sets the ThingGroupArn field's value.

func (*RemoveThingFromThingGroupInput) SetThingGroupName added in v1.12.36 

func (s *RemoveThingFromThingGroupInput) SetThingGroupName(v string) *RemoveThingFromThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (*RemoveThingFromThingGroupInput) SetThingName added in v1.12.36 

func (s *RemoveThingFromThingGroupInput) SetThingName(v string) *RemoveThingFromThingGroupInput

SetThingName sets the ThingName field's value.

func (RemoveThingFromThingGroupInput) String added in v1.12.36 

func (s RemoveThingFromThingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s RemoveThingFromThingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveThingFromThingGroupOutput) String added in v1.12.36 

func (s RemoveThingFromThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplaceDefaultPolicyVersionParams added in v1.21.10 

type ReplaceDefaultPolicyVersionParams struct {

	// The name of the template to be applied. The only supported value is BLANK_POLICY.
	//
	// TemplateName is a required field
	TemplateName *string `locationName:"templateName" type:"string" required:"true" enum:"PolicyTemplateName"`
	// contains filtered or unexported fields
}

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

func (ReplaceDefaultPolicyVersionParams) GoString added in v1.21.10 

func (s ReplaceDefaultPolicyVersionParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplaceDefaultPolicyVersionParams) SetTemplateName added in v1.21.10 

func (s *ReplaceDefaultPolicyVersionParams) SetTemplateName(v string) *ReplaceDefaultPolicyVersionParams

SetTemplateName sets the TemplateName field's value.

func (ReplaceDefaultPolicyVersionParams) String added in v1.21.10 

func (s ReplaceDefaultPolicyVersionParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplaceDefaultPolicyVersionParams) Validate added in v1.21.10 

func (s *ReplaceDefaultPolicyVersionParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplaceTopicRuleInput) SetRuleName added in v1.5.0 

func (s *ReplaceTopicRuleInput) SetRuleName(v string) *ReplaceTopicRuleInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ReplaceTopicRuleOutput) String 

func (s ReplaceTopicRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RepublishAction 

type RepublishAction struct {

	// The Quality of Service (QoS) level to use when republishing messages. The
	// default value is 0.
	Qos *int64 `locationName:"qos" type:"integer"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RepublishAction) SetQos added in v1.22.3 

func (s *RepublishAction) SetQos(v int64) *RepublishAction

SetQos sets the Qos field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ResourceAlreadyExistsException added in v1.28.0 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`

	// The ARN of the resource that caused the exception.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// The ID of the resource that caused the exception.
	ResourceId *string `locationName:"resourceId" type:"string"`
	// contains filtered or unexported fields
}

The resource already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceIdentifier added in v1.15.2 

type ResourceIdentifier struct {

	// The account with which the resource is associated.
	Account *string `locationName:"account" min:"12" type:"string"`

	// The ID of the CA certificate used to authorize the certificate.
	CaCertificateId *string `locationName:"caCertificateId" min:"64" type:"string"`

	// The client ID.
	ClientId *string `locationName:"clientId" type:"string"`

	// The ID of the Amazon Cognito identity pool.
	CognitoIdentityPoolId *string `locationName:"cognitoIdentityPoolId" type:"string"`

	// The ID of the certificate attached to the resource.
	DeviceCertificateId *string `locationName:"deviceCertificateId" min:"64" type:"string"`

	// The ARN of the IAM role that has overly permissive actions.
	IamRoleArn *string `locationName:"iamRoleArn" min:"20" type:"string"`

	// The version of the policy associated with the resource.
	PolicyVersionIdentifier *PolicyVersionIdentifier `locationName:"policyVersionIdentifier" type:"structure"`

	// The ARN of the role alias that has overly permissive actions.
	RoleAliasArn *string `locationName:"roleAliasArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information that identifies the noncompliant resource.

func (ResourceIdentifier) GoString added in v1.15.2 

func (s ResourceIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceIdentifier) SetAccount added in v1.15.2 

func (s *ResourceIdentifier) SetAccount(v string) *ResourceIdentifier

SetAccount sets the Account field's value.

func (*ResourceIdentifier) SetCaCertificateId added in v1.15.2 

func (s *ResourceIdentifier) SetCaCertificateId(v string) *ResourceIdentifier

SetCaCertificateId sets the CaCertificateId field's value.

func (*ResourceIdentifier) SetClientId added in v1.15.2 

func (s *ResourceIdentifier) SetClientId(v string) *ResourceIdentifier

SetClientId sets the ClientId field's value.

func (*ResourceIdentifier) SetCognitoIdentityPoolId added in v1.15.2 

func (s *ResourceIdentifier) SetCognitoIdentityPoolId(v string) *ResourceIdentifier

SetCognitoIdentityPoolId sets the CognitoIdentityPoolId field's value.

func (*ResourceIdentifier) SetDeviceCertificateId added in v1.15.2 

func (s *ResourceIdentifier) SetDeviceCertificateId(v string) *ResourceIdentifier

SetDeviceCertificateId sets the DeviceCertificateId field's value.

func (*ResourceIdentifier) SetIamRoleArn added in v1.25.42 

func (s *ResourceIdentifier) SetIamRoleArn(v string) *ResourceIdentifier

SetIamRoleArn sets the IamRoleArn field's value.

func (*ResourceIdentifier) SetPolicyVersionIdentifier added in v1.15.2 

func (s *ResourceIdentifier) SetPolicyVersionIdentifier(v *PolicyVersionIdentifier) *ResourceIdentifier

SetPolicyVersionIdentifier sets the PolicyVersionIdentifier field's value.

func (*ResourceIdentifier) SetRoleAliasArn added in v1.25.42 

func (s *ResourceIdentifier) SetRoleAliasArn(v string) *ResourceIdentifier

SetRoleAliasArn sets the RoleAliasArn field's value.

func (ResourceIdentifier) String added in v1.15.2 

func (s ResourceIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceIdentifier) Validate added in v1.15.2 

func (s *ResourceIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceRegistrationFailureException added in v1.28.0 

type ResourceRegistrationFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource registration failed.

func (*ResourceRegistrationFailureException) Code added in v1.28.0 

func (s *ResourceRegistrationFailureException) Code() string

Code returns the exception type name.

func (*ResourceRegistrationFailureException) Error added in v1.28.0 

func (s *ResourceRegistrationFailureException) Error() string

func (ResourceRegistrationFailureException) GoString added in v1.28.0 

func (s ResourceRegistrationFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceRegistrationFailureException) Message added in v1.28.0 

func (s *ResourceRegistrationFailureException) Message() string

Message returns the exception's message.

func (*ResourceRegistrationFailureException) OrigErr added in v1.28.0 

func (s *ResourceRegistrationFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceRegistrationFailureException) RequestID added in v1.28.0 

func (s *ResourceRegistrationFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceRegistrationFailureException) StatusCode added in v1.28.0 

func (s *ResourceRegistrationFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceRegistrationFailureException) String added in v1.28.0 

func (s ResourceRegistrationFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetryCriteria added in v1.42.28 

type RetryCriteria struct {

	// The type of job execution failures that can initiate a job retry.
	//
	// FailureType is a required field
	FailureType *string `locationName:"failureType" type:"string" required:"true" enum:"RetryableFailureType"`

	// The number of retries allowed for a failure type for the job.
	//
	// NumberOfRetries is a required field
	NumberOfRetries *int64 `locationName:"numberOfRetries" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The criteria that determines how many retries are allowed for each failure type for a job.

func (RetryCriteria) GoString added in v1.42.28 

func (s RetryCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetryCriteria) SetFailureType added in v1.42.28 

func (s *RetryCriteria) SetFailureType(v string) *RetryCriteria

SetFailureType sets the FailureType field's value.

func (*RetryCriteria) SetNumberOfRetries added in v1.42.28 

func (s *RetryCriteria) SetNumberOfRetries(v int64) *RetryCriteria

SetNumberOfRetries sets the NumberOfRetries field's value.

func (RetryCriteria) String added in v1.42.28 

func (s RetryCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetryCriteria) Validate added in v1.42.28 

func (s *RetryCriteria) 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"`

	// 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"`

	// The role alias owner.
	Owner *string `locationName:"owner" min:"12" type:"string"`

	// The role alias.
	RoleAlias *string `locationName:"roleAlias" min:"1" type:"string"`

	// The ARN of the role alias.
	RoleAliasArn *string `locationName:"roleAliasArn" min:"1" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *RoleAliasDescription) SetOwner(v string) *RoleAliasDescription

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 

func (s *RoleAliasDescription) SetRoleArn(v string) *RoleAliasDescription

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl).
	CannedAcl *string `locationName:"cannedAcl" type:"string" enum:"CannedAccessControlList"`

	// The object key. For more information, see Actions, resources, and condition
	// keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html).
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 S3Destination added in v1.15.22 

type S3Destination struct {

	// The S3 bucket that contains the updated firmware.
	Bucket *string `locationName:"bucket" min:"1" type:"string"`

	// The S3 prefix.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

Describes the location of updated firmware in S3.

func (S3Destination) GoString added in v1.15.22 

func (s S3Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Destination) SetBucket added in v1.15.22 

func (s *S3Destination) SetBucket(v string) *S3Destination

SetBucket sets the Bucket field's value.

func (*S3Destination) SetPrefix added in v1.15.22 

func (s *S3Destination) SetPrefix(v string) *S3Destination

SetPrefix sets the Prefix field's value.

func (S3Destination) String added in v1.15.22 

func (s S3Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Destination) Validate added in v1.15.22 

func (s *S3Destination) 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.
	Bucket *string `locationName:"bucket" min:"1" type:"string"`

	// The S3 key.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The S3 bucket version.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

The S3 location.

func (S3Location) GoString added in v1.12.51 

func (s S3Location) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *SalesforceAction) SetUrl(v string) *SalesforceAction

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ScheduledAuditMetadata added in v1.15.2 

type ScheduledAuditMetadata struct {

	// The day of the month on which the scheduled audit is run (if the frequency
	// is "MONTHLY"). If days 29-31 are specified, and the month does not have that
	// many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string `locationName:"dayOfMonth" type:"string"`

	// The day of the week on which the scheduled audit is run (if the frequency
	// is "WEEKLY" or "BIWEEKLY").
	DayOfWeek *string `locationName:"dayOfWeek" type:"string" enum:"DayOfWeek"`

	// How often the scheduled audit occurs.
	Frequency *string `locationName:"frequency" type:"string" enum:"AuditFrequency"`

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string `locationName:"scheduledAuditArn" type:"string"`

	// The name of the scheduled audit.
	ScheduledAuditName *string `locationName:"scheduledAuditName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the scheduled audit.

func (ScheduledAuditMetadata) GoString added in v1.15.2 

func (s ScheduledAuditMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledAuditMetadata) SetDayOfMonth added in v1.15.2 

func (s *ScheduledAuditMetadata) SetDayOfMonth(v string) *ScheduledAuditMetadata

SetDayOfMonth sets the DayOfMonth field's value.

func (*ScheduledAuditMetadata) SetDayOfWeek added in v1.15.2 

func (s *ScheduledAuditMetadata) SetDayOfWeek(v string) *ScheduledAuditMetadata

SetDayOfWeek sets the DayOfWeek field's value.

func (*ScheduledAuditMetadata) SetFrequency added in v1.15.2 

func (s *ScheduledAuditMetadata) SetFrequency(v string) *ScheduledAuditMetadata

SetFrequency sets the Frequency field's value.

func (*ScheduledAuditMetadata) SetScheduledAuditArn added in v1.15.2 

func (s *ScheduledAuditMetadata) SetScheduledAuditArn(v string) *ScheduledAuditMetadata

SetScheduledAuditArn sets the ScheduledAuditArn field's value.

func (*ScheduledAuditMetadata) SetScheduledAuditName added in v1.15.2 

func (s *ScheduledAuditMetadata) SetScheduledAuditName(v string) *ScheduledAuditMetadata

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (ScheduledAuditMetadata) String added in v1.15.2 

func (s ScheduledAuditMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. For more information about the search query syntax,
	// see Query syntax (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html).
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 thing groups that match the search query.
	ThingGroups []*ThingGroupDocument `locationName:"thingGroups" type:"list"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchIndexOutput) SetNextToken added in v1.12.36 

func (s *SearchIndexOutput) SetNextToken(v string) *SearchIndexOutput

SetNextToken sets the NextToken field's value.

func (*SearchIndexOutput) SetThingGroups added in v1.15.19 

func (s *SearchIndexOutput) SetThingGroups(v []*ThingGroupDocument) *SearchIndexOutput

SetThingGroups sets the ThingGroups field's value.

func (*SearchIndexOutput) SetThings added in v1.12.36 

func (s *SearchIndexOutput) SetThings(v []*ThingDocument) *SearchIndexOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityProfileIdentifier added in v1.15.2 

type SecurityProfileIdentifier struct {

	// The ARN of the security profile.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The name you've given to the security profile.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifying information for a Device Defender security profile.

func (SecurityProfileIdentifier) GoString added in v1.15.2 

func (s SecurityProfileIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityProfileIdentifier) SetArn added in v1.15.2 

func (s *SecurityProfileIdentifier) SetArn(v string) *SecurityProfileIdentifier

SetArn sets the Arn field's value.

func (*SecurityProfileIdentifier) SetName added in v1.15.2 

func (s *SecurityProfileIdentifier) SetName(v string) *SecurityProfileIdentifier

SetName sets the Name field's value.

func (SecurityProfileIdentifier) String added in v1.15.2 

func (s SecurityProfileIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityProfileTarget added in v1.15.2 

type SecurityProfileTarget struct {

	// The ARN of the security profile.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A target to which an alert is sent when a security profile behavior is violated.

func (SecurityProfileTarget) GoString added in v1.15.2 

func (s SecurityProfileTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityProfileTarget) SetArn added in v1.15.2 

func (s *SecurityProfileTarget) SetArn(v string) *SecurityProfileTarget

SetArn sets the Arn field's value.

func (SecurityProfileTarget) String added in v1.15.2 

func (s SecurityProfileTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityProfileTargetMapping added in v1.15.2 

type SecurityProfileTargetMapping struct {

	// Information that identifies the security profile.
	SecurityProfileIdentifier *SecurityProfileIdentifier `locationName:"securityProfileIdentifier" type:"structure"`

	// Information about the target (thing group) associated with the security profile.
	Target *SecurityProfileTarget `locationName:"target" type:"structure"`
	// contains filtered or unexported fields
}

Information about a security profile and the target associated with it.

func (SecurityProfileTargetMapping) GoString added in v1.15.2 

func (s SecurityProfileTargetMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityProfileTargetMapping) SetSecurityProfileIdentifier added in v1.15.2 

func (s *SecurityProfileTargetMapping) SetSecurityProfileIdentifier(v *SecurityProfileIdentifier) *SecurityProfileTargetMapping

SetSecurityProfileIdentifier sets the SecurityProfileIdentifier field's value.

func (*SecurityProfileTargetMapping) SetTarget added in v1.15.2 

func (s *SecurityProfileTargetMapping) SetTarget(v *SecurityProfileTarget) *SecurityProfileTargetMapping

SetTarget sets the Target field's value.

func (SecurityProfileTargetMapping) String added in v1.15.2 

func (s SecurityProfileTargetMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerCertificateSummary added in v1.25.42 

type ServerCertificateSummary struct {

	// The ARN of the server certificate.
	ServerCertificateArn *string `locationName:"serverCertificateArn" min:"1" type:"string"`

	// The status of the server certificate.
	ServerCertificateStatus *string `locationName:"serverCertificateStatus" type:"string" enum:"ServerCertificateStatus"`

	// Details that explain the status of the server certificate.
	ServerCertificateStatusDetail *string `locationName:"serverCertificateStatusDetail" type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about a server certificate.

func (ServerCertificateSummary) GoString added in v1.25.42 

func (s ServerCertificateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerCertificateSummary) SetServerCertificateArn added in v1.25.42 

func (s *ServerCertificateSummary) SetServerCertificateArn(v string) *ServerCertificateSummary

SetServerCertificateArn sets the ServerCertificateArn field's value.

func (*ServerCertificateSummary) SetServerCertificateStatus added in v1.25.42 

func (s *ServerCertificateSummary) SetServerCertificateStatus(v string) *ServerCertificateSummary

SetServerCertificateStatus sets the ServerCertificateStatus field's value.

func (*ServerCertificateSummary) SetServerCertificateStatusDetail added in v1.25.42 

func (s *ServerCertificateSummary) SetServerCertificateStatusDetail(v string) *ServerCertificateSummary

SetServerCertificateStatusDetail sets the ServerCertificateStatusDetail field's value.

func (ServerCertificateSummary) String added in v1.25.42 

func (s ServerCertificateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (*ServiceUnavailableException) Code added in v1.28.0 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString added in v1.28.0 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0 

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDefaultAuthorizerInput) SetAuthorizerName added in v1.12.36 

func (s *SetDefaultAuthorizerInput) SetAuthorizerName(v string) *SetDefaultAuthorizerInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDefaultAuthorizerOutput) SetAuthorizerArn added in v1.12.36 

func (s *SetDefaultAuthorizerOutput) SetAuthorizerArn(v string) *SetDefaultAuthorizerOutput

SetAuthorizerArn sets the AuthorizerArn field's value.

func (*SetDefaultAuthorizerOutput) SetAuthorizerName added in v1.12.36 

func (s *SetDefaultAuthorizerOutput) SetAuthorizerName(v string) *SetDefaultAuthorizerOutput

SetAuthorizerName sets the AuthorizerName field's value.

func (SetDefaultAuthorizerOutput) String added in v1.12.36 

func (s SetDefaultAuthorizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDefaultPolicyVersionInput) SetPolicyName added in v1.5.0 

func (s *SetDefaultPolicyVersionInput) SetPolicyName(v string) *SetDefaultPolicyVersionInput

SetPolicyName sets the PolicyName field's value.

func (*SetDefaultPolicyVersionInput) SetPolicyVersionId added in v1.5.0 

func (s *SetDefaultPolicyVersionInput) SetPolicyVersionId(v string) *SetDefaultPolicyVersionInput

SetPolicyVersionId sets the PolicyVersionId field's value.

func (SetDefaultPolicyVersionInput) String 

func (s SetDefaultPolicyVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s SetDefaultPolicyVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetDefaultPolicyVersionOutput) String 

func (s SetDefaultPolicyVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetLoggingOptionsOutput) String 

func (s SetLoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetV2LoggingLevelInput) SetLogLevel added in v1.12.36 

func (s *SetV2LoggingLevelInput) SetLogLevel(v string) *SetV2LoggingLevelInput

SetLogLevel sets the LogLevel field's value.

func (*SetV2LoggingLevelInput) SetLogTarget added in v1.12.36 

func (s *SetV2LoggingLevelInput) SetLogTarget(v *LogTarget) *SetV2LoggingLevelInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetV2LoggingLevelOutput) String added in v1.12.36 

func (s SetV2LoggingLevelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetV2LoggingOptionsInput added in v1.12.36 

type SetV2LoggingOptionsInput struct {

	// The default logging level.
	DefaultLogLevel *string `locationName:"defaultLogLevel" type:"string" enum:"LogLevel"`

	// If true all logs are disabled. The default is false.
	DisableAllLogs *bool `locationName:"disableAllLogs" type:"boolean"`

	// The ARN of the role 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *SetV2LoggingOptionsInput) SetRoleArn(v string) *SetV2LoggingOptionsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetV2LoggingOptionsOutput) String added in v1.12.36 

func (s SetV2LoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SigV4Authorization added in v1.25.38 

type SigV4Authorization struct {

	// The ARN of the signing role.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The service name to use while signing with Sig V4.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" type:"string" required:"true"`

	// The signing region.
	//
	// SigningRegion is a required field
	SigningRegion *string `locationName:"signingRegion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

For more information, see Signature Version 4 signing process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

func (SigV4Authorization) GoString added in v1.25.38 

func (s SigV4Authorization) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SigV4Authorization) SetRoleArn added in v1.25.38 

func (s *SigV4Authorization) SetRoleArn(v string) *SigV4Authorization

SetRoleArn sets the RoleArn field's value.

func (*SigV4Authorization) SetServiceName added in v1.25.38 

func (s *SigV4Authorization) SetServiceName(v string) *SigV4Authorization

SetServiceName sets the ServiceName field's value.

func (*SigV4Authorization) SetSigningRegion added in v1.25.38 

func (s *SigV4Authorization) SetSigningRegion(v string) *SigV4Authorization

SetSigningRegion sets the SigningRegion field's value.

func (SigV4Authorization) String added in v1.25.38 

func (s SigV4Authorization) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SigV4Authorization) Validate added in v1.25.38 

func (s *SigV4Authorization) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SigningProfileParameter added in v1.15.22 

type SigningProfileParameter struct {

	// Certificate ARN.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The location of the code-signing certificate on your device.
	CertificatePathOnDevice *string `locationName:"certificatePathOnDevice" type:"string"`

	// The hardware platform of your device.
	Platform *string `locationName:"platform" type:"string"`
	// contains filtered or unexported fields
}

Describes the code-signing profile.

func (SigningProfileParameter) GoString added in v1.15.22 

func (s SigningProfileParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SigningProfileParameter) SetCertificateArn added in v1.15.22 

func (s *SigningProfileParameter) SetCertificateArn(v string) *SigningProfileParameter

SetCertificateArn sets the CertificateArn field's value.

func (*SigningProfileParameter) SetCertificatePathOnDevice added in v1.15.22 

func (s *SigningProfileParameter) SetCertificatePathOnDevice(v string) *SigningProfileParameter

SetCertificatePathOnDevice sets the CertificatePathOnDevice field's value.

func (*SigningProfileParameter) SetPlatform added in v1.15.22 

func (s *SigningProfileParameter) SetPlatform(v string) *SigningProfileParameter

SetPlatform sets the Platform field's value.

func (SigningProfileParameter) String added in v1.15.22 

func (s SigningProfileParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 https://docs.aws.amazon.com/sns/latest/dg/json-formats.html (https://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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 SqlParseException added in v1.28.0 

type SqlParseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The Rule-SQL expression can't be parsed correctly.

func (*SqlParseException) Code added in v1.28.0 

func (s *SqlParseException) Code() string

Code returns the exception type name.

func (*SqlParseException) Error added in v1.28.0 

func (s *SqlParseException) Error() string

func (SqlParseException) GoString added in v1.28.0 

func (s SqlParseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SqlParseException) Message added in v1.28.0 

func (s *SqlParseException) Message() string

Message returns the exception's message.

func (*SqlParseException) OrigErr added in v1.28.0 

func (s *SqlParseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SqlParseException) RequestID added in v1.28.0 

func (s *SqlParseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SqlParseException) StatusCode added in v1.28.0 

func (s *SqlParseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SqlParseException) String added in v1.28.0 

func (s SqlParseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 StartAuditMitigationActionsTaskInput added in v1.21.10 

type StartAuditMitigationActionsTaskInput struct {

	// For an audit check, specifies which mitigation actions to apply. Those actions
	// must be defined in your Amazon Web Services accounts.
	//
	// AuditCheckToActionsMapping is a required field
	AuditCheckToActionsMapping map[string][]*string `locationName:"auditCheckToActionsMapping" type:"map" required:"true"`

	// Each audit mitigation task must have a unique client request token. If you
	// try to start a new task with the same token as a task that already exists,
	// an exception occurs. If you omit this value, a unique client request token
	// is generated automatically.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"`

	// Specifies the audit findings to which the mitigation actions are applied.
	// You can apply them to a type of audit check, to all findings from an audit,
	// or to a specific set of findings.
	//
	// Target is a required field
	Target *AuditMitigationActionsTaskTarget `locationName:"target" type:"structure" required:"true"`

	// A unique identifier for the task. You can use this identifier to check the
	// status of the task or to cancel it.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartAuditMitigationActionsTaskInput) GoString added in v1.21.10 

func (s StartAuditMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAuditMitigationActionsTaskInput) SetAuditCheckToActionsMapping added in v1.21.10 

func (s *StartAuditMitigationActionsTaskInput) SetAuditCheckToActionsMapping(v map[string][]*string) *StartAuditMitigationActionsTaskInput

SetAuditCheckToActionsMapping sets the AuditCheckToActionsMapping field's value.

func (*StartAuditMitigationActionsTaskInput) SetClientRequestToken added in v1.21.10 

func (s *StartAuditMitigationActionsTaskInput) SetClientRequestToken(v string) *StartAuditMitigationActionsTaskInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartAuditMitigationActionsTaskInput) SetTarget added in v1.21.10 

func (s *StartAuditMitigationActionsTaskInput) SetTarget(v *AuditMitigationActionsTaskTarget) *StartAuditMitigationActionsTaskInput

SetTarget sets the Target field's value.

func (*StartAuditMitigationActionsTaskInput) SetTaskId added in v1.21.10 

func (s *StartAuditMitigationActionsTaskInput) SetTaskId(v string) *StartAuditMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (StartAuditMitigationActionsTaskInput) String added in v1.21.10 

func (s StartAuditMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAuditMitigationActionsTaskInput) Validate added in v1.21.10 

func (s *StartAuditMitigationActionsTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAuditMitigationActionsTaskOutput added in v1.21.10 

type StartAuditMitigationActionsTaskOutput struct {

	// The unique identifier for the audit mitigation task. This matches the taskId
	// that you specified in the request.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartAuditMitigationActionsTaskOutput) GoString added in v1.21.10 

func (s StartAuditMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAuditMitigationActionsTaskOutput) SetTaskId added in v1.21.10 

func (s *StartAuditMitigationActionsTaskOutput) SetTaskId(v string) *StartAuditMitigationActionsTaskOutput

SetTaskId sets the TaskId field's value.

func (StartAuditMitigationActionsTaskOutput) String added in v1.21.10 

func (s StartAuditMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDetectMitigationActionsTaskInput added in v1.36.9 

type StartDetectMitigationActionsTaskInput struct {

	// The actions to be performed when a device has unexpected behavior.
	//
	// Actions is a required field
	Actions []*string `locationName:"actions" min:"1" type:"list" required:"true"`

	// Each mitigation action task must have a unique client request token. If you
	// try to create a new task with the same token as a task that already exists,
	// an exception occurs. If you omit this value, Amazon Web Services SDKs will
	// automatically generate a unique client request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"`

	// Specifies to list only active violations.
	IncludeOnlyActiveViolations *bool `locationName:"includeOnlyActiveViolations" type:"boolean"`

	// Specifies to include suppressed alerts.
	IncludeSuppressedAlerts *bool `locationName:"includeSuppressedAlerts" type:"boolean"`

	// Specifies the ML Detect findings to which the mitigation actions are applied.
	//
	// Target is a required field
	Target *DetectMitigationActionsTaskTarget `locationName:"target" type:"structure" required:"true"`

	// The unique identifier of the task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`

	// Specifies the time period of which violation events occurred between.
	ViolationEventOccurrenceRange *ViolationEventOccurrenceRange `locationName:"violationEventOccurrenceRange" type:"structure"`
	// contains filtered or unexported fields
}

func (StartDetectMitigationActionsTaskInput) GoString added in v1.36.9 

func (s StartDetectMitigationActionsTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectMitigationActionsTaskInput) SetActions added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetActions(v []*string) *StartDetectMitigationActionsTaskInput

SetActions sets the Actions field's value.

func (*StartDetectMitigationActionsTaskInput) SetClientRequestToken added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetClientRequestToken(v string) *StartDetectMitigationActionsTaskInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDetectMitigationActionsTaskInput) SetIncludeOnlyActiveViolations added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetIncludeOnlyActiveViolations(v bool) *StartDetectMitigationActionsTaskInput

SetIncludeOnlyActiveViolations sets the IncludeOnlyActiveViolations field's value.

func (*StartDetectMitigationActionsTaskInput) SetIncludeSuppressedAlerts added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetIncludeSuppressedAlerts(v bool) *StartDetectMitigationActionsTaskInput

SetIncludeSuppressedAlerts sets the IncludeSuppressedAlerts field's value.

func (*StartDetectMitigationActionsTaskInput) SetTarget added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetTarget(v *DetectMitigationActionsTaskTarget) *StartDetectMitigationActionsTaskInput

SetTarget sets the Target field's value.

func (*StartDetectMitigationActionsTaskInput) SetTaskId added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetTaskId(v string) *StartDetectMitigationActionsTaskInput

SetTaskId sets the TaskId field's value.

func (*StartDetectMitigationActionsTaskInput) SetViolationEventOccurrenceRange added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) SetViolationEventOccurrenceRange(v *ViolationEventOccurrenceRange) *StartDetectMitigationActionsTaskInput

SetViolationEventOccurrenceRange sets the ViolationEventOccurrenceRange field's value.

func (StartDetectMitigationActionsTaskInput) String added in v1.36.9 

func (s StartDetectMitigationActionsTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectMitigationActionsTaskInput) Validate added in v1.36.9 

func (s *StartDetectMitigationActionsTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDetectMitigationActionsTaskOutput added in v1.36.9 

type StartDetectMitigationActionsTaskOutput struct {

	// The unique identifier of the task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartDetectMitigationActionsTaskOutput) GoString added in v1.36.9 

func (s StartDetectMitigationActionsTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectMitigationActionsTaskOutput) SetTaskId added in v1.36.9 

func (s *StartDetectMitigationActionsTaskOutput) SetTaskId(v string) *StartDetectMitigationActionsTaskOutput

SetTaskId sets the TaskId field's value.

func (StartDetectMitigationActionsTaskOutput) String added in v1.36.9 

func (s StartDetectMitigationActionsTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartOnDemandAuditTaskInput added in v1.15.2 

type StartOnDemandAuditTaskInput struct {

	// Which checks are performed during the audit. The checks you specify must
	// be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration
	// to select which checks are enabled.
	//
	// TargetCheckNames is a required field
	TargetCheckNames []*string `locationName:"targetCheckNames" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartOnDemandAuditTaskInput) GoString added in v1.15.2 

func (s StartOnDemandAuditTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartOnDemandAuditTaskInput) SetTargetCheckNames added in v1.15.2 

func (s *StartOnDemandAuditTaskInput) SetTargetCheckNames(v []*string) *StartOnDemandAuditTaskInput

SetTargetCheckNames sets the TargetCheckNames field's value.

func (StartOnDemandAuditTaskInput) String added in v1.15.2 

func (s StartOnDemandAuditTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartOnDemandAuditTaskInput) Validate added in v1.15.2 

func (s *StartOnDemandAuditTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartOnDemandAuditTaskOutput added in v1.15.2 

type StartOnDemandAuditTaskOutput struct {

	// The ID of the on-demand audit you started.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartOnDemandAuditTaskOutput) GoString added in v1.15.2 

func (s StartOnDemandAuditTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartOnDemandAuditTaskOutput) SetTaskId added in v1.15.2 

func (s *StartOnDemandAuditTaskOutput) SetTaskId(v string) *StartOnDemandAuditTaskOutput

SetTaskId sets the TaskId field's value.

func (StartOnDemandAuditTaskOutput) String added in v1.15.2 

func (s StartOnDemandAuditTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSigningJobParameter added in v1.15.22 

type StartSigningJobParameter struct {

	// The location to write the code-signed file.
	Destination *Destination `locationName:"destination" type:"structure"`

	// The code-signing profile name.
	SigningProfileName *string `locationName:"signingProfileName" type:"string"`

	// Describes the code-signing profile.
	SigningProfileParameter *SigningProfileParameter `locationName:"signingProfileParameter" type:"structure"`
	// contains filtered or unexported fields
}

Information required to start a signing job.

func (StartSigningJobParameter) GoString added in v1.15.22 

func (s StartSigningJobParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSigningJobParameter) SetDestination added in v1.15.22 

func (s *StartSigningJobParameter) SetDestination(v *Destination) *StartSigningJobParameter

SetDestination sets the Destination field's value.

func (*StartSigningJobParameter) SetSigningProfileName added in v1.15.22 

func (s *StartSigningJobParameter) SetSigningProfileName(v string) *StartSigningJobParameter

SetSigningProfileName sets the SigningProfileName field's value.

func (*StartSigningJobParameter) SetSigningProfileParameter added in v1.15.22 

func (s *StartSigningJobParameter) SetSigningProfileParameter(v *SigningProfileParameter) *StartSigningJobParameter

SetSigningProfileParameter sets the SigningProfileParameter field's value.

func (StartSigningJobParameter) String added in v1.15.22 

func (s StartSigningJobParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSigningJobParameter) Validate added in v1.15.22 

func (s *StartSigningJobParameter) 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 

func (s StartThingRegistrationTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartThingRegistrationTaskInput) SetInputFileBucket added in v1.12.36 

func (s *StartThingRegistrationTaskInput) SetInputFileBucket(v string) *StartThingRegistrationTaskInput

SetInputFileBucket sets the InputFileBucket field's value.

func (*StartThingRegistrationTaskInput) SetInputFileKey added in v1.12.36 

func (s *StartThingRegistrationTaskInput) SetInputFileKey(v string) *StartThingRegistrationTaskInput

SetInputFileKey sets the InputFileKey field's value.

func (*StartThingRegistrationTaskInput) SetRoleArn added in v1.12.36 

func (s *StartThingRegistrationTaskInput) SetRoleArn(v string) *StartThingRegistrationTaskInput

SetRoleArn sets the RoleArn field's value.

func (*StartThingRegistrationTaskInput) SetTemplateBody added in v1.12.36 

func (s *StartThingRegistrationTaskInput) SetTemplateBody(v string) *StartThingRegistrationTaskInput

SetTemplateBody sets the TemplateBody field's value.

func (StartThingRegistrationTaskInput) String added in v1.12.36 

func (s StartThingRegistrationTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s StartThingRegistrationTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartThingRegistrationTaskOutput) SetTaskId added in v1.12.36 

func (s *StartThingRegistrationTaskOutput) SetTaskId(v string) *StartThingRegistrationTaskOutput

SetTaskId sets the TaskId field's value.

func (StartThingRegistrationTaskOutput) String added in v1.12.36 

func (s StartThingRegistrationTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatisticalThreshold added in v1.17.1 

type StatisticalThreshold struct {

	// The percentile that resolves to a threshold value by which compliance with
	// a behavior is determined. Metrics are collected over the specified period
	// (durationSeconds) from all reporting devices in your account and statistical
	// ranks are calculated. Then, the measurements from a device are collected
	// over the same period. If the accumulated measurements from the device fall
	// above or below (comparisonOperator) the value associated with the percentile
	// specified, then the device is considered to be in compliance with the behavior,
	// otherwise a violation occurs.
	Statistic *string `locationName:"statistic" type:"string"`
	// contains filtered or unexported fields
}

A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

func (StatisticalThreshold) GoString added in v1.17.1 

func (s StatisticalThreshold) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatisticalThreshold) SetStatistic added in v1.17.1 

func (s *StatisticalThreshold) SetStatistic(v string) *StatisticalThreshold

SetStatistic sets the Statistic field's value.

func (StatisticalThreshold) String added in v1.17.1 

func (s StatisticalThreshold) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Statistics added in v1.19.0 

type Statistics struct {

	// The average of the aggregated field values.
	Average *float64 `locationName:"average" type:"double"`

	// The count of things that match the query string criteria and contain a valid
	// aggregation field value.
	Count *int64 `locationName:"count" type:"integer"`

	// The maximum aggregated field value.
	Maximum *float64 `locationName:"maximum" type:"double"`

	// The minimum aggregated field value.
	Minimum *float64 `locationName:"minimum" type:"double"`

	// The standard deviation of the aggregated field values.
	StdDeviation *float64 `locationName:"stdDeviation" type:"double"`

	// The sum of the aggregated field values.
	Sum *float64 `locationName:"sum" type:"double"`

	// The sum of the squares of the aggregated field values.
	SumOfSquares *float64 `locationName:"sumOfSquares" type:"double"`

	// The variance of the aggregated field values.
	Variance *float64 `locationName:"variance" type:"double"`
	// contains filtered or unexported fields
}

A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, consult Fleet indexing troubleshooting guide (https://docs.aws.amazon.com/iot/latest/developerguide/fleet-indexing-troubleshooting.html).

func (Statistics) GoString added in v1.19.0 

func (s Statistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Statistics) SetAverage added in v1.25.34 

func (s *Statistics) SetAverage(v float64) *Statistics

SetAverage sets the Average field's value.

func (*Statistics) SetCount added in v1.19.0 

func (s *Statistics) SetCount(v int64) *Statistics

SetCount sets the Count field's value.

func (*Statistics) SetMaximum added in v1.25.34 

func (s *Statistics) SetMaximum(v float64) *Statistics

SetMaximum sets the Maximum field's value.

func (*Statistics) SetMinimum added in v1.25.34 

func (s *Statistics) SetMinimum(v float64) *Statistics

SetMinimum sets the Minimum field's value.

func (*Statistics) SetStdDeviation added in v1.25.34 

func (s *Statistics) SetStdDeviation(v float64) *Statistics

SetStdDeviation sets the StdDeviation field's value.

func (*Statistics) SetSum added in v1.25.34 

func (s *Statistics) SetSum(v float64) *Statistics

SetSum sets the Sum field's value.

func (*Statistics) SetSumOfSquares added in v1.25.34 

func (s *Statistics) SetSumOfSquares(v float64) *Statistics

SetSumOfSquares sets the SumOfSquares field's value.

func (*Statistics) SetVariance added in v1.25.34 

func (s *Statistics) SetVariance(v float64) *Statistics

SetVariance sets the Variance field's value.

func (Statistics) String added in v1.19.0 

func (s Statistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StepFunctionsAction added in v1.15.2 

type StepFunctionsAction struct {

	// (Optional) A name will be given to the state machine execution consisting
	// of this prefix followed by a UUID. Step Functions automatically creates a
	// unique name for each state machine execution if one is not provided.
	ExecutionNamePrefix *string `locationName:"executionNamePrefix" type:"string"`

	// The ARN of the role that grants IoT permission to start execution of a state
	// machine ("Action":"states:StartExecution").
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the Step Functions state machine whose execution will be started.
	//
	// StateMachineName is a required field
	StateMachineName *string `locationName:"stateMachineName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Starts execution of a Step Functions state machine.

func (StepFunctionsAction) GoString added in v1.15.2 

func (s StepFunctionsAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepFunctionsAction) SetExecutionNamePrefix added in v1.15.2 

func (s *StepFunctionsAction) SetExecutionNamePrefix(v string) *StepFunctionsAction

SetExecutionNamePrefix sets the ExecutionNamePrefix field's value.

func (*StepFunctionsAction) SetRoleArn added in v1.15.2 

func (s *StepFunctionsAction) SetRoleArn(v string) *StepFunctionsAction

SetRoleArn sets the RoleArn field's value.

func (*StepFunctionsAction) SetStateMachineName added in v1.15.2 

func (s *StepFunctionsAction) SetStateMachineName(v string) *StepFunctionsAction

SetStateMachineName sets the StateMachineName field's value.

func (StepFunctionsAction) String added in v1.15.2 

func (s StepFunctionsAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepFunctionsAction) Validate added in v1.15.2 

func (s *StepFunctionsAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 

func (s StopThingRegistrationTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopThingRegistrationTaskInput) SetTaskId added in v1.12.36 

func (s *StopThingRegistrationTaskInput) SetTaskId(v string) *StopThingRegistrationTaskInput

SetTaskId sets the TaskId field's value.

func (StopThingRegistrationTaskInput) String added in v1.12.36 

func (s StopThingRegistrationTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s StopThingRegistrationTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopThingRegistrationTaskOutput) String added in v1.12.36 

func (s StopThingRegistrationTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// 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"`

	// An IAM role 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.15.79 

type Tag struct {

	// The tag's key.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The tag's value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A set of key/value pairs that are used to manage the resource.

func (Tag) GoString added in v1.15.79 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.15.79 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.15.79 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.15.79 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.30.18 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.15.79 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The new or modified tags for the resource.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.15.79 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.15.79 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.15.79 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.15.79 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.15.79 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.15.79 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.15.79 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.15.79 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskAlreadyExistsException added in v1.28.0 

type TaskAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

func (*TaskAlreadyExistsException) Code added in v1.28.0 

func (s *TaskAlreadyExistsException) Code() string

Code returns the exception type name.

func (*TaskAlreadyExistsException) Error added in v1.28.0 

func (s *TaskAlreadyExistsException) Error() string

func (TaskAlreadyExistsException) GoString added in v1.28.0 

func (s TaskAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskAlreadyExistsException) Message added in v1.28.0 

func (s *TaskAlreadyExistsException) Message() string

Message returns the exception's message.

func (*TaskAlreadyExistsException) OrigErr added in v1.28.0 

func (s *TaskAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TaskAlreadyExistsException) RequestID added in v1.28.0 

func (s *TaskAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TaskAlreadyExistsException) StatusCode added in v1.28.0 

func (s *TaskAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TaskAlreadyExistsException) String added in v1.28.0 

func (s TaskAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskStatistics added in v1.15.2 

type TaskStatistics struct {

	// The number of checks that did not run because the audit was canceled.
	CanceledChecks *int64 `locationName:"canceledChecks" type:"integer"`

	// The number of checks that found compliant resources.
	CompliantChecks *int64 `locationName:"compliantChecks" type:"integer"`

	// The number of checks.
	FailedChecks *int64 `locationName:"failedChecks" type:"integer"`

	// The number of checks in progress.
	InProgressChecks *int64 `locationName:"inProgressChecks" type:"integer"`

	// The number of checks that found noncompliant resources.
	NonCompliantChecks *int64 `locationName:"nonCompliantChecks" type:"integer"`

	// The number of checks in this audit.
	TotalChecks *int64 `locationName:"totalChecks" type:"integer"`

	// The number of checks waiting for data collection.
	WaitingForDataCollectionChecks *int64 `locationName:"waitingForDataCollectionChecks" type:"integer"`
	// contains filtered or unexported fields
}

Statistics for the checks performed during the audit.

func (TaskStatistics) GoString added in v1.15.2 

func (s TaskStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskStatistics) SetCanceledChecks added in v1.15.2 

func (s *TaskStatistics) SetCanceledChecks(v int64) *TaskStatistics

SetCanceledChecks sets the CanceledChecks field's value.

func (*TaskStatistics) SetCompliantChecks added in v1.15.2 

func (s *TaskStatistics) SetCompliantChecks(v int64) *TaskStatistics

SetCompliantChecks sets the CompliantChecks field's value.

func (*TaskStatistics) SetFailedChecks added in v1.15.2 

func (s *TaskStatistics) SetFailedChecks(v int64) *TaskStatistics

SetFailedChecks sets the FailedChecks field's value.

func (*TaskStatistics) SetInProgressChecks added in v1.15.2 

func (s *TaskStatistics) SetInProgressChecks(v int64) *TaskStatistics

SetInProgressChecks sets the InProgressChecks field's value.

func (*TaskStatistics) SetNonCompliantChecks added in v1.15.2 

func (s *TaskStatistics) SetNonCompliantChecks(v int64) *TaskStatistics

SetNonCompliantChecks sets the NonCompliantChecks field's value.

func (*TaskStatistics) SetTotalChecks added in v1.15.2 

func (s *TaskStatistics) SetTotalChecks(v int64) *TaskStatistics

SetTotalChecks sets the TotalChecks field's value.

func (*TaskStatistics) SetWaitingForDataCollectionChecks added in v1.15.2 

func (s *TaskStatistics) SetWaitingForDataCollectionChecks(v int64) *TaskStatistics

SetWaitingForDataCollectionChecks sets the WaitingForDataCollectionChecks field's value.

func (TaskStatistics) String added in v1.15.2 

func (s TaskStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskStatisticsForAuditCheck added in v1.21.10 

type TaskStatisticsForAuditCheck struct {

	// The number of findings to which the mitigation action task was canceled when
	// applied.
	CanceledFindingsCount *int64 `locationName:"canceledFindingsCount" type:"long"`

	// The number of findings for which at least one of the actions failed when
	// applied.
	FailedFindingsCount *int64 `locationName:"failedFindingsCount" type:"long"`

	// The number of findings skipped because of filter conditions provided in the
	// parameters to the command.
	SkippedFindingsCount *int64 `locationName:"skippedFindingsCount" type:"long"`

	// The number of findings for which all mitigation actions succeeded when applied.
	SucceededFindingsCount *int64 `locationName:"succeededFindingsCount" type:"long"`

	// The total number of findings to which a task is being applied.
	TotalFindingsCount *int64 `locationName:"totalFindingsCount" type:"long"`
	// contains filtered or unexported fields
}

Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

func (TaskStatisticsForAuditCheck) GoString added in v1.21.10 

func (s TaskStatisticsForAuditCheck) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskStatisticsForAuditCheck) SetCanceledFindingsCount added in v1.21.10 

func (s *TaskStatisticsForAuditCheck) SetCanceledFindingsCount(v int64) *TaskStatisticsForAuditCheck

SetCanceledFindingsCount sets the CanceledFindingsCount field's value.

func (*TaskStatisticsForAuditCheck) SetFailedFindingsCount added in v1.21.10 

func (s *TaskStatisticsForAuditCheck) SetFailedFindingsCount(v int64) *TaskStatisticsForAuditCheck

SetFailedFindingsCount sets the FailedFindingsCount field's value.

func (*TaskStatisticsForAuditCheck) SetSkippedFindingsCount added in v1.21.10 

func (s *TaskStatisticsForAuditCheck) SetSkippedFindingsCount(v int64) *TaskStatisticsForAuditCheck

SetSkippedFindingsCount sets the SkippedFindingsCount field's value.

func (*TaskStatisticsForAuditCheck) SetSucceededFindingsCount added in v1.21.10 

func (s *TaskStatisticsForAuditCheck) SetSucceededFindingsCount(v int64) *TaskStatisticsForAuditCheck

SetSucceededFindingsCount sets the SucceededFindingsCount field's value.

func (*TaskStatisticsForAuditCheck) SetTotalFindingsCount added in v1.21.10 

func (s *TaskStatisticsForAuditCheck) SetTotalFindingsCount(v int64) *TaskStatisticsForAuditCheck

SetTotalFindingsCount sets the TotalFindingsCount field's value.

func (TaskStatisticsForAuditCheck) String added in v1.21.10 

func (s TaskStatisticsForAuditCheck) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TermsAggregation added in v1.40.34 

type TermsAggregation struct {

	// The number of buckets to return in the response. Default to 10.
	MaxBuckets *int64 `locationName:"maxBuckets" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

func (TermsAggregation) GoString added in v1.40.34 

func (s TermsAggregation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TermsAggregation) SetMaxBuckets added in v1.40.34 

func (s *TermsAggregation) SetMaxBuckets(v int64) *TermsAggregation

SetMaxBuckets sets the MaxBuckets field's value.

func (TermsAggregation) String added in v1.40.34 

func (s TermsAggregation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TermsAggregation) Validate added in v1.40.34 

func (s *TermsAggregation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
	// thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId
	// (region:id).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestAuthorizationInput) SetAuthInfos added in v1.12.36 

func (s *TestAuthorizationInput) SetAuthInfos(v []*AuthInfo) *TestAuthorizationInput

SetAuthInfos sets the AuthInfos field's value.

func (*TestAuthorizationInput) SetClientId added in v1.12.36 

func (s *TestAuthorizationInput) SetClientId(v string) *TestAuthorizationInput

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 

func (s *TestAuthorizationInput) SetPrincipal(v string) *TestAuthorizationInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestAuthorizationOutput) SetAuthResults added in v1.12.36 

func (s *TestAuthorizationOutput) SetAuthResults(v []*AuthResult) *TestAuthorizationOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Specifies a test HTTP authorization request.
	HttpContext *HttpContext `locationName:"httpContext" type:"structure"`

	// Specifies a test MQTT authorization request.
	MqttContext *MqttContext `locationName:"mqttContext" type:"structure"`

	// Specifies a test TLS authorization request.
	TlsContext *TlsContext `locationName:"tlsContext" type:"structure"`

	// The token returned by your custom authentication service.
	Token *string `locationName:"token" min:"1" type:"string"`

	// The signature made with the token and your custom authentication service's
	// private key. This value must be Base-64-encoded.
	TokenSignature *string `locationName:"tokenSignature" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (TestInvokeAuthorizerInput) GoString added in v1.12.36 

func (s TestInvokeAuthorizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestInvokeAuthorizerInput) SetAuthorizerName added in v1.12.36 

func (s *TestInvokeAuthorizerInput) SetAuthorizerName(v string) *TestInvokeAuthorizerInput

SetAuthorizerName sets the AuthorizerName field's value.

func (*TestInvokeAuthorizerInput) SetHttpContext added in v1.25.42 

func (s *TestInvokeAuthorizerInput) SetHttpContext(v *HttpContext) *TestInvokeAuthorizerInput

SetHttpContext sets the HttpContext field's value.

func (*TestInvokeAuthorizerInput) SetMqttContext added in v1.25.42 

func (s *TestInvokeAuthorizerInput) SetMqttContext(v *MqttContext) *TestInvokeAuthorizerInput

SetMqttContext sets the MqttContext field's value.

func (*TestInvokeAuthorizerInput) SetTlsContext added in v1.25.42 

func (s *TestInvokeAuthorizerInput) SetTlsContext(v *TlsContext) *TestInvokeAuthorizerInput

SetTlsContext sets the TlsContext field's value.

func (*TestInvokeAuthorizerInput) SetToken added in v1.12.36 

func (s *TestInvokeAuthorizerInput) SetToken(v string) *TestInvokeAuthorizerInput

SetToken sets the Token field's value.

func (*TestInvokeAuthorizerInput) SetTokenSignature added in v1.12.36 

func (s *TestInvokeAuthorizerInput) SetTokenSignature(v string) *TestInvokeAuthorizerInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *TestInvokeAuthorizerOutput) SetIsAuthenticated(v bool) *TestInvokeAuthorizerOutput

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 

func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput

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 

func (s TestInvokeAuthorizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThingConnectivity added in v1.15.79 

type ThingConnectivity struct {

	// True if the thing is connected to the Amazon Web Services IoT Core service;
	// false if it is not connected.
	Connected *bool `locationName:"connected" type:"boolean"`

	// The reason why the client is disconnected. If the thing has been disconnected
	// for approximately an hour, the disconnectReason value might be missing.
	DisconnectReason *string `locationName:"disconnectReason" type:"string"`

	// The epoch time (in milliseconds) when the thing last connected or disconnected.
	// If the thing has been disconnected for approximately an hour, the time value
	// might be missing.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

The connectivity status of the thing.

func (ThingConnectivity) GoString added in v1.15.79 

func (s ThingConnectivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingConnectivity) SetConnected added in v1.15.79 

func (s *ThingConnectivity) SetConnected(v bool) *ThingConnectivity

SetConnected sets the Connected field's value.

func (*ThingConnectivity) SetDisconnectReason added in v1.40.34 

func (s *ThingConnectivity) SetDisconnectReason(v string) *ThingConnectivity

SetDisconnectReason sets the DisconnectReason field's value.

func (*ThingConnectivity) SetTimestamp added in v1.15.79 

func (s *ThingConnectivity) SetTimestamp(v int64) *ThingConnectivity

SetTimestamp sets the Timestamp field's value.

func (ThingConnectivity) String added in v1.15.79 

func (s ThingConnectivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThingDocument added in v1.12.36 

type ThingDocument struct {

	// The attributes.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Indicates whether the thing is connected to the Amazon Web Services IoT Core
	// service.
	Connectivity *ThingConnectivity `locationName:"connectivity" type:"structure"`

	// Contains Device Defender data.
	//
	// For more information about Device Defender, see Device Defender (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html).
	DeviceDefender *string `locationName:"deviceDefender" type:"string"`

	// The unnamed shadow and named shadow.
	//
	// For more information about shadows, see IoT Device Shadow service. (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html)
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetConnectivity added in v1.15.79 

func (s *ThingDocument) SetConnectivity(v *ThingConnectivity) *ThingDocument

SetConnectivity sets the Connectivity field's value.

func (*ThingDocument) SetDeviceDefender added in v1.42.16 

func (s *ThingDocument) SetDeviceDefender(v string) *ThingDocument

SetDeviceDefender sets the DeviceDefender 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThingGroupDocument added in v1.15.19 

type ThingGroupDocument struct {

	// The thing group attributes.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Parent group names.
	ParentGroupNames []*string `locationName:"parentGroupNames" type:"list"`

	// The thing group description.
	ThingGroupDescription *string `locationName:"thingGroupDescription" 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
}

The thing group search index document.

func (ThingGroupDocument) GoString added in v1.15.19 

func (s ThingGroupDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingGroupDocument) SetAttributes added in v1.15.19 

func (s *ThingGroupDocument) SetAttributes(v map[string]*string) *ThingGroupDocument

SetAttributes sets the Attributes field's value.

func (*ThingGroupDocument) SetParentGroupNames added in v1.15.19 

func (s *ThingGroupDocument) SetParentGroupNames(v []*string) *ThingGroupDocument

SetParentGroupNames sets the ParentGroupNames field's value.

func (*ThingGroupDocument) SetThingGroupDescription added in v1.15.19 

func (s *ThingGroupDocument) SetThingGroupDescription(v string) *ThingGroupDocument

SetThingGroupDescription sets the ThingGroupDescription field's value.

func (*ThingGroupDocument) SetThingGroupId added in v1.15.19 

func (s *ThingGroupDocument) SetThingGroupId(v string) *ThingGroupDocument

SetThingGroupId sets the ThingGroupId field's value.

func (*ThingGroupDocument) SetThingGroupName added in v1.15.19 

func (s *ThingGroupDocument) SetThingGroupName(v string) *ThingGroupDocument

SetThingGroupName sets the ThingGroupName field's value.

func (ThingGroupDocument) String added in v1.15.19 

func (s ThingGroupDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThingGroupIndexingConfiguration added in v1.15.19 

type ThingGroupIndexingConfiguration struct {

	// A list of thing group fields to index. This list cannot contain any managed
	// fields. Use the GetIndexingConfiguration API to get a list of managed fields.
	//
	// Contains custom field names and their data type.
	CustomFields []*Field `locationName:"customFields" type:"list"`

	// Contains fields that are indexed and whose types are already known by the
	// Fleet Indexing service.
	ManagedFields []*Field `locationName:"managedFields" type:"list"`

	// Thing group indexing mode.
	//
	// ThingGroupIndexingMode is a required field
	ThingGroupIndexingMode *string `locationName:"thingGroupIndexingMode" type:"string" required:"true" enum:"ThingGroupIndexingMode"`
	// contains filtered or unexported fields
}

Thing group indexing configuration.

func (ThingGroupIndexingConfiguration) GoString added in v1.15.19 

func (s ThingGroupIndexingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingGroupIndexingConfiguration) SetCustomFields added in v1.25.34 

func (s *ThingGroupIndexingConfiguration) SetCustomFields(v []*Field) *ThingGroupIndexingConfiguration

SetCustomFields sets the CustomFields field's value.

func (*ThingGroupIndexingConfiguration) SetManagedFields added in v1.25.34 

func (s *ThingGroupIndexingConfiguration) SetManagedFields(v []*Field) *ThingGroupIndexingConfiguration

SetManagedFields sets the ManagedFields field's value.

func (*ThingGroupIndexingConfiguration) SetThingGroupIndexingMode added in v1.15.19 

func (s *ThingGroupIndexingConfiguration) SetThingGroupIndexingMode(v string) *ThingGroupIndexingConfiguration

SetThingGroupIndexingMode sets the ThingGroupIndexingMode field's value.

func (ThingGroupIndexingConfiguration) String added in v1.15.19 

func (s ThingGroupIndexingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingGroupIndexingConfiguration) Validate added in v1.15.19 

func (s *ThingGroupIndexingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThingIndexingConfiguration added in v1.12.36 

type ThingIndexingConfiguration struct {

	// Contains custom field names and their data type.
	CustomFields []*Field `locationName:"customFields" type:"list"`

	// Device Defender indexing mode. Valid values are:
	//
	//    * VIOLATIONS – Your thing index contains Device Defender violations.
	//    To enable Device Defender indexing, deviceDefenderIndexingMode must not
	//    be set to OFF.
	//
	//    * OFF - Device Defender indexing is disabled.
	//
	// For more information about Device Defender violations, see Device Defender
	// Detect. (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html)
	DeviceDefenderIndexingMode *string `locationName:"deviceDefenderIndexingMode" type:"string" enum:"DeviceDefenderIndexingMode"`

	// Contains fields that are indexed and whose types are already known by the
	// Fleet Indexing service.
	ManagedFields []*Field `locationName:"managedFields" type:"list"`

	// Named shadow indexing mode. Valid values are:
	//
	//    * ON – Your thing index contains named shadow. To enable thing named
	//    shadow indexing, namedShadowIndexingMode must not be set to OFF.
	//
	//    * OFF - Named shadow indexing is disabled.
	//
	// For more information about Shadows, see IoT Device Shadow service. (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html)
	NamedShadowIndexingMode *string `locationName:"namedShadowIndexingMode" type:"string" enum:"NamedShadowIndexingMode"`

	// Thing connectivity indexing mode. Valid values are:
	//
	//    * STATUS – Your thing index contains connectivity status. To enable
	//    thing connectivity indexing, thingIndexMode must not be set to OFF.
	//
	//    * OFF - Thing connectivity status indexing is disabled.
	ThingConnectivityIndexingMode *string `locationName:"thingConnectivityIndexingMode" type:"string" enum:"ThingConnectivityIndexingMode"`

	// Thing indexing mode. Valid values are:
	//
	//    * REGISTRY – Your thing index contains registry data only.
	//
	//    * REGISTRY_AND_SHADOW - Your thing index contains registry and shadow
	//    data.
	//
	//    * OFF - Thing indexing is disabled.
	//
	// ThingIndexingMode is a required field
	ThingIndexingMode *string `locationName:"thingIndexingMode" type:"string" required:"true" enum:"ThingIndexingMode"`
	// contains filtered or unexported fields
}

The thing indexing configuration. For more information, see Managing Thing Indexing (https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html).

func (ThingIndexingConfiguration) GoString added in v1.12.36 

func (s ThingIndexingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingIndexingConfiguration) SetCustomFields added in v1.25.34 

func (s *ThingIndexingConfiguration) SetCustomFields(v []*Field) *ThingIndexingConfiguration

SetCustomFields sets the CustomFields field's value.

func (*ThingIndexingConfiguration) SetDeviceDefenderIndexingMode added in v1.42.16 

func (s *ThingIndexingConfiguration) SetDeviceDefenderIndexingMode(v string) *ThingIndexingConfiguration

SetDeviceDefenderIndexingMode sets the DeviceDefenderIndexingMode field's value.

func (*ThingIndexingConfiguration) SetManagedFields added in v1.25.34 

func (s *ThingIndexingConfiguration) SetManagedFields(v []*Field) *ThingIndexingConfiguration

SetManagedFields sets the ManagedFields field's value.

func (*ThingIndexingConfiguration) SetNamedShadowIndexingMode added in v1.42.16 

func (s *ThingIndexingConfiguration) SetNamedShadowIndexingMode(v string) *ThingIndexingConfiguration

SetNamedShadowIndexingMode sets the NamedShadowIndexingMode field's value.

func (*ThingIndexingConfiguration) SetThingConnectivityIndexingMode added in v1.15.79 

func (s *ThingIndexingConfiguration) SetThingConnectivityIndexingMode(v string) *ThingIndexingConfiguration

SetThingConnectivityIndexingMode sets the ThingConnectivityIndexingMode field's value.

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 

func (s ThingIndexingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThingIndexingConfiguration) Validate added in v1.15.19 

func (s *ThingIndexingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// 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"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The rate exceeds the limit.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeoutConfig added in v1.15.50 

type TimeoutConfig struct {

	// Specifies the amount of time, in minutes, this device has to finish execution
	// of this job. The timeout interval can be anywhere between 1 minute and 7
	// days (1 to 10080 minutes). The in progress timer can't be updated and will
	// apply to all job executions for the job. Whenever a job execution remains
	// in the IN_PROGRESS status for longer than this interval, the job execution
	// will fail and switch to the terminal TIMED_OUT status.
	InProgressTimeoutInMinutes *int64 `locationName:"inProgressTimeoutInMinutes" type:"long"`
	// contains filtered or unexported fields
}

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

func (TimeoutConfig) GoString added in v1.15.50 

func (s TimeoutConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeoutConfig) SetInProgressTimeoutInMinutes added in v1.15.50 

func (s *TimeoutConfig) SetInProgressTimeoutInMinutes(v int64) *TimeoutConfig

SetInProgressTimeoutInMinutes sets the InProgressTimeoutInMinutes field's value.

func (TimeoutConfig) String added in v1.15.50 

func (s TimeoutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimestreamAction added in v1.35.0 

type TimestreamAction struct {

	// The name of an Amazon Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `locationName:"databaseName" type:"string" required:"true"`

	// Metadata attributes of the time series that are written in each measure record.
	//
	// Dimensions is a required field
	Dimensions []*TimestreamDimension `locationName:"dimensions" min:"1" type:"list" required:"true"`

	// The ARN of the role that grants permission to write to the Amazon Timestream
	// database table.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The name of the database table into which to write the measure records.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" type:"string" required:"true"`

	// Specifies an application-defined value to replace the default value assigned
	// to the Timestream record's timestamp in the time column.
	//
	// You can use this property to specify the value and the precision of the Timestream
	// record's timestamp. You can specify a value from the message payload or a
	// value computed by a substitution template.
	//
	// If omitted, the topic rule action assigns the timestamp, in milliseconds,
	// at the time it processed the rule.
	Timestamp *TimestreamTimestamp `locationName:"timestamp" type:"structure"`
	// contains filtered or unexported fields
}

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) topic rule action documentation.

func (TimestreamAction) GoString added in v1.35.0 

func (s TimestreamAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamAction) SetDatabaseName added in v1.35.0 

func (s *TimestreamAction) SetDatabaseName(v string) *TimestreamAction

SetDatabaseName sets the DatabaseName field's value.

func (*TimestreamAction) SetDimensions added in v1.35.0 

func (s *TimestreamAction) SetDimensions(v []*TimestreamDimension) *TimestreamAction

SetDimensions sets the Dimensions field's value.

func (*TimestreamAction) SetRoleArn added in v1.35.0 

func (s *TimestreamAction) SetRoleArn(v string) *TimestreamAction

SetRoleArn sets the RoleArn field's value.

func (*TimestreamAction) SetTableName added in v1.35.0 

func (s *TimestreamAction) SetTableName(v string) *TimestreamAction

SetTableName sets the TableName field's value.

func (*TimestreamAction) SetTimestamp added in v1.35.0 

func (s *TimestreamAction) SetTimestamp(v *TimestreamTimestamp) *TimestreamAction

SetTimestamp sets the Timestamp field's value.

func (TimestreamAction) String added in v1.35.0 

func (s TimestreamAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamAction) Validate added in v1.35.0 

func (s *TimestreamAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimestreamDimension added in v1.35.0 

type TimestreamDimension struct {

	// The metadata dimension name. This is the name of the column in the Amazon
	// Timestream database table record.
	//
	// Dimensions cannot be named: measure_name, measure_value, or time. These names
	// are reserved. Dimension names cannot start with ts_ or measure_value and
	// they cannot contain the colon (:) character.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The value to write in this column of the database record.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata attributes of the time series that are written in each measure record.

func (TimestreamDimension) GoString added in v1.35.0 

func (s TimestreamDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamDimension) SetName added in v1.35.0 

func (s *TimestreamDimension) SetName(v string) *TimestreamDimension

SetName sets the Name field's value.

func (*TimestreamDimension) SetValue added in v1.35.0 

func (s *TimestreamDimension) SetValue(v string) *TimestreamDimension

SetValue sets the Value field's value.

func (TimestreamDimension) String added in v1.35.0 

func (s TimestreamDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamDimension) Validate added in v1.35.0 

func (s *TimestreamDimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimestreamTimestamp added in v1.35.0 

type TimestreamTimestamp struct {

	// The precision of the timestamp value that results from the expression described
	// in value.
	//
	// Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default
	// is MILLISECONDS.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true"`

	// An expression that returns a long epoch time value.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.

func (TimestreamTimestamp) GoString added in v1.35.0 

func (s TimestreamTimestamp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamTimestamp) SetUnit added in v1.35.0 

func (s *TimestreamTimestamp) SetUnit(v string) *TimestreamTimestamp

SetUnit sets the Unit field's value.

func (*TimestreamTimestamp) SetValue added in v1.35.0 

func (s *TimestreamTimestamp) SetValue(v string) *TimestreamTimestamp

SetValue sets the Value field's value.

func (TimestreamTimestamp) String added in v1.35.0 

func (s TimestreamTimestamp) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimestreamTimestamp) Validate added in v1.35.0 

func (s *TimestreamTimestamp) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TlsContext added in v1.25.42 

type TlsContext struct {

	// The value of the serverName key in a TLS authorization request.
	ServerName *string `locationName:"serverName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the TLS context to use for the test authorizer request.

func (TlsContext) GoString added in v1.25.42 

func (s TlsContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TlsContext) SetServerName added in v1.25.42 

func (s *TlsContext) SetServerName(v string) *TlsContext

SetServerName sets the ServerName field's value.

func (TlsContext) String added in v1.25.42 

func (s TlsContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TlsContext) Validate added in v1.25.42 

func (s *TlsContext) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TopicRuleDestination added in v1.25.38 

type TopicRuleDestination struct {

	// The topic rule destination URL.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time when the topic rule destination was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Properties of the HTTP URL.
	HttpUrlProperties *HttpUrlDestinationProperties `locationName:"httpUrlProperties" type:"structure"`

	// The date and time when the topic rule destination was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The status of the topic rule destination. Valid values are:
	//
	// IN_PROGRESS
	//
	// A topic rule destination was created but has not been confirmed. You can
	// set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	//
	// ENABLED
	//
	// Confirmation was completed, and traffic to this destination is allowed. You
	// can set status to DISABLED by calling UpdateTopicRuleDestination.
	//
	// DISABLED
	//
	// Confirmation was completed, and traffic to this destination is not allowed.
	// You can set status to ENABLED by calling UpdateTopicRuleDestination.
	//
	// ERROR
	//
	// Confirmation could not be completed, for example if the confirmation timed
	// out. You can call GetTopicRuleDestination for details about the error. You
	// can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	Status *string `locationName:"status" type:"string" enum:"TopicRuleDestinationStatus"`

	// Additional details or reason why the topic rule destination is in the current
	// status.
	StatusReason *string `locationName:"statusReason" type:"string"`

	// Properties of the virtual private cloud (VPC) connection.
	VpcProperties *VpcDestinationProperties `locationName:"vpcProperties" type:"structure"`
	// contains filtered or unexported fields
}

A topic rule destination.

func (TopicRuleDestination) GoString added in v1.25.38 

func (s TopicRuleDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TopicRuleDestination) SetArn added in v1.25.38 

func (s *TopicRuleDestination) SetArn(v string) *TopicRuleDestination

SetArn sets the Arn field's value.

func (*TopicRuleDestination) SetCreatedAt added in v1.36.9 

func (s *TopicRuleDestination) SetCreatedAt(v time.Time) *TopicRuleDestination

SetCreatedAt sets the CreatedAt field's value.

func (*TopicRuleDestination) SetHttpUrlProperties added in v1.25.38 

func (s *TopicRuleDestination) SetHttpUrlProperties(v *HttpUrlDestinationProperties) *TopicRuleDestination

SetHttpUrlProperties sets the HttpUrlProperties field's value.

func (*TopicRuleDestination) SetLastUpdatedAt added in v1.36.9 

func (s *TopicRuleDestination) SetLastUpdatedAt(v time.Time) *TopicRuleDestination

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*TopicRuleDestination) SetStatus added in v1.25.38 

func (s *TopicRuleDestination) SetStatus(v string) *TopicRuleDestination

SetStatus sets the Status field's value.

func (*TopicRuleDestination) SetStatusReason added in v1.25.38 

func (s *TopicRuleDestination) SetStatusReason(v string) *TopicRuleDestination

SetStatusReason sets the StatusReason field's value.

func (*TopicRuleDestination) SetVpcProperties added in v1.36.9 

func (s *TopicRuleDestination) SetVpcProperties(v *VpcDestinationProperties) *TopicRuleDestination

SetVpcProperties sets the VpcProperties field's value.

func (TopicRuleDestination) String added in v1.25.38 

func (s TopicRuleDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TopicRuleDestinationConfiguration added in v1.25.38 

type TopicRuleDestinationConfiguration struct {

	// Configuration of the HTTP URL.
	HttpUrlConfiguration *HttpUrlDestinationConfiguration `locationName:"httpUrlConfiguration" type:"structure"`

	// Configuration of the virtual private cloud (VPC) connection.
	VpcConfiguration *VpcDestinationConfiguration `locationName:"vpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Configuration of the topic rule destination.

func (TopicRuleDestinationConfiguration) GoString added in v1.25.38 

func (s TopicRuleDestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TopicRuleDestinationConfiguration) SetHttpUrlConfiguration added in v1.25.38 

func (s *TopicRuleDestinationConfiguration) SetHttpUrlConfiguration(v *HttpUrlDestinationConfiguration) *TopicRuleDestinationConfiguration

SetHttpUrlConfiguration sets the HttpUrlConfiguration field's value.

func (*TopicRuleDestinationConfiguration) SetVpcConfiguration added in v1.36.9 

func (s *TopicRuleDestinationConfiguration) SetVpcConfiguration(v *VpcDestinationConfiguration) *TopicRuleDestinationConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (TopicRuleDestinationConfiguration) String added in v1.25.38 

func (s TopicRuleDestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TopicRuleDestinationConfiguration) Validate added in v1.25.38 

func (s *TopicRuleDestinationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TopicRuleDestinationSummary added in v1.25.38 

type TopicRuleDestinationSummary struct {

	// The topic rule destination ARN.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time when the topic rule destination was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Information about the HTTP URL.
	HttpUrlSummary *HttpUrlDestinationSummary `locationName:"httpUrlSummary" type:"structure"`

	// The date and time when the topic rule destination was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The status of the topic rule destination. Valid values are:
	//
	// IN_PROGRESS
	//
	// A topic rule destination was created but has not been confirmed. You can
	// set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	//
	// ENABLED
	//
	// Confirmation was completed, and traffic to this destination is allowed. You
	// can set status to DISABLED by calling UpdateTopicRuleDestination.
	//
	// DISABLED
	//
	// Confirmation was completed, and traffic to this destination is not allowed.
	// You can set status to ENABLED by calling UpdateTopicRuleDestination.
	//
	// ERROR
	//
	// Confirmation could not be completed, for example if the confirmation timed
	// out. You can call GetTopicRuleDestination for details about the error. You
	// can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	Status *string `locationName:"status" type:"string" enum:"TopicRuleDestinationStatus"`

	// The reason the topic rule destination is in the current status.
	StatusReason *string `locationName:"statusReason" type:"string"`

	// Information about the virtual private cloud (VPC) connection.
	VpcDestinationSummary *VpcDestinationSummary `locationName:"vpcDestinationSummary" type:"structure"`
	// contains filtered or unexported fields
}

Information about the topic rule destination.

func (TopicRuleDestinationSummary) GoString added in v1.25.38 

func (s TopicRuleDestinationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TopicRuleDestinationSummary) SetArn added in v1.25.38 

func (s *TopicRuleDestinationSummary) SetArn(v string) *TopicRuleDestinationSummary

SetArn sets the Arn field's value.

func (*TopicRuleDestinationSummary) SetCreatedAt added in v1.36.9 

func (s *TopicRuleDestinationSummary) SetCreatedAt(v time.Time) *TopicRuleDestinationSummary

SetCreatedAt sets the CreatedAt field's value.

func (*TopicRuleDestinationSummary) SetHttpUrlSummary added in v1.25.38 

func (s *TopicRuleDestinationSummary) SetHttpUrlSummary(v *HttpUrlDestinationSummary) *TopicRuleDestinationSummary

SetHttpUrlSummary sets the HttpUrlSummary field's value.

func (*TopicRuleDestinationSummary) SetLastUpdatedAt added in v1.36.9 

func (s *TopicRuleDestinationSummary) SetLastUpdatedAt(v time.Time) *TopicRuleDestinationSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*TopicRuleDestinationSummary) SetStatus added in v1.25.38 

func (s *TopicRuleDestinationSummary) SetStatus(v string) *TopicRuleDestinationSummary

SetStatus sets the Status field's value.

func (*TopicRuleDestinationSummary) SetStatusReason added in v1.25.38 

func (s *TopicRuleDestinationSummary) SetStatusReason(v string) *TopicRuleDestinationSummary

SetStatusReason sets the StatusReason field's value.

func (*TopicRuleDestinationSummary) SetVpcDestinationSummary added in v1.36.9 

func (s *TopicRuleDestinationSummary) SetVpcDestinationSummary(v *VpcDestinationSummary) *TopicRuleDestinationSummary

SetVpcDestinationSummary sets the VpcDestinationSummary field's value.

func (TopicRuleDestinationSummary) String added in v1.25.38 

func (s TopicRuleDestinationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TopicRuleListItem 

type TopicRuleListItem struct {

	// The date and time the rule was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IoT
	// SQL Reference (https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html)
	// in the 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *TopicRulePayload) SetSql(v string) *TopicRulePayload

SetSql sets the Sql field's value.

func (TopicRulePayload) String 

func (s TopicRulePayload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 TransferAlreadyCompletedException added in v1.28.0 

type TransferAlreadyCompletedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't revert the certificate transfer because the transfer is already complete.

func (*TransferAlreadyCompletedException) Code added in v1.28.0 

func (s *TransferAlreadyCompletedException) Code() string

Code returns the exception type name.

func (*TransferAlreadyCompletedException) Error added in v1.28.0 

func (s *TransferAlreadyCompletedException) Error() string

func (TransferAlreadyCompletedException) GoString added in v1.28.0 

func (s TransferAlreadyCompletedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransferAlreadyCompletedException) Message added in v1.28.0 

func (s *TransferAlreadyCompletedException) Message() string

Message returns the exception's message.

func (*TransferAlreadyCompletedException) OrigErr added in v1.28.0 

func (s *TransferAlreadyCompletedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TransferAlreadyCompletedException) RequestID added in v1.28.0 

func (s *TransferAlreadyCompletedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TransferAlreadyCompletedException) StatusCode added in v1.28.0 

func (s *TransferAlreadyCompletedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TransferAlreadyCompletedException) String added in v1.28.0 

func (s TransferAlreadyCompletedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services account.
	//
	// TargetAwsAccount is a required field
	TargetAwsAccount *string `location:"querystring" locationName:"targetAwsAccount" min:"12" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransferCertificateInput) SetCertificateId added in v1.5.0 

func (s *TransferCertificateInput) SetCertificateId(v string) *TransferCertificateInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TransferConflictException added in v1.28.0 

type TransferConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't transfer the certificate because authorization policies are still attached.

func (*TransferConflictException) Code added in v1.28.0 

func (s *TransferConflictException) Code() string

Code returns the exception type name.

func (*TransferConflictException) Error added in v1.28.0 

func (s *TransferConflictException) Error() string

func (TransferConflictException) GoString added in v1.28.0 

func (s TransferConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransferConflictException) Message added in v1.28.0 

func (s *TransferConflictException) Message() string

Message returns the exception's message.

func (*TransferConflictException) OrigErr added in v1.28.0 

func (s *TransferConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TransferConflictException) RequestID added in v1.28.0 

func (s *TransferConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TransferConflictException) StatusCode added in v1.28.0 

func (s *TransferConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TransferConflictException) String added in v1.28.0 

func (s TransferConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TransferData added in v1.1.18 

type TransferData struct {

	// The date the transfer was accepted.
	AcceptDate *time.Time `locationName:"acceptDate" type:"timestamp"`

	// The date the transfer was rejected.
	RejectDate *time.Time `locationName:"rejectDate" type:"timestamp"`

	// 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"`

	// The transfer message.
	TransferMessage *string `locationName:"transferMessage" type:"string"`
	// contains filtered or unexported fields
}

Data used to transfer a certificate to an Amazon Web Services account.

func (TransferData) GoString added in v1.1.18 

func (s TransferData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedException added in v1.28.0 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized to perform this operation.

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.15.79 

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// A list of the keys of the tags to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.15.79 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.15.79 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.15.79 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.15.79 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.15.79 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.15.79 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.15.79 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.15.79 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccountAuditConfigurationInput added in v1.15.2 

type UpdateAccountAuditConfigurationInput struct {

	// Specifies which audit checks are enabled and disabled for this account. Use
	// DescribeAccountAuditConfiguration to see the list of all checks, including
	// those that are currently enabled.
	//
	// Some data collection might start immediately when certain checks are enabled.
	// When a check is disabled, any data collected so far in relation to the check
	// is deleted.
	//
	// You cannot disable a check if it's used by any scheduled audit. You must
	// first delete the check from the scheduled audit or delete the scheduled audit
	// itself.
	//
	// On the first call to UpdateAccountAuditConfiguration, this parameter is required
	// and must specify at least one enabled check.
	AuditCheckConfigurations map[string]*AuditCheckConfiguration `locationName:"auditCheckConfigurations" type:"map"`

	// Information about the targets to which audit notifications are sent.
	AuditNotificationTargetConfigurations map[string]*AuditNotificationTarget `locationName:"auditNotificationTargetConfigurations" type:"map"`

	// The Amazon Resource Name (ARN) of the role that grants permission to IoT
	// to access information about your devices, policies, certificates, and other
	// items as required when performing an audit.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAccountAuditConfigurationInput) GoString added in v1.15.2 

func (s UpdateAccountAuditConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountAuditConfigurationInput) SetAuditCheckConfigurations added in v1.15.2 

func (s *UpdateAccountAuditConfigurationInput) SetAuditCheckConfigurations(v map[string]*AuditCheckConfiguration) *UpdateAccountAuditConfigurationInput

SetAuditCheckConfigurations sets the AuditCheckConfigurations field's value.

func (*UpdateAccountAuditConfigurationInput) SetAuditNotificationTargetConfigurations added in v1.15.2 

func (s *UpdateAccountAuditConfigurationInput) SetAuditNotificationTargetConfigurations(v map[string]*AuditNotificationTarget) *UpdateAccountAuditConfigurationInput

SetAuditNotificationTargetConfigurations sets the AuditNotificationTargetConfigurations field's value.

func (*UpdateAccountAuditConfigurationInput) SetRoleArn added in v1.15.2 

func (s *UpdateAccountAuditConfigurationInput) SetRoleArn(v string) *UpdateAccountAuditConfigurationInput

SetRoleArn sets the RoleArn field's value.

func (UpdateAccountAuditConfigurationInput) String added in v1.15.2 

func (s UpdateAccountAuditConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountAuditConfigurationInput) Validate added in v1.15.2 

func (s *UpdateAccountAuditConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccountAuditConfigurationOutput added in v1.15.2 

type UpdateAccountAuditConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAccountAuditConfigurationOutput) GoString added in v1.15.2 

func (s UpdateAccountAuditConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAccountAuditConfigurationOutput) String added in v1.15.2 

func (s UpdateAccountAuditConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAuditSuppressionInput added in v1.34.3 

type UpdateAuditSuppressionInput struct {

	// An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration
	// to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	//
	// CheckName is a required field
	CheckName *string `locationName:"checkName" type:"string" required:"true"`

	// The description of the audit suppression.
	Description *string `locationName:"description" type:"string"`

	// The expiration date (epoch timestamp in seconds) that you want the suppression
	// to adhere to.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"`

	// Information that identifies the noncompliant resource.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *ResourceIdentifier `locationName:"resourceIdentifier" type:"structure" required:"true"`

	// Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool `locationName:"suppressIndefinitely" type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateAuditSuppressionInput) GoString added in v1.34.3 

func (s UpdateAuditSuppressionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAuditSuppressionInput) SetCheckName added in v1.34.3 

func (s *UpdateAuditSuppressionInput) SetCheckName(v string) *UpdateAuditSuppressionInput

SetCheckName sets the CheckName field's value.

func (*UpdateAuditSuppressionInput) SetDescription added in v1.34.3 

func (s *UpdateAuditSuppressionInput) SetDescription(v string) *UpdateAuditSuppressionInput

SetDescription sets the Description field's value.

func (*UpdateAuditSuppressionInput) SetExpirationDate added in v1.34.3 

func (s *UpdateAuditSuppressionInput) SetExpirationDate(v time.Time) *UpdateAuditSuppressionInput

SetExpirationDate sets the ExpirationDate field's value.

func (*UpdateAuditSuppressionInput) SetResourceIdentifier added in v1.34.3 

func (s *UpdateAuditSuppressionInput) SetResourceIdentifier(v *ResourceIdentifier) *UpdateAuditSuppressionInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*UpdateAuditSuppressionInput) SetSuppressIndefinitely added in v1.34.3 

func (s *UpdateAuditSuppressionInput) SetSuppressIndefinitely(v bool) *UpdateAuditSuppressionInput

SetSuppressIndefinitely sets the SuppressIndefinitely field's value.

func (UpdateAuditSuppressionInput) String added in v1.34.3 

func (s UpdateAuditSuppressionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAuditSuppressionInput) Validate added in v1.34.3 

func (s *UpdateAuditSuppressionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAuditSuppressionOutput added in v1.34.3 

type UpdateAuditSuppressionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAuditSuppressionOutput) GoString added in v1.34.3 

func (s UpdateAuditSuppressionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAuditSuppressionOutput) String added in v1.34.3 

func (s UpdateAuditSuppressionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// When true, the result from the authorizer’s Lambda function is cached for
	// the time specified in refreshAfterInSeconds. The cached result is used while
	// the device reuses the same HTTP connection.
	EnableCachingForHttp *bool `locationName:"enableCachingForHttp" type:"boolean"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEnableCachingForHttp added in v1.42.21 

func (s *UpdateAuthorizerInput) SetEnableCachingForHttp(v bool) *UpdateAuthorizerInput

SetEnableCachingForHttp sets the EnableCachingForHttp field's value.

func (*UpdateAuthorizerInput) SetStatus added in v1.12.36 

func (s *UpdateAuthorizerInput) SetStatus(v string) *UpdateAuthorizerInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBillingGroupInput added in v1.15.79 

type UpdateBillingGroupInput struct {

	// The name of the billing group.
	//
	// BillingGroupName is a required field
	BillingGroupName *string `location:"uri" locationName:"billingGroupName" min:"1" type:"string" required:"true"`

	// The properties of the billing group.
	//
	// BillingGroupProperties is a required field
	BillingGroupProperties *BillingGroupProperties `locationName:"billingGroupProperties" type:"structure" required:"true"`

	// The expected version of the billing group. If the version of the billing
	// group does not match the expected version specified in the request, the UpdateBillingGroup
	// request is rejected with a VersionConflictException.
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`
	// contains filtered or unexported fields
}

func (UpdateBillingGroupInput) GoString added in v1.15.79 

func (s UpdateBillingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBillingGroupInput) SetBillingGroupName added in v1.15.79 

func (s *UpdateBillingGroupInput) SetBillingGroupName(v string) *UpdateBillingGroupInput

SetBillingGroupName sets the BillingGroupName field's value.

func (*UpdateBillingGroupInput) SetBillingGroupProperties added in v1.15.79 

func (s *UpdateBillingGroupInput) SetBillingGroupProperties(v *BillingGroupProperties) *UpdateBillingGroupInput

SetBillingGroupProperties sets the BillingGroupProperties field's value.

func (*UpdateBillingGroupInput) SetExpectedVersion added in v1.15.79 

func (s *UpdateBillingGroupInput) SetExpectedVersion(v int64) *UpdateBillingGroupInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (UpdateBillingGroupInput) String added in v1.15.79 

func (s UpdateBillingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBillingGroupInput) Validate added in v1.15.79 

func (s *UpdateBillingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBillingGroupOutput added in v1.15.79 

type UpdateBillingGroupOutput struct {

	// The latest version of the billing group.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (UpdateBillingGroupOutput) GoString added in v1.15.79 

func (s UpdateBillingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBillingGroupOutput) SetVersion added in v1.15.79 

func (s *UpdateBillingGroupOutput) SetVersion(v int64) *UpdateBillingGroupOutput

SetVersion sets the Version field's value.

func (UpdateBillingGroupOutput) String added in v1.15.79 

func (s UpdateBillingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, removes 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCACertificateInput) SetCertificateId added in v1.5.0 

func (s *UpdateCACertificateInput) SetCertificateId(v string) *UpdateCACertificateInput

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 

func (s *UpdateCACertificateInput) SetNewStatus(v string) *UpdateCACertificateInput

SetNewStatus sets the NewStatus field's value.

func (*UpdateCACertificateInput) SetRegistrationConfig added in v1.12.36 

func (s *UpdateCACertificateInput) SetRegistrationConfig(v *RegistrationConfig) *UpdateCACertificateInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateCACertificateOutput) String added in v1.1.18 

func (s UpdateCACertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCACertificateParams added in v1.21.10 

type UpdateCACertificateParams struct {

	// The action that you want to apply to the CA certificate. The only supported
	// value is DEACTIVATE.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"CACertificateUpdateAction"`
	// contains filtered or unexported fields
}

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

func (UpdateCACertificateParams) GoString added in v1.21.10 

func (s UpdateCACertificateParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCACertificateParams) SetAction added in v1.21.10 

func (s *UpdateCACertificateParams) SetAction(v string) *UpdateCACertificateParams

SetAction sets the Action field's value.

func (UpdateCACertificateParams) String added in v1.21.10 

func (s UpdateCACertificateParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCACertificateParams) Validate added in v1.21.10 

func (s *UpdateCACertificateParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 or PENDING_ACTIVATION will result
	// in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are
	// statuses used internally by IoT. They are 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *UpdateCertificateInput) SetNewStatus(v string) *UpdateCertificateInput

SetNewStatus sets the NewStatus field's value.

func (UpdateCertificateInput) String 

func (s UpdateCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateCertificateOutput) String 

func (s UpdateCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCustomMetricInput added in v1.36.9 

type UpdateCustomMetricInput struct {

	// Field represents a friendly name in the console for the custom metric, it
	// doesn't have to be unique. Don't use this name as the metric identifier in
	// the device metric report. Can be updated.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" type:"string" required:"true"`

	// The name of the custom metric. Cannot be updated.
	//
	// MetricName is a required field
	MetricName *string `location:"uri" locationName:"metricName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCustomMetricInput) GoString added in v1.36.9 

func (s UpdateCustomMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCustomMetricInput) SetDisplayName added in v1.36.9 

func (s *UpdateCustomMetricInput) SetDisplayName(v string) *UpdateCustomMetricInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateCustomMetricInput) SetMetricName added in v1.36.9 

func (s *UpdateCustomMetricInput) SetMetricName(v string) *UpdateCustomMetricInput

SetMetricName sets the MetricName field's value.

func (UpdateCustomMetricInput) String added in v1.36.9 

func (s UpdateCustomMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCustomMetricInput) Validate added in v1.36.9 

func (s *UpdateCustomMetricInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCustomMetricOutput added in v1.36.9 

type UpdateCustomMetricOutput struct {

	// The creation date of the custom metric in milliseconds since epoch.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// A friendly name in the console for the custom metric
	DisplayName *string `locationName:"displayName" type:"string"`

	// The time the custom metric was last modified in milliseconds since epoch.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The Amazon Resource Number (ARN) of the custom metric.
	MetricArn *string `locationName:"metricArn" type:"string"`

	// The name of the custom metric.
	MetricName *string `locationName:"metricName" min:"1" type:"string"`

	// The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but while submitting
	// the metrics value in the DeviceMetrics report, it must be passed as an array
	// with a single value.
	MetricType *string `locationName:"metricType" type:"string" enum:"CustomMetricType"`
	// contains filtered or unexported fields
}

func (UpdateCustomMetricOutput) GoString added in v1.36.9 

func (s UpdateCustomMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCustomMetricOutput) SetCreationDate added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetCreationDate(v time.Time) *UpdateCustomMetricOutput

SetCreationDate sets the CreationDate field's value.

func (*UpdateCustomMetricOutput) SetDisplayName added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetDisplayName(v string) *UpdateCustomMetricOutput

SetDisplayName sets the DisplayName field's value.

func (*UpdateCustomMetricOutput) SetLastModifiedDate added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetLastModifiedDate(v time.Time) *UpdateCustomMetricOutput

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*UpdateCustomMetricOutput) SetMetricArn added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetMetricArn(v string) *UpdateCustomMetricOutput

SetMetricArn sets the MetricArn field's value.

func (*UpdateCustomMetricOutput) SetMetricName added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetMetricName(v string) *UpdateCustomMetricOutput

SetMetricName sets the MetricName field's value.

func (*UpdateCustomMetricOutput) SetMetricType added in v1.36.9 

func (s *UpdateCustomMetricOutput) SetMetricType(v string) *UpdateCustomMetricOutput

SetMetricType sets the MetricType field's value.

func (UpdateCustomMetricOutput) String added in v1.36.9 

func (s UpdateCustomMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDeviceCertificateParams added in v1.21.10 

type UpdateDeviceCertificateParams struct {

	// The action that you want to apply to the device certificate. The only supported
	// value is DEACTIVATE.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"DeviceCertificateUpdateAction"`
	// contains filtered or unexported fields
}

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

func (UpdateDeviceCertificateParams) GoString added in v1.21.10 

func (s UpdateDeviceCertificateParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDeviceCertificateParams) SetAction added in v1.21.10 

func (s *UpdateDeviceCertificateParams) SetAction(v string) *UpdateDeviceCertificateParams

SetAction sets the Action field's value.

func (UpdateDeviceCertificateParams) String added in v1.21.10 

func (s UpdateDeviceCertificateParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDeviceCertificateParams) Validate added in v1.21.10 

func (s *UpdateDeviceCertificateParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDimensionInput added in v1.30.2 

type UpdateDimensionInput struct {

	// A unique identifier for the dimension. Choose something that describes the
	// type and value to make it easy to remember what it does.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

	// Specifies the value or list of values for the dimension. For TOPIC_FILTER
	// dimensions, this is a pattern used to match the MQTT topic (for example,
	// "admin/#").
	//
	// StringValues is a required field
	StringValues []*string `locationName:"stringValues" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDimensionInput) GoString added in v1.30.2 

func (s UpdateDimensionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDimensionInput) SetName added in v1.30.2 

func (s *UpdateDimensionInput) SetName(v string) *UpdateDimensionInput

SetName sets the Name field's value.

func (*UpdateDimensionInput) SetStringValues added in v1.30.2 

func (s *UpdateDimensionInput) SetStringValues(v []*string) *UpdateDimensionInput

SetStringValues sets the StringValues field's value.

func (UpdateDimensionInput) String added in v1.30.2 

func (s UpdateDimensionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDimensionInput) Validate added in v1.30.2 

func (s *UpdateDimensionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDimensionOutput added in v1.30.2 

type UpdateDimensionOutput struct {

	// The Amazon Resource Name (ARN)of the created dimension.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time, in milliseconds since epoch, when the dimension was initially
	// created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The date and time, in milliseconds since epoch, when the dimension was most
	// recently updated.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// A unique identifier for the dimension.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The value or list of values used to scope the dimension. For example, for
	// topic filters, this is the pattern used to match the MQTT topic name.
	StringValues []*string `locationName:"stringValues" min:"1" type:"list"`

	// The type of the dimension.
	Type *string `locationName:"type" type:"string" enum:"DimensionType"`
	// contains filtered or unexported fields
}

func (UpdateDimensionOutput) GoString added in v1.30.2 

func (s UpdateDimensionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDimensionOutput) SetArn added in v1.30.2 

func (s *UpdateDimensionOutput) SetArn(v string) *UpdateDimensionOutput

SetArn sets the Arn field's value.

func (*UpdateDimensionOutput) SetCreationDate added in v1.30.2 

func (s *UpdateDimensionOutput) SetCreationDate(v time.Time) *UpdateDimensionOutput

SetCreationDate sets the CreationDate field's value.

func (*UpdateDimensionOutput) SetLastModifiedDate added in v1.30.2 

func (s *UpdateDimensionOutput) SetLastModifiedDate(v time.Time) *UpdateDimensionOutput

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*UpdateDimensionOutput) SetName added in v1.30.2 

func (s *UpdateDimensionOutput) SetName(v string) *UpdateDimensionOutput

SetName sets the Name field's value.

func (*UpdateDimensionOutput) SetStringValues added in v1.30.2 

func (s *UpdateDimensionOutput) SetStringValues(v []*string) *UpdateDimensionOutput

SetStringValues sets the StringValues field's value.

func (*UpdateDimensionOutput) SetType added in v1.30.2 

func (s *UpdateDimensionOutput) SetType(v string) *UpdateDimensionOutput

SetType sets the Type field's value.

func (UpdateDimensionOutput) String added in v1.30.2 

func (s UpdateDimensionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDomainConfigurationInput added in v1.25.42 

type UpdateDomainConfigurationInput struct {

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *AuthorizerConfig `locationName:"authorizerConfig" type:"structure"`

	// The name of the domain configuration to be updated.
	//
	// DomainConfigurationName is a required field
	DomainConfigurationName *string `location:"uri" locationName:"domainConfigurationName" min:"1" type:"string" required:"true"`

	// The status to which the domain configuration should be updated.
	DomainConfigurationStatus *string `locationName:"domainConfigurationStatus" type:"string" enum:"DomainConfigurationStatus"`

	// Removes the authorization configuration from a domain.
	RemoveAuthorizerConfig *bool `locationName:"removeAuthorizerConfig" type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateDomainConfigurationInput) GoString added in v1.25.42 

func (s UpdateDomainConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigurationInput) SetAuthorizerConfig added in v1.25.42 

func (s *UpdateDomainConfigurationInput) SetAuthorizerConfig(v *AuthorizerConfig) *UpdateDomainConfigurationInput

SetAuthorizerConfig sets the AuthorizerConfig field's value.

func (*UpdateDomainConfigurationInput) SetDomainConfigurationName added in v1.25.42 

func (s *UpdateDomainConfigurationInput) SetDomainConfigurationName(v string) *UpdateDomainConfigurationInput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (*UpdateDomainConfigurationInput) SetDomainConfigurationStatus added in v1.25.42 

func (s *UpdateDomainConfigurationInput) SetDomainConfigurationStatus(v string) *UpdateDomainConfigurationInput

SetDomainConfigurationStatus sets the DomainConfigurationStatus field's value.

func (*UpdateDomainConfigurationInput) SetRemoveAuthorizerConfig added in v1.25.42 

func (s *UpdateDomainConfigurationInput) SetRemoveAuthorizerConfig(v bool) *UpdateDomainConfigurationInput

SetRemoveAuthorizerConfig sets the RemoveAuthorizerConfig field's value.

func (UpdateDomainConfigurationInput) String added in v1.25.42 

func (s UpdateDomainConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigurationInput) Validate added in v1.25.42 

func (s *UpdateDomainConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDomainConfigurationOutput added in v1.25.42 

type UpdateDomainConfigurationOutput struct {

	// The ARN of the domain configuration that was updated.
	DomainConfigurationArn *string `locationName:"domainConfigurationArn" type:"string"`

	// The name of the domain configuration that was updated.
	DomainConfigurationName *string `locationName:"domainConfigurationName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateDomainConfigurationOutput) GoString added in v1.25.42 

func (s UpdateDomainConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigurationOutput) SetDomainConfigurationArn added in v1.25.42 

func (s *UpdateDomainConfigurationOutput) SetDomainConfigurationArn(v string) *UpdateDomainConfigurationOutput

SetDomainConfigurationArn sets the DomainConfigurationArn field's value.

func (*UpdateDomainConfigurationOutput) SetDomainConfigurationName added in v1.25.42 

func (s *UpdateDomainConfigurationOutput) SetDomainConfigurationName(v string) *UpdateDomainConfigurationOutput

SetDomainConfigurationName sets the DomainConfigurationName field's value.

func (UpdateDomainConfigurationOutput) String added in v1.25.42 

func (s UpdateDomainConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDynamicThingGroupInput added in v1.15.79 

type UpdateDynamicThingGroupInput struct {

	// The expected version of the dynamic thing group to update.
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// The dynamic thing group index to update.
	//
	// Currently one index is supported: AWS_Things.
	IndexName *string `locationName:"indexName" min:"1" type:"string"`

	// The dynamic thing group search query string to update.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`

	// The dynamic thing group query version to update.
	//
	// Currently one query version is supported: "2017-09-30". If not specified,
	// the query version defaults to this value.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

	// The name of the dynamic thing group to update.
	//
	// ThingGroupName is a required field
	ThingGroupName *string `location:"uri" locationName:"thingGroupName" min:"1" type:"string" required:"true"`

	// The dynamic thing group properties to update.
	//
	// ThingGroupProperties is a required field
	ThingGroupProperties *ThingGroupProperties `locationName:"thingGroupProperties" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDynamicThingGroupInput) GoString added in v1.15.79 

func (s UpdateDynamicThingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDynamicThingGroupInput) SetExpectedVersion added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetExpectedVersion(v int64) *UpdateDynamicThingGroupInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateDynamicThingGroupInput) SetIndexName added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetIndexName(v string) *UpdateDynamicThingGroupInput

SetIndexName sets the IndexName field's value.

func (*UpdateDynamicThingGroupInput) SetQueryString added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetQueryString(v string) *UpdateDynamicThingGroupInput

SetQueryString sets the QueryString field's value.

func (*UpdateDynamicThingGroupInput) SetQueryVersion added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetQueryVersion(v string) *UpdateDynamicThingGroupInput

SetQueryVersion sets the QueryVersion field's value.

func (*UpdateDynamicThingGroupInput) SetThingGroupName added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetThingGroupName(v string) *UpdateDynamicThingGroupInput

SetThingGroupName sets the ThingGroupName field's value.

func (*UpdateDynamicThingGroupInput) SetThingGroupProperties added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) SetThingGroupProperties(v *ThingGroupProperties) *UpdateDynamicThingGroupInput

SetThingGroupProperties sets the ThingGroupProperties field's value.

func (UpdateDynamicThingGroupInput) String added in v1.15.79 

func (s UpdateDynamicThingGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDynamicThingGroupInput) Validate added in v1.15.79 

func (s *UpdateDynamicThingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDynamicThingGroupOutput added in v1.15.79 

type UpdateDynamicThingGroupOutput struct {

	// The dynamic thing group version.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (UpdateDynamicThingGroupOutput) GoString added in v1.15.79 

func (s UpdateDynamicThingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDynamicThingGroupOutput) SetVersion added in v1.15.79 

func (s *UpdateDynamicThingGroupOutput) SetVersion(v int64) *UpdateDynamicThingGroupOutput

SetVersion sets the Version field's value.

func (UpdateDynamicThingGroupOutput) String added in v1.15.79 

func (s UpdateDynamicThingGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s UpdateEventConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEventConfigurationsInput) SetEventConfigurations added in v1.12.36 

func (s *UpdateEventConfigurationsInput) SetEventConfigurations(v map[string]*Configuration) *UpdateEventConfigurationsInput

SetEventConfigurations sets the EventConfigurations field's value.

func (UpdateEventConfigurationsInput) String added in v1.12.36 

func (s UpdateEventConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateEventConfigurationsOutput added in v1.12.36 

type UpdateEventConfigurationsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateEventConfigurationsOutput) GoString added in v1.12.36 

func (s UpdateEventConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateEventConfigurationsOutput) String added in v1.12.36 

func (s UpdateEventConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFleetMetricInput added in v1.40.34 

type UpdateFleetMetricInput struct {

	// The field to aggregate.
	AggregationField *string `locationName:"aggregationField" min:"1" type:"string"`

	// The type of the aggregation query.
	AggregationType *AggregationType `locationName:"aggregationType" type:"structure"`

	// The description of the fleet metric.
	Description *string `locationName:"description" type:"string"`

	// The expected version of the fleet metric record in the registry.
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// The name of the index to search.
	//
	// IndexName is a required field
	IndexName *string `locationName:"indexName" min:"1" type:"string" required:"true"`

	// The name of the fleet metric to update.
	//
	// MetricName is a required field
	MetricName *string `location:"uri" locationName:"metricName" min:"1" type:"string" required:"true"`

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	Period *int64 `locationName:"period" min:"60" type:"integer"`

	// The search query string.
	QueryString *string `locationName:"queryString" min:"1" type:"string"`

	// The version of the query.
	QueryVersion *string `locationName:"queryVersion" type:"string"`

	// Used to support unit transformation such as milliseconds to seconds. The
	// unit must be supported by CW metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html).
	Unit *string `locationName:"unit" type:"string" enum:"FleetMetricUnit"`
	// contains filtered or unexported fields
}

func (UpdateFleetMetricInput) GoString added in v1.40.34 

func (s UpdateFleetMetricInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetMetricInput) SetAggregationField added in v1.40.34 

func (s *UpdateFleetMetricInput) SetAggregationField(v string) *UpdateFleetMetricInput

SetAggregationField sets the AggregationField field's value.

func (*UpdateFleetMetricInput) SetAggregationType added in v1.40.34 

func (s *UpdateFleetMetricInput) SetAggregationType(v *AggregationType) *UpdateFleetMetricInput

SetAggregationType sets the AggregationType field's value.

func (*UpdateFleetMetricInput) SetDescription added in v1.40.34 

func (s *UpdateFleetMetricInput) SetDescription(v string) *UpdateFleetMetricInput

SetDescription sets the Description field's value.

func (*UpdateFleetMetricInput) SetExpectedVersion added in v1.40.34 

func (s *UpdateFleetMetricInput) SetExpectedVersion(v int64) *UpdateFleetMetricInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateFleetMetricInput) SetIndexName added in v1.40.34 

func (s *UpdateFleetMetricInput) SetIndexName(v string) *UpdateFleetMetricInput

SetIndexName sets the IndexName field's value.

func (*UpdateFleetMetricInput) SetMetricName added in v1.40.34 

func (s *UpdateFleetMetricInput) SetMetricName(v string) *UpdateFleetMetricInput

SetMetricName sets the MetricName field's value.

func (*UpdateFleetMetricInput) SetPeriod added in v1.40.34 

func (s *UpdateFleetMetricInput) SetPeriod(v int64) *UpdateFleetMetricInput

SetPeriod sets the Period field's value.

func (*UpdateFleetMetricInput) SetQueryString added in v1.40.34 

func (s *UpdateFleetMetricInput) SetQueryString(v string) *UpdateFleetMetricInput

SetQueryString sets the QueryString field's value.

func (*UpdateFleetMetricInput) SetQueryVersion added in v1.40.34 

func (s *UpdateFleetMetricInput) SetQueryVersion(v string) *UpdateFleetMetricInput

SetQueryVersion sets the QueryVersion field's value.

func (*UpdateFleetMetricInput) SetUnit added in v1.40.34 

func (s *UpdateFleetMetricInput) SetUnit(v string) *UpdateFleetMetricInput

SetUnit sets the Unit field's value.

func (UpdateFleetMetricInput) String added in v1.40.34 

func (s UpdateFleetMetricInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFleetMetricInput) Validate added in v1.40.34 

func (s *UpdateFleetMetricInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetMetricOutput added in v1.40.34 

type UpdateFleetMetricOutput struct {
	// contains filtered or unexported fields
}

func (UpdateFleetMetricOutput) GoString added in v1.40.34 

func (s UpdateFleetMetricOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateFleetMetricOutput) String added in v1.40.34 

func (s UpdateFleetMetricOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateIndexingConfigurationInput added in v1.12.36 

type UpdateIndexingConfigurationInput struct {

	// Thing group indexing configuration.
	ThingGroupIndexingConfiguration *ThingGroupIndexingConfiguration `locationName:"thingGroupIndexingConfiguration" type:"structure"`

	// Thing indexing configuration.
	ThingIndexingConfiguration *ThingIndexingConfiguration `locationName:"thingIndexingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateIndexingConfigurationInput) GoString added in v1.12.36 

func (s UpdateIndexingConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexingConfigurationInput) SetThingGroupIndexingConfiguration added in v1.15.19 

func (s *UpdateIndexingConfigurationInput) SetThingGroupIndexingConfiguration(v *ThingGroupIndexingConfiguration) *UpdateIndexingConfigurationInput

SetThingGroupIndexingConfiguration sets the ThingGroupIndexingConfiguration field's value.

func (*UpdateIndexingConfigurationInput) SetThingIndexingConfiguration added in v1.12.36 

func (s *UpdateIndexingConfigurationInput) SetThingIndexingConfiguration(v *ThingIndexingConfiguration) *UpdateIndexingConfigurationInput

SetThingIndexingConfiguration sets the ThingIndexingConfiguration field's value.

func (UpdateIndexingConfigurationInput) String added in v1.12.36 

func (s UpdateIndexingConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexingConfigurationInput) Validate added in v1.15.19 

func (s *UpdateIndexingConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateIndexingConfigurationOutput added in v1.12.36 

type UpdateIndexingConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateIndexingConfigurationOutput) GoString added in v1.12.36 

func (s UpdateIndexingConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateIndexingConfigurationOutput) String added in v1.12.36 

func (s UpdateIndexingConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateJobInput added in v1.15.79 

type UpdateJobInput struct {

	// Allows you to create criteria to abort a job.
	AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"`

	// A short text description of the job.
	Description *string `locationName:"description" type:"string"`

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig `locationName:"jobExecutionsRetryConfig" type:"structure"`

	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *JobExecutionsRolloutConfig `locationName:"jobExecutionsRolloutConfig" type:"structure"`

	// The ID of the job to be updated.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core
	// sends jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is in public preview.
	NamespaceId *string `location:"querystring" locationName:"namespaceId" min:"1" type:"string"`

	// Configuration information for pre-signed S3 URLs.
	PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"`

	// Specifies the amount of time each device has to finish its execution of the
	// job. The timer is started when the job execution status is set to IN_PROGRESS.
	// If the job execution status is not set to another terminal state before the
	// time expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateJobInput) GoString added in v1.15.79 

func (s UpdateJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJobInput) SetAbortConfig added in v1.15.79 

func (s *UpdateJobInput) SetAbortConfig(v *AbortConfig) *UpdateJobInput

SetAbortConfig sets the AbortConfig field's value.

func (*UpdateJobInput) SetDescription added in v1.15.79 

func (s *UpdateJobInput) SetDescription(v string) *UpdateJobInput

SetDescription sets the Description field's value.

func (*UpdateJobInput) SetJobExecutionsRetryConfig added in v1.42.28 

func (s *UpdateJobInput) SetJobExecutionsRetryConfig(v *JobExecutionsRetryConfig) *UpdateJobInput

SetJobExecutionsRetryConfig sets the JobExecutionsRetryConfig field's value.

func (*UpdateJobInput) SetJobExecutionsRolloutConfig added in v1.15.79 

func (s *UpdateJobInput) SetJobExecutionsRolloutConfig(v *JobExecutionsRolloutConfig) *UpdateJobInput

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*UpdateJobInput) SetJobId added in v1.15.79 

func (s *UpdateJobInput) SetJobId(v string) *UpdateJobInput

SetJobId sets the JobId field's value.

func (*UpdateJobInput) SetNamespaceId added in v1.35.17 

func (s *UpdateJobInput) SetNamespaceId(v string) *UpdateJobInput

SetNamespaceId sets the NamespaceId field's value.

func (*UpdateJobInput) SetPresignedUrlConfig added in v1.15.79 

func (s *UpdateJobInput) SetPresignedUrlConfig(v *PresignedUrlConfig) *UpdateJobInput

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

func (*UpdateJobInput) SetTimeoutConfig added in v1.15.79 

func (s *UpdateJobInput) SetTimeoutConfig(v *TimeoutConfig) *UpdateJobInput

SetTimeoutConfig sets the TimeoutConfig field's value.

func (UpdateJobInput) String added in v1.15.79 

func (s UpdateJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJobInput) Validate added in v1.15.79 

func (s *UpdateJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJobOutput added in v1.15.79 

type UpdateJobOutput struct {
	// contains filtered or unexported fields
}

func (UpdateJobOutput) GoString added in v1.15.79 

func (s UpdateJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateJobOutput) String added in v1.15.79 

func (s UpdateJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMitigationActionInput added in v1.21.10 

type UpdateMitigationActionInput struct {

	// The friendly name for the mitigation action. You cannot change the name by
	// using UpdateMitigationAction. Instead, you must delete and recreate the mitigation
	// action with the new name.
	//
	// ActionName is a required field
	ActionName *string `location:"uri" locationName:"actionName" type:"string" required:"true"`

	// Defines the type of action and the parameters for that action.
	ActionParams *MitigationActionParams `locationName:"actionParams" type:"structure"`

	// The ARN of the IAM role that is used to apply the mitigation action.
	RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMitigationActionInput) GoString added in v1.21.10 

func (s UpdateMitigationActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMitigationActionInput) SetActionName added in v1.21.10 

func (s *UpdateMitigationActionInput) SetActionName(v string) *UpdateMitigationActionInput

SetActionName sets the ActionName field's value.

func (*UpdateMitigationActionInput) SetActionParams added in v1.21.10 

func (s *UpdateMitigationActionInput) SetActionParams(v *MitigationActionParams) *UpdateMitigationActionInput

SetActionParams sets the ActionParams field's value.

func (*UpdateMitigationActionInput) SetRoleArn added in v1.21.10 

func (s *UpdateMitigationActionInput) SetRoleArn(v string) *UpdateMitigationActionInput

SetRoleArn sets the RoleArn field's value.

func (UpdateMitigationActionInput) String added in v1.21.10 

func (s UpdateMitigationActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMitigationActionInput) Validate added in v1.21.10 

func (s *UpdateMitigationActionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMitigationActionOutput added in v1.21.10 

type UpdateMitigationActionOutput struct {

	// The ARN for the new mitigation action.
	ActionArn *string `locationName:"actionArn" type:"string"`

	// A unique identifier for the mitigation action.
	ActionId *string `locationName:"actionId" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMitigationActionOutput) GoString added in v1.21.10 

func (s UpdateMitigationActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMitigationActionOutput) SetActionArn added in v1.21.10 

func (s *UpdateMitigationActionOutput) SetActionArn(v string) *UpdateMitigationActionOutput

SetActionArn sets the ActionArn field's value.

func (*UpdateMitigationActionOutput) SetActionId added in v1.21.10 

func (s *UpdateMitigationActionOutput) SetActionId(v string) *UpdateMitigationActionOutput

SetActionId sets the ActionId field's value.

func (UpdateMitigationActionOutput) String added in v1.21.10 

func (s UpdateMitigationActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateProvisioningTemplateInput added in v1.25.42 

type UpdateProvisioningTemplateInput struct {

	// The ID of the default provisioning template version.
	DefaultVersionId *int64 `locationName:"defaultVersionId" type:"integer"`

	// The description of the fleet provisioning template.
	Description *string `locationName:"description" type:"string"`

	// True to enable the fleet provisioning template, otherwise false.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// Updates the pre-provisioning hook template.
	PreProvisioningHook *ProvisioningHook `locationName:"preProvisioningHook" type:"structure"`

	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string `locationName:"provisioningRoleArn" min:"20" type:"string"`

	// Removes pre-provisioning hook template.
	RemovePreProvisioningHook *bool `locationName:"removePreProvisioningHook" type:"boolean"`

	// The name of the fleet provisioning template.
	//
	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"templateName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateProvisioningTemplateInput) GoString added in v1.25.42 

func (s UpdateProvisioningTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProvisioningTemplateInput) SetDefaultVersionId added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) SetDefaultVersionId(v int64) *UpdateProvisioningTemplateInput

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*UpdateProvisioningTemplateInput) SetDescription added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) SetDescription(v string) *UpdateProvisioningTemplateInput

SetDescription sets the Description field's value.

func (*UpdateProvisioningTemplateInput) SetEnabled added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) SetEnabled(v bool) *UpdateProvisioningTemplateInput

SetEnabled sets the Enabled field's value.

func (*UpdateProvisioningTemplateInput) SetPreProvisioningHook added in v1.30.18 

func (s *UpdateProvisioningTemplateInput) SetPreProvisioningHook(v *ProvisioningHook) *UpdateProvisioningTemplateInput

SetPreProvisioningHook sets the PreProvisioningHook field's value.

func (*UpdateProvisioningTemplateInput) SetProvisioningRoleArn added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) SetProvisioningRoleArn(v string) *UpdateProvisioningTemplateInput

SetProvisioningRoleArn sets the ProvisioningRoleArn field's value.

func (*UpdateProvisioningTemplateInput) SetRemovePreProvisioningHook added in v1.30.18 

func (s *UpdateProvisioningTemplateInput) SetRemovePreProvisioningHook(v bool) *UpdateProvisioningTemplateInput

SetRemovePreProvisioningHook sets the RemovePreProvisioningHook field's value.

func (*UpdateProvisioningTemplateInput) SetTemplateName added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) SetTemplateName(v string) *UpdateProvisioningTemplateInput

SetTemplateName sets the TemplateName field's value.

func (UpdateProvisioningTemplateInput) String added in v1.25.42 

func (s UpdateProvisioningTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProvisioningTemplateInput) Validate added in v1.25.42 

func (s *UpdateProvisioningTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProvisioningTemplateOutput added in v1.25.42 

type UpdateProvisioningTemplateOutput struct {
	// contains filtered or unexported fields
}

func (UpdateProvisioningTemplateOutput) GoString added in v1.25.42 

func (s UpdateProvisioningTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateProvisioningTemplateOutput) String added in v1.25.42 

func (s UpdateProvisioningTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRoleAliasInput added in v1.12.36 

type UpdateRoleAliasInput struct {

	// The number of seconds the credential will be valid.
	//
	// This value must be less than or equal to the maximum session duration of
	// the IAM role that the role alias references.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s *UpdateRoleAliasInput) SetRoleArn(v string) *UpdateRoleAliasInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"1" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRoleAliasOutput) SetRoleAlias added in v1.12.36 

func (s *UpdateRoleAliasOutput) SetRoleAlias(v string) *UpdateRoleAliasOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateScheduledAuditInput added in v1.15.2 

type UpdateScheduledAuditInput struct {

	// The day of the month on which the scheduled audit takes place. This can be
	// 1 through 31 or LAST. This field is required if the frequency parameter is
	// set to MONTHLY. If days 29-31 are specified, and the month does not have
	// that many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string `locationName:"dayOfMonth" type:"string"`

	// The day of the week on which the scheduled audit takes place. This can be
	// one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the
	// "frequency" parameter is set to WEEKLY or BIWEEKLY.
	DayOfWeek *string `locationName:"dayOfWeek" type:"string" enum:"DayOfWeek"`

	// How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY,
	// or MONTHLY. The start time of each audit is determined by the system.
	Frequency *string `locationName:"frequency" type:"string" enum:"AuditFrequency"`

	// The name of the scheduled audit. (Max. 128 chars)
	//
	// ScheduledAuditName is a required field
	ScheduledAuditName *string `location:"uri" locationName:"scheduledAuditName" min:"1" type:"string" required:"true"`

	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list
	// of all checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	TargetCheckNames []*string `locationName:"targetCheckNames" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateScheduledAuditInput) GoString added in v1.15.2 

func (s UpdateScheduledAuditInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScheduledAuditInput) SetDayOfMonth added in v1.15.2 

func (s *UpdateScheduledAuditInput) SetDayOfMonth(v string) *UpdateScheduledAuditInput

SetDayOfMonth sets the DayOfMonth field's value.

func (*UpdateScheduledAuditInput) SetDayOfWeek added in v1.15.2 

func (s *UpdateScheduledAuditInput) SetDayOfWeek(v string) *UpdateScheduledAuditInput

SetDayOfWeek sets the DayOfWeek field's value.

func (*UpdateScheduledAuditInput) SetFrequency added in v1.15.2 

func (s *UpdateScheduledAuditInput) SetFrequency(v string) *UpdateScheduledAuditInput

SetFrequency sets the Frequency field's value.

func (*UpdateScheduledAuditInput) SetScheduledAuditName added in v1.15.2 

func (s *UpdateScheduledAuditInput) SetScheduledAuditName(v string) *UpdateScheduledAuditInput

SetScheduledAuditName sets the ScheduledAuditName field's value.

func (*UpdateScheduledAuditInput) SetTargetCheckNames added in v1.15.2 

func (s *UpdateScheduledAuditInput) SetTargetCheckNames(v []*string) *UpdateScheduledAuditInput

SetTargetCheckNames sets the TargetCheckNames field's value.

func (UpdateScheduledAuditInput) String added in v1.15.2 

func (s UpdateScheduledAuditInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScheduledAuditInput) Validate added in v1.15.2 

func (s *UpdateScheduledAuditInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateScheduledAuditOutput added in v1.15.2 

type UpdateScheduledAuditOutput struct {

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string `locationName:"scheduledAuditArn" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateScheduledAuditOutput) GoString added in v1.15.2 

func (s UpdateScheduledAuditOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateScheduledAuditOutput) SetScheduledAuditArn added in v1.15.2 

func (s *UpdateScheduledAuditOutput) SetScheduledAuditArn(v string) *UpdateScheduledAuditOutput

SetScheduledAuditArn sets the ScheduledAuditArn field's value.

func (UpdateScheduledAuditOutput) String added in v1.15.2 

func (s UpdateScheduledAuditOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSecurityProfileInput added in v1.15.2 

type UpdateSecurityProfileInput struct {

	// Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
	//
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here. Can be used with custom metrics; cannot be used
	// with dimensions.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []*string `locationName:"additionalMetricsToRetain" deprecated:"true" type:"list"`

	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here. Can be used with custom metrics; cannot be used
	// with dimensions.
	AdditionalMetricsToRetainV2 []*MetricToRetain `locationName:"additionalMetricsToRetainV2" type:"list"`

	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*AlertTarget `locationName:"alertTargets" type:"map"`

	// Specifies the behaviors that, when violated by a device (thing), cause an
	// alert.
	Behaviors []*Behavior `locationName:"behaviors" type:"list"`

	// If true, delete all additionalMetricsToRetain defined for this security profile.
	// If any additionalMetricsToRetain are defined in the current invocation, an
	// exception occurs.
	DeleteAdditionalMetricsToRetain *bool `locationName:"deleteAdditionalMetricsToRetain" type:"boolean"`

	// If true, delete all alertTargets defined for this security profile. If any
	// alertTargets are defined in the current invocation, an exception occurs.
	DeleteAlertTargets *bool `locationName:"deleteAlertTargets" type:"boolean"`

	// If true, delete all behaviors defined for this security profile. If any behaviors
	// are defined in the current invocation, an exception occurs.
	DeleteBehaviors *bool `locationName:"deleteBehaviors" type:"boolean"`

	// The expected version of the security profile. A new version is generated
	// whenever the security profile is updated. If you specify a value that is
	// different from the actual version, a VersionConflictException is thrown.
	ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"`

	// A description of the security profile.
	SecurityProfileDescription *string `locationName:"securityProfileDescription" type:"string"`

	// The name of the security profile you want to update.
	//
	// SecurityProfileName is a required field
	SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSecurityProfileInput) GoString added in v1.15.2 

func (s UpdateSecurityProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityProfileInput) SetAdditionalMetricsToRetain added in v1.17.1 

func (s *UpdateSecurityProfileInput) SetAdditionalMetricsToRetain(v []*string) *UpdateSecurityProfileInput

SetAdditionalMetricsToRetain sets the AdditionalMetricsToRetain field's value.

func (*UpdateSecurityProfileInput) SetAdditionalMetricsToRetainV2 added in v1.30.2 

func (s *UpdateSecurityProfileInput) SetAdditionalMetricsToRetainV2(v []*MetricToRetain) *UpdateSecurityProfileInput

SetAdditionalMetricsToRetainV2 sets the AdditionalMetricsToRetainV2 field's value.

func (*UpdateSecurityProfileInput) SetAlertTargets added in v1.15.2 

func (s *UpdateSecurityProfileInput) SetAlertTargets(v map[string]*AlertTarget) *UpdateSecurityProfileInput

SetAlertTargets sets the AlertTargets field's value.

func (*UpdateSecurityProfileInput) SetBehaviors added in v1.15.2 

func (s *UpdateSecurityProfileInput) SetBehaviors(v []*Behavior) *UpdateSecurityProfileInput

SetBehaviors sets the Behaviors field's value.

func (*UpdateSecurityProfileInput) SetDeleteAdditionalMetricsToRetain added in v1.17.1 

func (s *UpdateSecurityProfileInput) SetDeleteAdditionalMetricsToRetain(v bool) *UpdateSecurityProfileInput

SetDeleteAdditionalMetricsToRetain sets the DeleteAdditionalMetricsToRetain field's value.

func (*UpdateSecurityProfileInput) SetDeleteAlertTargets added in v1.17.1 

func (s *UpdateSecurityProfileInput) SetDeleteAlertTargets(v bool) *UpdateSecurityProfileInput

SetDeleteAlertTargets sets the DeleteAlertTargets field's value.

func (*UpdateSecurityProfileInput) SetDeleteBehaviors added in v1.17.1 

func (s *UpdateSecurityProfileInput) SetDeleteBehaviors(v bool) *UpdateSecurityProfileInput

SetDeleteBehaviors sets the DeleteBehaviors field's value.

func (*UpdateSecurityProfileInput) SetExpectedVersion added in v1.15.2 

func (s *UpdateSecurityProfileInput) SetExpectedVersion(v int64) *UpdateSecurityProfileInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateSecurityProfileInput) SetSecurityProfileDescription added in v1.15.2 

func (s *UpdateSecurityProfileInput) SetSecurityProfileDescription(v string) *UpdateSecurityProfileInput

SetSecurityProfileDescription sets the SecurityProfileDescription field's value.

func (*UpdateSecurityProfileInput) SetSecurityProfileName added in v1.15.2 

func (s *UpdateSecurityProfileInput) SetSecurityProfileName(v string) *UpdateSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (UpdateSecurityProfileInput) String added in v1.15.2 

func (s UpdateSecurityProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityProfileInput) Validate added in v1.15.2 

func (s *UpdateSecurityProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSecurityProfileOutput added in v1.15.2 

type UpdateSecurityProfileOutput struct {

	// Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
	//
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the security profile's behaviors, but it is also retained
	// for any metric specified here.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []*string `locationName:"additionalMetricsToRetain" deprecated:"true" type:"list"`

	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for
	// any metric specified here. Can be used with custom metrics; cannot be used
	// with dimensions.
	AdditionalMetricsToRetainV2 []*MetricToRetain `locationName:"additionalMetricsToRetainV2" type:"list"`

	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*AlertTarget `locationName:"alertTargets" type:"map"`

	// Specifies the behaviors that, when violated by a device (thing), cause an
	// alert.
	Behaviors []*Behavior `locationName:"behaviors" type:"list"`

	// The time the security profile was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The time the security profile was last modified.
	LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp"`

	// The ARN of the security profile that was updated.
	SecurityProfileArn *string `locationName:"securityProfileArn" type:"string"`

	// The description of the security profile.
	SecurityProfileDescription *string `locationName:"securityProfileDescription" type:"string"`

	// The name of the security profile that was updated.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The updated version of the security profile.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

func (UpdateSecurityProfileOutput) GoString added in v1.15.2 

func (s UpdateSecurityProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityProfileOutput) SetAdditionalMetricsToRetain added in v1.17.1 

func (s *UpdateSecurityProfileOutput) SetAdditionalMetricsToRetain(v []*string) *UpdateSecurityProfileOutput

SetAdditionalMetricsToRetain sets the AdditionalMetricsToRetain field's value.

func (*UpdateSecurityProfileOutput) SetAdditionalMetricsToRetainV2 added in v1.30.2 

func (s *UpdateSecurityProfileOutput) SetAdditionalMetricsToRetainV2(v []*MetricToRetain) *UpdateSecurityProfileOutput

SetAdditionalMetricsToRetainV2 sets the AdditionalMetricsToRetainV2 field's value.

func (*UpdateSecurityProfileOutput) SetAlertTargets added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetAlertTargets(v map[string]*AlertTarget) *UpdateSecurityProfileOutput

SetAlertTargets sets the AlertTargets field's value.

func (*UpdateSecurityProfileOutput) SetBehaviors added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetBehaviors(v []*Behavior) *UpdateSecurityProfileOutput

SetBehaviors sets the Behaviors field's value.

func (*UpdateSecurityProfileOutput) SetCreationDate added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetCreationDate(v time.Time) *UpdateSecurityProfileOutput

SetCreationDate sets the CreationDate field's value.

func (*UpdateSecurityProfileOutput) SetLastModifiedDate added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetLastModifiedDate(v time.Time) *UpdateSecurityProfileOutput

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*UpdateSecurityProfileOutput) SetSecurityProfileArn added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetSecurityProfileArn(v string) *UpdateSecurityProfileOutput

SetSecurityProfileArn sets the SecurityProfileArn field's value.

func (*UpdateSecurityProfileOutput) SetSecurityProfileDescription added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetSecurityProfileDescription(v string) *UpdateSecurityProfileOutput

SetSecurityProfileDescription sets the SecurityProfileDescription field's value.

func (*UpdateSecurityProfileOutput) SetSecurityProfileName added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetSecurityProfileName(v string) *UpdateSecurityProfileOutput

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*UpdateSecurityProfileOutput) SetVersion added in v1.15.2 

func (s *UpdateSecurityProfileOutput) SetVersion(v int64) *UpdateSecurityProfileOutput

SetVersion sets the Version field's value.

func (UpdateSecurityProfileOutput) String added in v1.15.2 

func (s UpdateSecurityProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThingGroupOutput) SetVersion added in v1.12.36 

func (s *UpdateThingGroupOutput) SetVersion(v int64) *UpdateThingGroupOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateThingGroupsForThingInput added in v1.12.36 

type UpdateThingGroupsForThingInput struct {

	// Override dynamic thing groups with static thing groups when 10-group limit
	// is reached. If a thing belongs to 10 thing groups, and one or more of those
	// groups are dynamic thing groups, adding a thing to a static group removes
	// the thing from the last dynamic group.
	OverrideDynamicGroups *bool `locationName:"overrideDynamicGroups" type:"boolean"`

	// 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 

func (s UpdateThingGroupsForThingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThingGroupsForThingInput) SetOverrideDynamicGroups added in v1.15.79 

func (s *UpdateThingGroupsForThingInput) SetOverrideDynamicGroups(v bool) *UpdateThingGroupsForThingInput

SetOverrideDynamicGroups sets the OverrideDynamicGroups field's value.

func (*UpdateThingGroupsForThingInput) SetThingGroupsToAdd added in v1.12.36 

func (s *UpdateThingGroupsForThingInput) SetThingGroupsToAdd(v []*string) *UpdateThingGroupsForThingInput

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 

func (s *UpdateThingGroupsForThingInput) SetThingName(v string) *UpdateThingGroupsForThingInput

SetThingName sets the ThingName field's value.

func (UpdateThingGroupsForThingInput) String added in v1.12.36 

func (s UpdateThingGroupsForThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s UpdateThingGroupsForThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateThingGroupsForThingOutput) String added in v1.12.36 

func (s UpdateThingGroupsForThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// You can't change a thing's name. To change a thing's name, you must create
	// a new thing, give it the new name, and then delete the old thing.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateThingOutput) String 

func (s UpdateThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTopicRuleDestinationInput added in v1.25.38 

type UpdateTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The status of the topic rule destination. Valid values are:
	//
	// IN_PROGRESS
	//
	// A topic rule destination was created but has not been confirmed. You can
	// set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	//
	// ENABLED
	//
	// Confirmation was completed, and traffic to this destination is allowed. You
	// can set status to DISABLED by calling UpdateTopicRuleDestination.
	//
	// DISABLED
	//
	// Confirmation was completed, and traffic to this destination is not allowed.
	// You can set status to ENABLED by calling UpdateTopicRuleDestination.
	//
	// ERROR
	//
	// Confirmation could not be completed, for example if the confirmation timed
	// out. You can call GetTopicRuleDestination for details about the error. You
	// can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent
	// to your confirmation endpoint.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"TopicRuleDestinationStatus"`
	// contains filtered or unexported fields
}

func (UpdateTopicRuleDestinationInput) GoString added in v1.25.38 

func (s UpdateTopicRuleDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTopicRuleDestinationInput) SetArn added in v1.25.38 

func (s *UpdateTopicRuleDestinationInput) SetArn(v string) *UpdateTopicRuleDestinationInput

SetArn sets the Arn field's value.

func (*UpdateTopicRuleDestinationInput) SetStatus added in v1.25.38 

func (s *UpdateTopicRuleDestinationInput) SetStatus(v string) *UpdateTopicRuleDestinationInput

SetStatus sets the Status field's value.

func (UpdateTopicRuleDestinationInput) String added in v1.25.38 

func (s UpdateTopicRuleDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTopicRuleDestinationInput) Validate added in v1.25.38 

func (s *UpdateTopicRuleDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTopicRuleDestinationOutput added in v1.25.38 

type UpdateTopicRuleDestinationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateTopicRuleDestinationOutput) GoString added in v1.25.38 

func (s UpdateTopicRuleDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateTopicRuleDestinationOutput) String added in v1.25.38 

func (s UpdateTopicRuleDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidateSecurityProfileBehaviorsInput added in v1.15.2 

type ValidateSecurityProfileBehaviorsInput struct {

	// Specifies the behaviors that, when violated by a device (thing), cause an
	// alert.
	//
	// Behaviors is a required field
	Behaviors []*Behavior `locationName:"behaviors" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ValidateSecurityProfileBehaviorsInput) GoString added in v1.15.2 

func (s ValidateSecurityProfileBehaviorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateSecurityProfileBehaviorsInput) SetBehaviors added in v1.15.2 

func (s *ValidateSecurityProfileBehaviorsInput) SetBehaviors(v []*Behavior) *ValidateSecurityProfileBehaviorsInput

SetBehaviors sets the Behaviors field's value.

func (ValidateSecurityProfileBehaviorsInput) String added in v1.15.2 

func (s ValidateSecurityProfileBehaviorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateSecurityProfileBehaviorsInput) Validate added in v1.15.2 

func (s *ValidateSecurityProfileBehaviorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ValidateSecurityProfileBehaviorsOutput added in v1.15.2 

type ValidateSecurityProfileBehaviorsOutput struct {

	// True if the behaviors were valid.
	Valid *bool `locationName:"valid" type:"boolean"`

	// The list of any errors found in the behaviors.
	ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`
	// contains filtered or unexported fields
}

func (ValidateSecurityProfileBehaviorsOutput) GoString added in v1.15.2 

func (s ValidateSecurityProfileBehaviorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateSecurityProfileBehaviorsOutput) SetValid added in v1.15.2 

func (s *ValidateSecurityProfileBehaviorsOutput) SetValid(v bool) *ValidateSecurityProfileBehaviorsOutput

SetValid sets the Valid field's value.

func (*ValidateSecurityProfileBehaviorsOutput) SetValidationErrors added in v1.15.2 

func (s *ValidateSecurityProfileBehaviorsOutput) SetValidationErrors(v []*ValidationError) *ValidateSecurityProfileBehaviorsOutput

SetValidationErrors sets the ValidationErrors field's value.

func (ValidateSecurityProfileBehaviorsOutput) String added in v1.15.2 

func (s ValidateSecurityProfileBehaviorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationError added in v1.15.2 

type ValidationError struct {

	// The description of an error found in the behaviors.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`
	// contains filtered or unexported fields
}

Information about an error found in a behavior specification.

func (ValidationError) GoString added in v1.15.2 

func (s ValidationError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationError) SetErrorMessage added in v1.15.2 

func (s *ValidationError) SetErrorMessage(v string) *ValidationError

SetErrorMessage sets the ErrorMessage field's value.

func (ValidationError) String added in v1.15.2 

func (s ValidationError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VersionConflictException added in v1.28.0 

type VersionConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

func (*VersionConflictException) Code added in v1.28.0 

func (s *VersionConflictException) Code() string

Code returns the exception type name.

func (*VersionConflictException) Error added in v1.28.0 

func (s *VersionConflictException) Error() string

func (VersionConflictException) GoString added in v1.28.0 

func (s VersionConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VersionConflictException) Message added in v1.28.0 

func (s *VersionConflictException) Message() string

Message returns the exception's message.

func (*VersionConflictException) OrigErr added in v1.28.0 

func (s *VersionConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*VersionConflictException) RequestID added in v1.28.0 

func (s *VersionConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*VersionConflictException) StatusCode added in v1.28.0 

func (s *VersionConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (VersionConflictException) String added in v1.28.0 

func (s VersionConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VersionsLimitExceededException added in v1.28.0 

type VersionsLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The number of policy versions exceeds the limit.

func (*VersionsLimitExceededException) Code added in v1.28.0 

func (s *VersionsLimitExceededException) Code() string

Code returns the exception type name.

func (*VersionsLimitExceededException) Error added in v1.28.0 

func (s *VersionsLimitExceededException) Error() string

func (VersionsLimitExceededException) GoString added in v1.28.0 

func (s VersionsLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VersionsLimitExceededException) Message added in v1.28.0 

func (s *VersionsLimitExceededException) Message() string

Message returns the exception's message.

func (*VersionsLimitExceededException) OrigErr added in v1.28.0 

func (s *VersionsLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*VersionsLimitExceededException) RequestID added in v1.28.0 

func (s *VersionsLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*VersionsLimitExceededException) StatusCode added in v1.28.0 

func (s *VersionsLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (VersionsLimitExceededException) String added in v1.28.0 

func (s VersionsLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ViolationEvent added in v1.15.2 

type ViolationEvent struct {

	// The behavior that was violated.
	Behavior *Behavior `locationName:"behavior" type:"structure"`

	// The value of the metric (the measurement).
	MetricValue *MetricValue `locationName:"metricValue" type:"structure"`

	// The name of the security profile whose behavior was violated.
	SecurityProfileName *string `locationName:"securityProfileName" min:"1" type:"string"`

	// The name of the thing responsible for the violation event.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`

	// The verification state of the violation (detect alarm).
	VerificationState *string `locationName:"verificationState" type:"string" enum:"VerificationState"`

	// The description of the verification state of the violation.
	VerificationStateDescription *string `locationName:"verificationStateDescription" type:"string"`

	// The details of a violation event.
	ViolationEventAdditionalInfo *ViolationEventAdditionalInfo `locationName:"violationEventAdditionalInfo" type:"structure"`

	// The time the violation event occurred.
	ViolationEventTime *time.Time `locationName:"violationEventTime" type:"timestamp"`

	// The type of violation event.
	ViolationEventType *string `locationName:"violationEventType" type:"string" enum:"ViolationEventType"`

	// The ID of the violation event.
	ViolationId *string `locationName:"violationId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a Device Defender security profile behavior violation.

func (ViolationEvent) GoString added in v1.15.2 

func (s ViolationEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ViolationEvent) SetBehavior added in v1.15.2 

func (s *ViolationEvent) SetBehavior(v *Behavior) *ViolationEvent

SetBehavior sets the Behavior field's value.

func (*ViolationEvent) SetMetricValue added in v1.15.2 

func (s *ViolationEvent) SetMetricValue(v *MetricValue) *ViolationEvent

SetMetricValue sets the MetricValue field's value.

func (*ViolationEvent) SetSecurityProfileName added in v1.15.2 

func (s *ViolationEvent) SetSecurityProfileName(v string) *ViolationEvent

SetSecurityProfileName sets the SecurityProfileName field's value.

func (*ViolationEvent) SetThingName added in v1.15.2 

func (s *ViolationEvent) SetThingName(v string) *ViolationEvent

SetThingName sets the ThingName field's value.

func (*ViolationEvent) SetVerificationState added in v1.40.46 

func (s *ViolationEvent) SetVerificationState(v string) *ViolationEvent

SetVerificationState sets the VerificationState field's value.

func (*ViolationEvent) SetVerificationStateDescription added in v1.40.46 

func (s *ViolationEvent) SetVerificationStateDescription(v string) *ViolationEvent

SetVerificationStateDescription sets the VerificationStateDescription field's value.

func (*ViolationEvent) SetViolationEventAdditionalInfo added in v1.36.9 

func (s *ViolationEvent) SetViolationEventAdditionalInfo(v *ViolationEventAdditionalInfo) *ViolationEvent

SetViolationEventAdditionalInfo sets the ViolationEventAdditionalInfo field's value.

func (*ViolationEvent) SetViolationEventTime added in v1.15.2 

func (s *ViolationEvent) SetViolationEventTime(v time.Time) *ViolationEvent

SetViolationEventTime sets the ViolationEventTime field's value.

func (*ViolationEvent) SetViolationEventType added in v1.15.2 

func (s *ViolationEvent) SetViolationEventType(v string) *ViolationEvent

SetViolationEventType sets the ViolationEventType field's value.

func (*ViolationEvent) SetViolationId added in v1.15.2 

func (s *ViolationEvent) SetViolationId(v string) *ViolationEvent

SetViolationId sets the ViolationId field's value.

func (ViolationEvent) String added in v1.15.2 

func (s ViolationEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ViolationEventAdditionalInfo added in v1.36.9 

type ViolationEventAdditionalInfo struct {

	// The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or
	// High.
	ConfidenceLevel *string `locationName:"confidenceLevel" type:"string" enum:"ConfidenceLevel"`
	// contains filtered or unexported fields
}

The details of a violation event.

func (ViolationEventAdditionalInfo) GoString added in v1.36.9 

func (s ViolationEventAdditionalInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ViolationEventAdditionalInfo) SetConfidenceLevel added in v1.36.9 

func (s *ViolationEventAdditionalInfo) SetConfidenceLevel(v string) *ViolationEventAdditionalInfo

SetConfidenceLevel sets the ConfidenceLevel field's value.

func (ViolationEventAdditionalInfo) String added in v1.36.9 

func (s ViolationEventAdditionalInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ViolationEventOccurrenceRange added in v1.36.9 

type ViolationEventOccurrenceRange struct {

	// The end date and time of a time period in which violation events occurred.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The start date and time of a time period in which violation events occurred.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Specifies the time period of which violation events occurred between.

func (ViolationEventOccurrenceRange) GoString added in v1.36.9 

func (s ViolationEventOccurrenceRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ViolationEventOccurrenceRange) SetEndTime added in v1.36.9 

func (s *ViolationEventOccurrenceRange) SetEndTime(v time.Time) *ViolationEventOccurrenceRange

SetEndTime sets the EndTime field's value.

func (*ViolationEventOccurrenceRange) SetStartTime added in v1.36.9 

func (s *ViolationEventOccurrenceRange) SetStartTime(v time.Time) *ViolationEventOccurrenceRange

SetStartTime sets the StartTime field's value.

func (ViolationEventOccurrenceRange) String added in v1.36.9 

func (s ViolationEventOccurrenceRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ViolationEventOccurrenceRange) Validate added in v1.36.9 

func (s *ViolationEventOccurrenceRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VpcDestinationConfiguration added in v1.36.9 

type VpcDestinationConfiguration struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The security groups of the VPC destination.
	SecurityGroups []*string `locationName:"securityGroups" type:"list"`

	// The subnet IDs of the VPC destination.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" type:"list" required:"true"`

	// The ID of the VPC.
	//
	// VpcId is a required field
	VpcId *string `locationName:"vpcId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration information for a virtual private cloud (VPC) destination.

func (VpcDestinationConfiguration) GoString added in v1.36.9 

func (s VpcDestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcDestinationConfiguration) SetRoleArn added in v1.36.9 

func (s *VpcDestinationConfiguration) SetRoleArn(v string) *VpcDestinationConfiguration

SetRoleArn sets the RoleArn field's value.

func (*VpcDestinationConfiguration) SetSecurityGroups added in v1.36.9 

func (s *VpcDestinationConfiguration) SetSecurityGroups(v []*string) *VpcDestinationConfiguration

SetSecurityGroups sets the SecurityGroups field's value.

func (*VpcDestinationConfiguration) SetSubnetIds added in v1.36.9 

func (s *VpcDestinationConfiguration) SetSubnetIds(v []*string) *VpcDestinationConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (*VpcDestinationConfiguration) SetVpcId added in v1.36.9 

func (s *VpcDestinationConfiguration) SetVpcId(v string) *VpcDestinationConfiguration

SetVpcId sets the VpcId field's value.

func (VpcDestinationConfiguration) String added in v1.36.9 

func (s VpcDestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcDestinationConfiguration) Validate added in v1.36.9 

func (s *VpcDestinationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VpcDestinationProperties added in v1.36.9 

type VpcDestinationProperties struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The security groups of the VPC destination.
	SecurityGroups []*string `locationName:"securityGroups" type:"list"`

	// The subnet IDs of the VPC destination.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// The ID of the VPC.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

The properties of a virtual private cloud (VPC) destination.

func (VpcDestinationProperties) GoString added in v1.36.9 

func (s VpcDestinationProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcDestinationProperties) SetRoleArn added in v1.36.9 

func (s *VpcDestinationProperties) SetRoleArn(v string) *VpcDestinationProperties

SetRoleArn sets the RoleArn field's value.

func (*VpcDestinationProperties) SetSecurityGroups added in v1.36.9 

func (s *VpcDestinationProperties) SetSecurityGroups(v []*string) *VpcDestinationProperties

SetSecurityGroups sets the SecurityGroups field's value.

func (*VpcDestinationProperties) SetSubnetIds added in v1.36.9 

func (s *VpcDestinationProperties) SetSubnetIds(v []*string) *VpcDestinationProperties

SetSubnetIds sets the SubnetIds field's value.

func (*VpcDestinationProperties) SetVpcId added in v1.36.9 

func (s *VpcDestinationProperties) SetVpcId(v string) *VpcDestinationProperties

SetVpcId sets the VpcId field's value.

func (VpcDestinationProperties) String added in v1.36.9 

func (s VpcDestinationProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcDestinationSummary added in v1.36.9 

type VpcDestinationSummary struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The security groups of the VPC destination.
	SecurityGroups []*string `locationName:"securityGroups" type:"list"`

	// The subnet IDs of the VPC destination.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// The ID of the VPC.
	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

The summary of a virtual private cloud (VPC) destination.

func (VpcDestinationSummary) GoString added in v1.36.9 

func (s VpcDestinationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcDestinationSummary) SetRoleArn added in v1.36.9 

func (s *VpcDestinationSummary) SetRoleArn(v string) *VpcDestinationSummary

SetRoleArn sets the RoleArn field's value.

func (*VpcDestinationSummary) SetSecurityGroups added in v1.36.9 

func (s *VpcDestinationSummary) SetSecurityGroups(v []*string) *VpcDestinationSummary

SetSecurityGroups sets the SecurityGroups field's value.

func (*VpcDestinationSummary) SetSubnetIds added in v1.36.9 

func (s *VpcDestinationSummary) SetSubnetIds(v []*string) *VpcDestinationSummary

SetSubnetIds sets the SubnetIds field's value.

func (*VpcDestinationSummary) SetVpcId added in v1.36.9 

func (s *VpcDestinationSummary) SetVpcId(v string) *VpcDestinationSummary

SetVpcId sets the VpcId field's value.

func (VpcDestinationSummary) String added in v1.36.9 

func (s VpcDestinationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.