iot-2015-05-28 library

Classes

AbortConfig
The criteria that determine when and how a job abort takes place.
AbortCriteria
The criteria that determine when and how a job abort takes place.
Action
Describes the actions associated with a rule.
ActiveViolation
Information about an active Device Defender security profile behavior violation.
AddThingsToThingGroupParams
Parameters used when defining a mitigation action that move a set of things to a thing group.
AddThingToBillingGroupResponse
AddThingToThingGroupResponse
AlertTarget
A structure containing the alert target ARN and the role ARN.
Allowed
Contains information that allowed the authorization.
AssetPropertyTimestamp
An asset property timestamp entry containing the following information.
AssetPropertyValue
An asset property value entry containing the following information.
AssetPropertyVariant
Contains an asset property value (of a single type).
AssociateTargetsWithJobResponse
AttachSecurityProfileResponse
AttachThingPrincipalResponse
The output from the AttachThingPrincipal operation.
AttributePayload
The attribute payload.
AuditCheckConfiguration
Which audit checks are enabled and disabled for this account.
AuditCheckDetails
Information about the audit check.
AuditFinding
The findings (results) of the audit.
AuditMitigationActionExecutionMetadata
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
AuditMitigationActionsTaskMetadata
Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.
AuditMitigationActionsTaskTarget
Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
AuditNotificationTarget
Information about the targets to which audit notifications are sent.
AuditSuppression
Filters out specific findings of a Device Defender audit.
AuditTaskMetadata
The audits that were performed.
AuthInfo
A collection of authorization information.
AuthorizerConfig
An object that specifies the authorization service for a domain.
AuthorizerDescription
The authorizer description.
AuthorizerSummary
The authorizer summary.
AuthResult
The authorizer result.
AwsClientCredentials
AWS credentials.
AwsJobAbortConfig
The criteria that determine when and how a job abort takes place.
AwsJobAbortCriteria
The criteria that determine when and how a job abort takes place.
AwsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
AwsJobExponentialRolloutRate
The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
AwsJobPresignedUrlConfig
Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
AwsJobRateIncreaseCriteria
The criteria to initiate the increase in rate of rollout for a job.
AwsJobTimeoutConfig
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.
Behavior
A Device Defender security profile behavior.
BehaviorCriteria
The criteria by which the behavior is determined to be normal.
BehaviorModelTrainingSummary
The summary of an ML Detect behavior model.
BillingGroupMetadata
Additional information about the billing group.
BillingGroupProperties
The properties of a billing group.
CACertificate
A CA certificate.
CACertificateDescription
Describes a CA certificate.
CancelAuditMitigationActionsTaskResponse
CancelAuditTaskResponse
CancelDetectMitigationActionsTaskResponse
CancelJobResponse
Certificate
Information about a certificate.
CertificateDescription
Describes a certificate.
CertificateValidity
When the certificate is valid.
ClearDefaultAuthorizerResponse
CloudwatchAlarmAction
Describes an action that updates a CloudWatch alarm.
CloudwatchLogsAction
Describes an action that sends data to CloudWatch Logs.
CloudwatchMetricAction
Describes an action that captures a CloudWatch metric.
CodeSigning
Describes the method to use when code signing a file.
CodeSigningCertificateChain
Describes the certificate chain being used when code signing a file.
CodeSigningSignature
Describes the signature for a file.
Configuration
Configuration.
ConfirmTopicRuleDestinationResponse
CreateAuditSuppressionResponse
CreateAuthorizerResponse
CreateBillingGroupResponse
CreateCertificateFromCsrResponse
The output from the CreateCertificateFromCsr operation.
CreateCustomMetricResponse
CreateDimensionResponse
CreateDomainConfigurationResponse
CreateDynamicThingGroupResponse
CreateJobResponse
CreateKeysAndCertificateResponse
The output of the CreateKeysAndCertificate operation.
CreateMitigationActionResponse
CreateOTAUpdateResponse
CreatePolicyResponse
The output from the CreatePolicy operation.
CreatePolicyVersionResponse
The output of the CreatePolicyVersion operation.
CreateProvisioningClaimResponse
CreateProvisioningTemplateResponse
CreateProvisioningTemplateVersionResponse
CreateRoleAliasResponse
CreateScheduledAuditResponse
CreateSecurityProfileResponse
CreateStreamResponse
CreateThingGroupResponse
CreateThingResponse
The output of the CreateThing operation.
CreateThingTypeResponse
The output of the CreateThingType operation.
CreateTopicRuleDestinationResponse
CustomCodeSigning
Describes a custom method used to code sign a file.
DeleteAccountAuditConfigurationResponse
DeleteAuditSuppressionResponse
DeleteAuthorizerResponse
DeleteBillingGroupResponse
DeleteCACertificateResponse
The output for the DeleteCACertificate operation.
DeleteCustomMetricResponse
DeleteDimensionResponse
DeleteDomainConfigurationResponse
DeleteDynamicThingGroupResponse
DeleteMitigationActionResponse
DeleteOTAUpdateResponse
DeleteProvisioningTemplateResponse
DeleteProvisioningTemplateVersionResponse
DeleteRegistrationCodeResponse
The output for the DeleteRegistrationCode operation.
DeleteRoleAliasResponse
DeleteScheduledAuditResponse
DeleteSecurityProfileResponse
DeleteStreamResponse
DeleteThingGroupResponse
DeleteThingResponse
The output of the DeleteThing operation.
DeleteThingTypeResponse
The output for the DeleteThingType operation.
DeleteTopicRuleDestinationResponse
Denied
Contains information that denied the authorization.
DeprecateThingTypeResponse
The output for the DeprecateThingType operation.
DescribeAccountAuditConfigurationResponse
DescribeAuditFindingResponse
DescribeAuditMitigationActionsTaskResponse
DescribeAuditSuppressionResponse
DescribeAuditTaskResponse
DescribeAuthorizerResponse
DescribeBillingGroupResponse
DescribeCACertificateResponse
The output from the DescribeCACertificate operation.
DescribeCertificateResponse
The output of the DescribeCertificate operation.
DescribeCustomMetricResponse
DescribeDefaultAuthorizerResponse
DescribeDetectMitigationActionsTaskResponse
DescribeDimensionResponse
DescribeDomainConfigurationResponse
DescribeEndpointResponse
The output from the DescribeEndpoint operation.
DescribeEventConfigurationsResponse
DescribeIndexResponse
DescribeJobExecutionResponse
DescribeJobResponse
DescribeMitigationActionResponse
DescribeProvisioningTemplateResponse
DescribeProvisioningTemplateVersionResponse
DescribeRoleAliasResponse
DescribeScheduledAuditResponse
DescribeSecurityProfileResponse
DescribeStreamResponse
DescribeThingGroupResponse
DescribeThingRegistrationTaskResponse
DescribeThingResponse
The output from the DescribeThing operation.
DescribeThingTypeResponse
The output for the DescribeThingType operation.
Destination
Describes the location of the updated firmware.
DetachSecurityProfileResponse
DetachThingPrincipalResponse
The output from the DetachThingPrincipal operation.
DetectMitigationActionExecution
Describes which mitigation actions should be executed.
DetectMitigationActionsTaskStatistics
The statistics of a mitigation action task.
DetectMitigationActionsTaskSummary
The summary of the mitigation action tasks.
DetectMitigationActionsTaskTarget
The target of a mitigation action task.
DomainConfigurationSummary
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 AWS-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint. [...]
DynamoDBAction
Describes an action to write to a DynamoDB table. [...]
DynamoDBv2Action
Describes an action to write to a DynamoDB table. [...]
EffectivePolicy
The policy that has the effect on the authorization results.
ElasticsearchAction
Describes an action that writes data to an Amazon Elasticsearch Service domain.
EnableIoTLoggingParams
Parameters used when defining a mitigation action that enable AWS IoT logging.
ErrorInfo
Error information.
ExplicitDeny
Information that explicitly denies authorization.
ExponentialRolloutRate
Allows you to create an exponential rate of rollout for a job.
Field
Describes the name and data type at a field.
FileLocation
The location of the OTA update.
FirehoseAction
Describes an action that writes data to an Amazon Kinesis Firehose stream.
GetBehaviorModelTrainingSummariesResponse
GetCardinalityResponse
GetEffectivePoliciesResponse
GetIndexingConfigurationResponse
GetJobDocumentResponse
GetLoggingOptionsResponse
The output from the GetLoggingOptions operation.
GetOTAUpdateResponse
GetPercentilesResponse
GetPolicyResponse
The output from the GetPolicy operation.
GetPolicyVersionResponse
The output from the GetPolicyVersion operation.
GetRegistrationCodeResponse
The output from the GetRegistrationCode operation.
GetStatisticsResponse
GetTopicRuleDestinationResponse
GetTopicRuleResponse
The output from the GetTopicRule operation.
GetV2LoggingOptionsResponse
GroupNameAndArn
The name and ARN of a group.
HttpAction
Send data to an HTTPS endpoint.
HttpActionHeader
The HTTP action header.
HttpAuthorization
The authorization method used to send messages.
HttpContext
Specifies the HTTP context to use for the test authorizer request.
HttpUrlDestinationConfiguration
HTTP URL destination configuration used by the topic rule's HTTP action.
HttpUrlDestinationProperties
HTTP URL destination properties.
HttpUrlDestinationSummary
Information about an HTTP URL destination.
ImplicitDeny
Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
IoT
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
IotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
IotEventsAction
Sends an input to an AWS IoT Events detector.
IotSiteWiseAction
Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
Job
The Job object contains details about a job.
JobExecution
The job execution object represents the execution of a job on a particular device.
JobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
JobExecutionStatusDetails
Details of the job execution status.
JobExecutionSummary
The job execution summary.
JobExecutionSummaryForJob
Contains a summary of information about job executions for a specific job.
JobExecutionSummaryForThing
The job execution summary for a thing.
JobProcessDetails
The job process details.
JobSummary
The job summary.
KafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
KeyPair
Describes a key pair.
KinesisAction
Describes an action to write data to an Amazon Kinesis stream.
LambdaAction
Describes an action to invoke a Lambda function.
ListActiveViolationsResponse
ListAttachedPoliciesResponse
ListAuditFindingsResponse
ListAuditMitigationActionsExecutionsResponse
ListAuditMitigationActionsTasksResponse
ListAuditSuppressionsResponse
ListAuditTasksResponse
ListAuthorizersResponse
ListBillingGroupsResponse
ListCACertificatesResponse
The output from the ListCACertificates operation.
ListCertificatesByCAResponse
The output of the ListCertificatesByCA operation.
ListCertificatesResponse
The output of the ListCertificates operation.
ListCustomMetricsResponse
ListDetectMitigationActionsExecutionsResponse
ListDetectMitigationActionsTasksResponse
ListDimensionsResponse
ListDomainConfigurationsResponse
ListIndicesResponse
ListJobExecutionsForJobResponse
ListJobExecutionsForThingResponse
ListJobsResponse
ListMitigationActionsResponse
ListOTAUpdatesResponse
ListOutgoingCertificatesResponse
The output from the ListOutgoingCertificates operation.
ListPoliciesResponse
The output from the ListPolicies operation.
ListPolicyPrincipalsResponse
The output from the ListPolicyPrincipals operation.
ListPolicyVersionsResponse
The output from the ListPolicyVersions operation.
ListPrincipalPoliciesResponse
The output from the ListPrincipalPolicies operation.
ListPrincipalThingsResponse
The output from the ListPrincipalThings operation.
ListProvisioningTemplatesResponse
ListProvisioningTemplateVersionsResponse
ListRoleAliasesResponse
ListScheduledAuditsResponse
ListSecurityProfilesForTargetResponse
ListSecurityProfilesResponse
ListStreamsResponse
ListTagsForResourceResponse
ListTargetsForPolicyResponse
ListTargetsForSecurityProfileResponse
ListThingGroupsForThingResponse
ListThingGroupsResponse
ListThingPrincipalsResponse
The output from the ListThingPrincipals operation.
ListThingRegistrationTaskReportsResponse
ListThingRegistrationTasksResponse
ListThingsInBillingGroupResponse
ListThingsInThingGroupResponse
ListThingsResponse
The output from the ListThings operation.
ListThingTypesResponse
The output for the ListThingTypes operation.
ListTopicRuleDestinationsResponse
ListTopicRulesResponse
The output from the ListTopicRules operation.
ListV2LoggingLevelsResponse
ListViolationEventsResponse
LoggingOptionsPayload
Describes the logging options payload.
LogTarget
A log target.
LogTargetConfiguration
The target configuration.
MachineLearningDetectionConfig
The configuration of an ML Detect Security Profile.
MetricDimension
The dimension of a metric.
MetricToRetain
The metric you want to retain. Dimensions are optional.
MetricValue
The value to be compared with the metric.
MitigationAction
Describes which changes should be applied as part of a mitigation action.
MitigationActionIdentifier
Information that identifies a mitigation action. This information is returned by ListMitigationActions.
MitigationActionParams
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).
MqttContext
Specifies the MQTT context to use for the test authorizer request
NonCompliantResource
Information about the resource that was noncompliant with the audit check.
OTAUpdateFile
Describes a file to be associated with an OTA update.
OTAUpdateInfo
Information about an OTA update.
OTAUpdateSummary
An OTA update summary.
OutgoingCertificate
A certificate that has been transferred but not yet accepted.
PercentPair
Describes the percentile and percentile value.
Policy
Describes an AWS IoT policy.
PolicyVersion
Describes a policy version.
PolicyVersionIdentifier
Information about the version of the policy associated with the resource.
PresignedUrlConfig
Configuration for pre-signed S3 URLs.
ProvisioningHook
Structure that contains payloadVersion and targetArn.
ProvisioningTemplateSummary
A summary of information about a fleet provisioning template.
ProvisioningTemplateVersionSummary
A summary of information about a fleet provision template version.
PublishFindingToSnsParams
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.
PutAssetPropertyValueEntry
An asset property value entry containing the following information.
PutItemInput
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
RateIncreaseCriteria
Allows you to define a criteria to initiate the increase in rate of rollout for a job.
RegisterCACertificateResponse
The output from the RegisterCACertificateResponse operation.
RegisterCertificateResponse
The output from the RegisterCertificate operation.
RegisterCertificateWithoutCAResponse
RegisterThingResponse
RegistrationConfig
The registration configuration.
RelatedResource
Information about a related resource.
RemoveThingFromBillingGroupResponse
RemoveThingFromThingGroupResponse
ReplaceDefaultPolicyVersionParams
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
RepublishAction
Describes an action to republish to another topic.
ResourceIdentifier
Information that identifies the noncompliant resource.
RoleAliasDescription
Role alias description.
S3Action
Describes an action to write data to an Amazon S3 bucket.
S3Destination
Describes the location of updated firmware in S3.
S3Location
The S3 location.
SalesforceAction
Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
ScheduledAuditMetadata
Information about the scheduled audit.
SearchIndexResponse
SecurityProfileIdentifier
Identifying information for a Device Defender security profile.
SecurityProfileTarget
A target to which an alert is sent when a security profile behavior is violated.
SecurityProfileTargetMapping
Information about a security profile and the target associated with it.
ServerCertificateSummary
An object that contains information about a server certificate.
SetDefaultAuthorizerResponse
SigningProfileParameter
Describes the code-signing profile.
SigV4Authorization
For more information, see Signature Version 4 signing process.
SnsAction
Describes an action to publish to an Amazon SNS topic.
SqsAction
Describes an action to publish data to an Amazon SQS queue.
StartAuditMitigationActionsTaskResponse
StartDetectMitigationActionsTaskResponse
StartOnDemandAuditTaskResponse
StartSigningJobParameter
Information required to start a signing job.
StartThingRegistrationTaskResponse
StatisticalThreshold
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.
Statistics
A map of key-value pairs for all supported statistics. Currently, only count is supported.
StepFunctionsAction
Starts execution of a Step Functions state machine.
StopThingRegistrationTaskResponse
Stream
Describes a group of files that can be streamed.
StreamFile
Represents a file to stream.
StreamInfo
Information about a stream.
StreamSummary
A summary of a stream.
Tag
A set of key/value pairs that are used to manage the resource.
TagResourceResponse
TaskStatistics
Statistics for the checks performed during the audit.
TaskStatisticsForAuditCheck
Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.
TestAuthorizationResponse
TestInvokeAuthorizerResponse
ThingAttribute
The properties of the thing, including thing name, thing type name, and a list of thing attributes.
ThingConnectivity
The connectivity status of the thing.
ThingDocument
The thing search index document.
ThingGroupDocument
The thing group search index document.
ThingGroupIndexingConfiguration
Thing group indexing configuration.
ThingGroupMetadata
Thing group metadata.
ThingGroupProperties
Thing group properties.
ThingIndexingConfiguration
The thing indexing configuration. For more information, see Managing Thing Indexing.
ThingTypeDefinition
The definition of the thing type, including thing type name and description.
ThingTypeMetadata
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.
ThingTypeProperties
The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
TimeoutConfig
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.
TimestreamAction
The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.
TimestreamDimension
Metadata attributes of the time series that are written in each measure record.
TimestreamTimestamp
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
TlsContext
Specifies the TLS context to use for the test authorizer request.
TopicRule
Describes a rule.
TopicRuleDestination
A topic rule destination.
TopicRuleDestinationConfiguration
Configuration of the topic rule destination.
TopicRuleDestinationSummary
Information about the topic rule destination.
TopicRuleListItem
Describes a rule.
TopicRulePayload
Describes a rule.
TransferCertificateResponse
The output from the TransferCertificate operation.
TransferData
Data used to transfer a certificate to an AWS account.
UntagResourceResponse
UpdateAccountAuditConfigurationResponse
UpdateAuditSuppressionResponse
UpdateAuthorizerResponse
UpdateBillingGroupResponse
UpdateCACertificateParams
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
UpdateCustomMetricResponse
UpdateDeviceCertificateParams
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
UpdateDimensionResponse
UpdateDomainConfigurationResponse
UpdateDynamicThingGroupResponse
UpdateEventConfigurationsResponse
UpdateIndexingConfigurationResponse
UpdateMitigationActionResponse
UpdateProvisioningTemplateResponse
UpdateRoleAliasResponse
UpdateScheduledAuditResponse
UpdateSecurityProfileResponse
UpdateStreamResponse
UpdateThingGroupResponse
UpdateThingGroupsForThingResponse
UpdateThingResponse
The output from the UpdateThing operation.
UpdateTopicRuleDestinationResponse
ValidateSecurityProfileBehaviorsResponse
ValidationError
Information about an error found in a behavior specification.
ViolationEvent
Information about a Device Defender security profile behavior violation.
ViolationEventAdditionalInfo
The details of a violation event.
ViolationEventOccurrenceRange
Specifies the time period of which violation events occurred between.
VpcDestinationConfiguration
The configuration information for a virtual private cloud (VPC) destination.
VpcDestinationProperties
The properties of a virtual private cloud (VPC) destination.
VpcDestinationSummary
The summary of a virtual private cloud (VPC) destination.

Enums

AbortAction
ActionType
AlertTargetType
The type of alert target: one of "SNS".
AuditCheckRunStatus
AuditFindingSeverity
AuditFrequency
AuditMitigationActionsExecutionStatus
AuditMitigationActionsTaskStatus
AuditNotificationType
AuditTaskStatus
AuditTaskType
AuthDecision
AuthorizerStatus
AutoRegistrationStatus
AwsJobAbortCriteriaAbortAction
AwsJobAbortCriteriaFailureType
BehaviorCriteriaType
CACertificateStatus
CACertificateUpdateAction
CannedAccessControlList
CertificateMode
CertificateStatus
ComparisonOperator
ConfidenceLevel
CustomMetricType
DayOfWeek
DetectMitigationActionExecutionStatus
DetectMitigationActionsTaskStatus
DeviceCertificateUpdateAction
DimensionType
DimensionValueOperator
DomainConfigurationStatus
DomainType
DynamicGroupStatus
DynamoKeyType
EventType
FieldType
IndexStatus
JobExecutionFailureType
JobExecutionStatus
JobStatus
LogLevel
LogTargetType
MessageFormat
MitigationActionType
ModelStatus
OTAUpdateStatus
PolicyTemplateName
Protocol
ReportType
ResourceType
ServerCertificateStatus
ServiceType
Status
TargetSelection
ThingConnectivityIndexingMode
ThingGroupIndexingMode
ThingIndexingMode
TopicRuleDestinationStatus
ViolationEventType

Exceptions / Errors

CertificateConflictException
CertificateStateException
CertificateValidationException
ConflictingResourceUpdateException
DeleteConflictException
IndexNotReadyException
InternalException
InternalFailureException
InvalidAggregationException
InvalidQueryException
InvalidRequestException
InvalidResponseException
InvalidStateTransitionException
LimitExceededException
MalformedPolicyException
NotConfiguredException
RegistrationCodeValidationException
ResourceAlreadyExistsException
ResourceNotFoundException
ResourceRegistrationFailureException
ServiceUnavailableException
SqlParseException
TaskAlreadyExistsException
ThrottlingException
TransferAlreadyCompletedException
TransferConflictException
UnauthorizedException
VersionConflictException
VersionsLimitExceededException