Table of Contents
A low-level client representing AWS IoT:
client = session.create_client('iot')
These are the available methods:
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.
See also: AWS API Documentation
Request Syntax
response = client.accept_certificate_transfer(
certificateId='string',
setAsActive=True|False
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
None
Adds a thing to a thing group.
See also: AWS API Documentation
Request Syntax
response = client.add_thing_to_thing_group(
thingGroupName='string',
thingGroupArn='string',
thingName='string',
thingArn='string'
)
dict
Response Syntax
{}
Response Structure
Associates a group with a continuous job. The following criteria must be met:
See also: AWS API Documentation
Request Syntax
response = client.associate_targets_with_job(
targets=[
'string',
],
jobId='string',
comment='string'
)
[REQUIRED]
A list of thing group ARNs that define the targets of the job.
[REQUIRED]
The unique identifier you assigned to this job when it was created.
dict
Response Syntax
{
'jobArn': 'string',
'jobId': 'string',
'description': 'string'
}
Response Structure
(dict) --
jobArn (string) --
An ARN identifying the job.
jobId (string) --
The unique identifier you assigned to this job when it was created.
description (string) --
A short text description of the job.
Attaches a policy to the specified target.
See also: AWS API Documentation
Request Syntax
response = client.attach_policy(
policyName='string',
target='string'
)
[REQUIRED]
The name of the policy to attach.
[REQUIRED]
The identity to which the policy is attached.
None
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.attach_principal_policy(
policyName='string',
principal='string'
)
[REQUIRED]
The policy name.
[REQUIRED]
The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
None
Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.
See also: AWS API Documentation
Request Syntax
response = client.attach_security_profile(
securityProfileName='string',
securityProfileTargetArn='string'
)
[REQUIRED]
The security profile that is attached.
[REQUIRED]
The ARN of the target (thing group) to which the security profile is attached.
dict
Response Syntax
{}
Response Structure
Attaches the specified principal to the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.attach_thing_principal(
thingName='string',
principal='string'
)
[REQUIRED]
The name of the thing.
[REQUIRED]
The principal, such as a certificate or other credential.
dict
Response Syntax
{}
Response Structure
(dict) --
The output from the AttachThingPrincipal operation.
Check if an operation can be paginated.
Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
See also: AWS API Documentation
Request Syntax
response = client.cancel_audit_task(
taskId='string'
)
[REQUIRED]
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
{}
Response Structure
Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
See also: AWS API Documentation
Request Syntax
response = client.cancel_certificate_transfer(
certificateId='string'
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Cancels a job.
See also: AWS API Documentation
Request Syntax
response = client.cancel_job(
jobId='string',
comment='string',
force=True|False
)
[REQUIRED]
The unique identifier you assigned to this job when it was created.
(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.
dict
Response Syntax
{
'jobArn': 'string',
'jobId': 'string',
'description': 'string'
}
Response Structure
(dict) --
jobArn (string) --
The job ARN.
jobId (string) --
The unique identifier you assigned to this job when it was created.
description (string) --
A short text description of the job.
Cancels the execution of a job for a given thing.
See also: AWS API Documentation
Request Syntax
response = client.cancel_job_execution(
jobId='string',
thingName='string',
force=True|False,
expectedVersion=123,
statusDetails={
'string': 'string'
}
)
[REQUIRED]
The ID of the job to be canceled.
[REQUIRED]
The name of the thing whose execution of the job will be canceled.
(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.
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.
None
Clears the default authorizer.
See also: AWS API Documentation
Request Syntax
response = client.clear_default_authorizer()
{}
Response Structure
Creates an authorizer.
See also: AWS API Documentation
Request Syntax
response = client.create_authorizer(
authorizerName='string',
authorizerFunctionArn='string',
tokenKeyName='string',
tokenSigningPublicKeys={
'string': 'string'
},
status='ACTIVE'|'INACTIVE'
)
[REQUIRED]
The authorizer name.
[REQUIRED]
The ARN of the authorizer's Lambda function.
[REQUIRED]
The name of the token key used to extract the token from the HTTP headers.
[REQUIRED]
The public keys used to verify the digital signature returned by your custom authentication service.
dict
Response Syntax
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
(dict) --
authorizerName (string) --
The authorizer's name.
authorizerArn (string) --
The authorizer ARN.
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
See also: AWS API Documentation
Request Syntax
response = client.create_certificate_from_csr(
certificateSigningRequest='string',
setAsActive=True|False
)
[REQUIRED]
The certificate signing request (CSR).
dict
Response Syntax
{
'certificateArn': 'string',
'certificateId': 'string',
'certificatePem': 'string'
}
Response Structure
(dict) --
The output from the CreateCertificateFromCsr operation.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
certificateId (string) --
The ID of the certificate. Certificate management operations only take a certificateId.
certificatePem (string) --
The certificate data, in PEM format.
Creates a job.
See also: AWS API Documentation
Request Syntax
response = client.create_job(
jobId='string',
targets=[
'string',
],
documentSource='string',
document='string',
description='string',
presignedUrlConfig={
'roleArn': 'string',
'expiresInSec': 123
},
targetSelection='CONTINUOUS'|'SNAPSHOT',
jobExecutionsRolloutConfig={
'maximumPerMinute': 123
}
)
[REQUIRED]
A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
[REQUIRED]
A list of things and thing groups to which the job should be sent.
Configuration information for pre-signed S3 URLs.
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.
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.
Allows you to create a staged rollout of the job.
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
dict
Response Syntax
{
'jobArn': 'string',
'jobId': 'string',
'description': 'string'
}
Response Structure
(dict) --
jobArn (string) --
The job ARN.
jobId (string) --
The unique identifier you assigned to this job.
description (string) --
The job description.
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
See also: AWS API Documentation
Request Syntax
response = client.create_keys_and_certificate(
setAsActive=True|False
)
{
'certificateArn': 'string',
'certificateId': 'string',
'certificatePem': 'string',
'keyPair': {
'PublicKey': 'string',
'PrivateKey': 'string'
}
}
Response Structure
The output of the CreateKeysAndCertificate operation.
The ARN of the certificate.
The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
The certificate data, in PEM format.
The generated key pair.
The public key.
The private key.
Creates an AWS IoT OTAUpdate on a target group of things or groups.
See also: AWS API Documentation
Request Syntax
response = client.create_ota_update(
otaUpdateId='string',
description='string',
targets=[
'string',
],
targetSelection='CONTINUOUS'|'SNAPSHOT',
awsJobExecutionsRolloutConfig={
'maximumPerMinute': 123
},
files=[
{
'fileName': 'string',
'fileVersion': 'string',
'fileLocation': {
'stream': {
'streamId': 'string',
'fileId': 123
},
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'codeSigning': {
'awsSignerJobId': 'string',
'startSigningJobParameter': {
'signingProfileParameter': {
'certificateArn': 'string',
'platform': 'string',
'certificatePathOnDevice': 'string'
},
'signingProfileName': 'string',
'destination': {
's3Destination': {
'bucket': 'string',
'prefix': 'string'
}
}
},
'customCodeSigning': {
'signature': {
'inlineDocument': b'bytes'
},
'certificateChain': {
'certificateName': 'string',
'inlineDocument': 'string'
},
'hashAlgorithm': 'string',
'signatureAlgorithm': 'string'
}
},
'attributes': {
'string': 'string'
}
},
],
roleArn='string',
additionalParameters={
'string': 'string'
}
)
[REQUIRED]
The ID of the OTA update to be created.
[REQUIRED]
The targeted devices to receive OTA updates.
Configuration for the rollout of OTA updates.
The maximum number of OTA update job executions started per minute.
[REQUIRED]
The files to be streamed by the OTA update.
Describes a file to be associated with an OTA update.
The name of the file.
The file version.
The location of the updated firmware.
The stream that contains the OTA update.
The stream ID.
The ID of a file associated with a stream.
The location of the updated firmware in S3.
The S3 bucket.
The S3 key.
The S3 bucket version.
The code signing method of the file.
The ID of the AWSSignerJob which was created to sign the file.
Describes the code-signing job.
Describes the code-signing profile.
Certificate ARN.
The hardware platform of your device.
The location of the code-signing certificate on your device.
The code-signing profile name.
The location to write the code-signed file.
Describes the location in S3 of the updated firmware.
The S3 bucket that contains the updated firmware.
The S3 prefix.
A custom method for code signing a file.
The signature for the file.
A base64 encoded binary representation of the code signing signature.
The certificate chain.
The name of the certificate.
A base64 encoded binary representation of the code signing certificate chain.
The hash algorithm used to code sign the file.
The signature algorithm used to code sign the file.
A list of name/attribute pairs.
[REQUIRED]
The IAM role that allows access to the AWS IoT Jobs service.
A list of additional OTA update parameters which are name-value pairs.
dict
Response Syntax
{
'otaUpdateId': 'string',
'awsIotJobId': 'string',
'otaUpdateArn': 'string',
'awsIotJobArn': 'string',
'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
}
Response Structure
(dict) --
otaUpdateId (string) --
The OTA update ID.
awsIotJobId (string) --
The AWS IoT job ID associated with the OTA update.
otaUpdateArn (string) --
The OTA update ARN.
awsIotJobArn (string) --
The AWS IoT job ARN associated with the OTA update.
otaUpdateStatus (string) --
The OTA update status.
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
See also: AWS API Documentation
Request Syntax
response = client.create_policy(
policyName='string',
policyDocument='string'
)
[REQUIRED]
The policy name.
[REQUIRED]
The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
dict
Response Syntax
{
'policyName': 'string',
'policyArn': 'string',
'policyDocument': 'string',
'policyVersionId': 'string'
}
Response Structure
(dict) --
The output from the CreatePolicy operation.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
policyDocument (string) --
The JSON document that describes the policy.
policyVersionId (string) --
The policy version ID.
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
See also: AWS API Documentation
Request Syntax
response = client.create_policy_version(
policyName='string',
policyDocument='string',
setAsDefault=True|False
)
[REQUIRED]
The policy name.
[REQUIRED]
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
dict
Response Syntax
{
'policyArn': 'string',
'policyDocument': 'string',
'policyVersionId': 'string',
'isDefaultVersion': True|False
}
Response Structure
(dict) --
The output of the CreatePolicyVersion operation.
policyArn (string) --
The policy ARN.
policyDocument (string) --
The JSON document that describes the policy.
policyVersionId (string) --
The policy version ID.
isDefaultVersion (boolean) --
Specifies whether the policy version is the default.
Creates a role alias.
See also: AWS API Documentation
Request Syntax
response = client.create_role_alias(
roleAlias='string',
roleArn='string',
credentialDurationSeconds=123
)
[REQUIRED]
The role alias that points to a role ARN. This allows you to change the role without having to update the device.
[REQUIRED]
The role ARN.
dict
Response Syntax
{
'roleAlias': 'string',
'roleAliasArn': 'string'
}
Response Structure
(dict) --
roleAlias (string) --
The role alias.
roleAliasArn (string) --
The role alias ARN.
Creates a scheduled audit that is run at a specified time interval.
See also: AWS API Documentation
Request Syntax
response = client.create_scheduled_audit(
frequency='DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
dayOfMonth='string',
dayOfWeek='SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
targetCheckNames=[
'string',
],
scheduledAuditName='string'
)
[REQUIRED]
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
[REQUIRED]
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
[REQUIRED]
The name you want to give to the scheduled audit. (Max. 128 chars)
dict
Response Syntax
{
'scheduledAuditArn': 'string'
}
Response Structure
(dict) --
scheduledAuditArn (string) --
The ARN of the scheduled audit.
Creates a Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.create_security_profile(
securityProfileName='string',
securityProfileDescription='string',
behaviors=[
{
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
],
alertTargets={
'string': {
'alertTargetArn': 'string',
'roleArn': 'string'
}
}
)
[REQUIRED]
The name you are giving to the security profile.
[REQUIRED]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
A Device Defender security profile behavior.
The name you have given to the behavior.
What is measured by the behavior.
The criteria that determine if a device is behaving normally in regard to the metric .
The operator that relates the thing measured (metric ) to the criteria (value ).
The value to be compared with the metric .
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
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.
The type of alert target: one of "SNS".
A structure containing the alert target ARN and the role ARN.
The ARN of the notification target to which alerts are sent.
The ARN of the role that grants permission to send alerts to the notification target.
dict
Response Syntax
{
'securityProfileName': 'string',
'securityProfileArn': 'string'
}
Response Structure
(dict) --
securityProfileName (string) --
The name you gave to the security profile.
securityProfileArn (string) --
The ARN of the security profile.
Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.
See also: AWS API Documentation
Request Syntax
response = client.create_stream(
streamId='string',
description='string',
files=[
{
'fileId': 123,
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
],
roleArn='string'
)
[REQUIRED]
The stream ID.
[REQUIRED]
The files to stream.
Represents a file to stream.
The file ID.
The location of the file in S3.
The S3 bucket.
The S3 key.
The S3 bucket version.
[REQUIRED]
An IAM role that allows the IoT service principal assumes to access your S3 files.
dict
Response Syntax
{
'streamId': 'string',
'streamArn': 'string',
'description': 'string',
'streamVersion': 123
}
Response Structure
(dict) --
streamId (string) --
The stream ID.
streamArn (string) --
The stream ARN.
description (string) --
A description of the stream.
streamVersion (integer) --
The version of the stream.
Creates a thing record in the registry.
Note
This is a control plane operation. See Authorization for information about authorizing control plane actions.
See also: AWS API Documentation
Request Syntax
response = client.create_thing(
thingName='string',
thingTypeName='string',
attributePayload={
'attributes': {
'string': 'string'
},
'merge': True|False
}
)
[REQUIRED]
The name of the thing to create.
The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
{\"attributes\":{\"string1\":\"string2\"}}
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
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.
Note
The merge attribute is only valid when calling UpdateThing .
dict
Response Syntax
{
'thingName': 'string',
'thingArn': 'string',
'thingId': 'string'
}
Response Structure
(dict) --
The output of the CreateThing operation.
thingName (string) --
The name of the new thing.
thingArn (string) --
The ARN of the new thing.
thingId (string) --
The thing ID.
Create a thing group.
Note
This is a control plane operation. See Authorization for information about authorizing control plane actions.
See also: AWS API Documentation
Request Syntax
response = client.create_thing_group(
thingGroupName='string',
parentGroupName='string',
thingGroupProperties={
'thingGroupDescription': 'string',
'attributePayload': {
'attributes': {
'string': 'string'
},
'merge': True|False
}
}
)
[REQUIRED]
The thing group name to create.
The thing group properties.
The thing group description.
The thing group attributes in JSON format.
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
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.
Note
The merge attribute is only valid when calling UpdateThing .
dict
Response Syntax
{
'thingGroupName': 'string',
'thingGroupArn': 'string',
'thingGroupId': 'string'
}
Response Structure
(dict) --
thingGroupName (string) --
The thing group name.
thingGroupArn (string) --
The thing group ARN.
thingGroupId (string) --
The thing group ID.
Creates a new thing type.
See also: AWS API Documentation
Request Syntax
response = client.create_thing_type(
thingTypeName='string',
thingTypeProperties={
'thingTypeDescription': 'string',
'searchableAttributes': [
'string',
]
}
)
[REQUIRED]
The name of the thing type.
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.
The description of the thing type.
A list of searchable thing attribute names.
dict
Response Syntax
{
'thingTypeName': 'string',
'thingTypeArn': 'string',
'thingTypeId': 'string'
}
Response Structure
(dict) --
The output of the CreateThingType operation.
thingTypeName (string) --
The name of the thing type.
thingTypeArn (string) --
The Amazon Resource Name (ARN) of the thing type.
thingTypeId (string) --
The thing type ID.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_topic_rule(
ruleName='string',
topicRulePayload={
'sql': 'string',
'description': 'string',
'actions': [
{
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
},
],
'ruleDisabled': True|False,
'awsIotSqlVersion': 'string',
'errorAction': {
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
}
}
)
[REQUIRED]
The name of the rule.
[REQUIRED]
The rule payload.
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
The description of the rule.
The actions associated with the rule.
Describes the actions associated with a rule.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
Specifies whether the rule is disabled.
The version of the SQL rules engine to use when evaluating the rule.
The action to take when an error occurs.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
None
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_account_audit_configuration(
deleteScheduledAudits=True|False
)
{}
Response Structure
Deletes an authorizer.
See also: AWS API Documentation
Request Syntax
response = client.delete_authorizer(
authorizerName='string'
)
[REQUIRED]
The name of the authorizer to delete.
{}
Response Structure
Deletes a registered CA certificate.
See also: AWS API Documentation
Request Syntax
response = client.delete_ca_certificate(
certificateId='string'
)
[REQUIRED]
The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
{}
Response Structure
The output for the DeleteCACertificate operation.
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
See also: AWS API Documentation
Request Syntax
response = client.delete_certificate(
certificateId='string',
forceDelete=True|False
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
None
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
jobId='string',
force=True|False
)
[REQUIRED]
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.
(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.
Note
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.
None
Deletes a job execution.
See also: AWS API Documentation
Request Syntax
response = client.delete_job_execution(
jobId='string',
thingName='string',
executionNumber=123,
force=True|False
)
[REQUIRED]
The ID of the job whose execution on a particular device will be deleted.
[REQUIRED]
The name of the thing whose job execution will be deleted.
[REQUIRED]
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.
(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.
Note
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.
None
Delete an OTA update.
See also: AWS API Documentation
Request Syntax
response = client.delete_ota_update(
otaUpdateId='string',
deleteStream=True|False,
forceDeleteAWSJob=True|False
)
[REQUIRED]
The OTA update ID to delete.
dict
Response Syntax
{}
Response Structure
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
See also: AWS API Documentation
Request Syntax
response = client.delete_policy(
policyName='string'
)
[REQUIRED]
The name of the policy to delete.
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy . To find out which version of a policy is marked as the default version, use ListPolicyVersions.
See also: AWS API Documentation
Request Syntax
response = client.delete_policy_version(
policyName='string',
policyVersionId='string'
)
[REQUIRED]
The name of the policy.
[REQUIRED]
The policy version ID.
None
Deletes a CA certificate registration code.
See also: AWS API Documentation
Request Syntax
response = client.delete_registration_code()
{}
Response Structure
The output for the DeleteRegistrationCode operation.
Deletes a role alias
See also: AWS API Documentation
Request Syntax
response = client.delete_role_alias(
roleAlias='string'
)
[REQUIRED]
The role alias to delete.
{}
Response Structure
Deletes a scheduled audit.
See also: AWS API Documentation
Request Syntax
response = client.delete_scheduled_audit(
scheduledAuditName='string'
)
[REQUIRED]
The name of the scheduled audit you want to delete.
{}
Response Structure
Deletes a Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_security_profile(
securityProfileName='string',
expectedVersion=123
)
[REQUIRED]
The name of the security profile to be deleted.
dict
Response Syntax
{}
Response Structure
Deletes a stream.
See also: AWS API Documentation
Request Syntax
response = client.delete_stream(
streamId='string'
)
[REQUIRED]
The stream ID.
{}
Response Structure
Deletes the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.delete_thing(
thingName='string',
expectedVersion=123
)
[REQUIRED]
The name of the thing to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
The output of the DeleteThing operation.
Deletes a thing group.
See also: AWS API Documentation
Request Syntax
response = client.delete_thing_group(
thingGroupName='string',
expectedVersion=123
)
[REQUIRED]
The name of the thing group to delete.
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_thing_type(
thingTypeName='string'
)
[REQUIRED]
The name of the thing type.
{}
Response Structure
The output for the DeleteThingType operation.
Deletes the rule.
See also: AWS API Documentation
Request Syntax
response = client.delete_topic_rule(
ruleName='string'
)
[REQUIRED]
The name of the rule.
Deletes a logging level.
See also: AWS API Documentation
Request Syntax
response = client.delete_v2_logging_level(
targetType='DEFAULT'|'THING_GROUP',
targetName='string'
)
[REQUIRED]
The type of resource for which you are configuring logging. Must be THING_Group .
[REQUIRED]
The name of the resource for which you are configuring logging.
None
Deprecates a thing type. You can not associate new things with deprecated thing type.
See also: AWS API Documentation
Request Syntax
response = client.deprecate_thing_type(
thingTypeName='string',
undoDeprecate=True|False
)
[REQUIRED]
The name of the thing type to deprecate.
dict
Response Syntax
{}
Response Structure
(dict) --
The output for the DeprecateThingType operation.
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_audit_configuration()
{
'roleArn': 'string',
'auditNotificationTargetConfigurations': {
'string': {
'targetArn': 'string',
'roleArn': 'string',
'enabled': True|False
}
},
'auditCheckConfigurations': {
'string': {
'enabled': True|False
}
}
}
Response Structure
The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.
On the first call to UpdateAccountAuditConfiguration this parameter is required.
Information about the targets to which audit notifications are sent for this account.
Information about the targets to which audit notifications are sent.
The ARN of the target (SNS topic) to which audit notifications are sent.
The ARN of the role that grants permission to send notifications to the target.
True if notifications to the target are enabled.
Which audit checks are enabled and disabled for this account.
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
Which audit checks are enabled and disabled for this account.
True if this audit check is enabled for this account.
Gets information about a Device Defender audit.
See also: AWS API Documentation
Request Syntax
response = client.describe_audit_task(
taskId='string'
)
[REQUIRED]
The ID of the audit whose information you want to get.
{
'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
'taskStartTime': datetime(2015, 1, 1),
'taskStatistics': {
'totalChecks': 123,
'inProgressChecks': 123,
'waitingForDataCollectionChecks': 123,
'compliantChecks': 123,
'nonCompliantChecks': 123,
'failedChecks': 123,
'canceledChecks': 123
},
'scheduledAuditName': 'string',
'auditDetails': {
'string': {
'checkRunStatus': 'IN_PROGRESS'|'WAITING_FOR_DATA_COLLECTION'|'CANCELED'|'COMPLETED_COMPLIANT'|'COMPLETED_NON_COMPLIANT'|'FAILED',
'checkCompliant': True|False,
'totalResourcesCount': 123,
'nonCompliantResourcesCount': 123,
'errorCode': 'string',
'message': 'string'
}
}
}
Response Structure
The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
The time the audit started.
Statistical information about the audit.
The number of checks in this audit.
The number of checks in progress.
The number of checks waiting for data collection.
The number of checks that found compliant resources.
The number of checks that found non-compliant resources.
The number of checks
The number of checks that did not run because the audit was canceled.
The name of the scheduled audit (only if the audit was a scheduled audit).
Detailed information about each check performed during this audit.
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
Information about the audit check.
The completion status of this check, one of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
True if the check completed and found all resources compliant.
The number of resources on which the check was performed.
The number of resources that the check found non-compliant.
The code of any error encountered when performing this check during this audit. One of "INSUFFICIENT_PERMISSIONS", or "AUDIT_CHECK_DISABLED".
The message associated with any error encountered when performing this check during this audit.
Describes an authorizer.
See also: AWS API Documentation
Request Syntax
response = client.describe_authorizer(
authorizerName='string'
)
[REQUIRED]
The name of the authorizer to describe.
{
'authorizerDescription': {
'authorizerName': 'string',
'authorizerArn': 'string',
'authorizerFunctionArn': 'string',
'tokenKeyName': 'string',
'tokenSigningPublicKeys': {
'string': 'string'
},
'status': 'ACTIVE'|'INACTIVE',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
}
Response Structure
The authorizer description.
The authorizer name.
The authorizer ARN.
The authorizer's Lambda function ARN.
The key used to extract the token from the HTTP headers.
The public keys used to validate the token signature returned by your custom authentication service.
The status of the authorizer.
The UNIX timestamp of when the authorizer was created.
The UNIX timestamp of when the authorizer was last updated.
Describes a registered CA certificate.
See also: AWS API Documentation
Request Syntax
response = client.describe_ca_certificate(
certificateId='string'
)
[REQUIRED]
The CA certificate identifier.
{
'certificateDescription': {
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE',
'certificatePem': 'string',
'ownedBy': 'string',
'creationDate': datetime(2015, 1, 1),
'autoRegistrationStatus': 'ENABLE'|'DISABLE',
'lastModifiedDate': datetime(2015, 1, 1),
'customerVersion': 123,
'generationId': 'string',
'validity': {
'notBefore': datetime(2015, 1, 1),
'notAfter': datetime(2015, 1, 1)
}
},
'registrationConfig': {
'templateBody': 'string',
'roleArn': 'string'
}
}
Response Structure
The output from the DescribeCACertificate operation.
The CA certificate description.
The CA certificate ARN.
The CA certificate ID.
The status of a CA certificate.
The CA certificate data, in PEM format.
The owner of the CA certificate.
The date the CA certificate was created.
Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
The date the CA certificate was last modified.
The customer version of the CA certificate.
The generation ID of the CA certificate.
When the CA certificate is valid.
The certificate is not valid before this date.
The certificate is not valid after this date.
Information about the registration configuration.
The template body.
The ARN of the role.
Gets information about the specified certificate.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificate(
certificateId='string'
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
{
'certificateDescription': {
'certificateArn': 'string',
'certificateId': 'string',
'caCertificateId': 'string',
'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
'certificatePem': 'string',
'ownedBy': 'string',
'previousOwnedBy': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'customerVersion': 123,
'transferData': {
'transferMessage': 'string',
'rejectReason': 'string',
'transferDate': datetime(2015, 1, 1),
'acceptDate': datetime(2015, 1, 1),
'rejectDate': datetime(2015, 1, 1)
},
'generationId': 'string',
'validity': {
'notBefore': datetime(2015, 1, 1),
'notAfter': datetime(2015, 1, 1)
}
}
}
Response Structure
The output of the DescribeCertificate operation.
The description of the certificate.
The ARN of the certificate.
The ID of the certificate.
The certificate ID of the CA certificate used to sign this certificate.
The status of the certificate.
The certificate data, in PEM format.
The ID of the AWS account that owns the certificate.
The ID of the AWS account of the previous owner of the certificate.
The date and time the certificate was created.
The date and time the certificate was last modified.
The customer version of the certificate.
The transfer data.
The transfer message.
The reason why the transfer was rejected.
The date the transfer took place.
The date the transfer was accepted.
The date the transfer was rejected.
The generation ID of the certificate.
When the certificate is valid.
The certificate is not valid before this date.
The certificate is not valid after this date.
Describes the default authorizer.
See also: AWS API Documentation
Request Syntax
response = client.describe_default_authorizer()
{
'authorizerDescription': {
'authorizerName': 'string',
'authorizerArn': 'string',
'authorizerFunctionArn': 'string',
'tokenKeyName': 'string',
'tokenSigningPublicKeys': {
'string': 'string'
},
'status': 'ACTIVE'|'INACTIVE',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
}
Response Structure
The default authorizer's description.
The authorizer name.
The authorizer ARN.
The authorizer's Lambda function ARN.
The key used to extract the token from the HTTP headers.
The public keys used to validate the token signature returned by your custom authentication service.
The status of the authorizer.
The UNIX timestamp of when the authorizer was created.
The UNIX timestamp of when the authorizer was last updated.
Returns a unique endpoint specific to the AWS account making the call.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint(
endpointType='string'
)
{
'endpointAddress': 'string'
}
Response Structure
The output from the DescribeEndpoint operation.
The endpoint. The format of the endpoint is as follows: identifier .iot.*region* .amazonaws.com.
Describes event configurations.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_configurations()
{
'eventConfigurations': {
'string': {
'Enabled': True|False
}
},
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
The event configurations.
Configuration.
True to enable the configuration.
The creation date of the event configuration.
The date the event configurations were last modified.
Describes a search index.
See also: AWS API Documentation
Request Syntax
response = client.describe_index(
indexName='string'
)
[REQUIRED]
The index name.
{
'indexName': 'string',
'indexStatus': 'ACTIVE'|'BUILDING'|'REBUILDING',
'schema': 'string'
}
Response Structure
The index name.
The index status.
Contains a value that specifies the type of indexing performed. Valid values are:
Describes a job.
See also: AWS API Documentation
Request Syntax
response = client.describe_job(
jobId='string'
)
[REQUIRED]
The unique identifier you assigned to this job when it was created.
{
'documentSource': 'string',
'job': {
'jobArn': 'string',
'jobId': 'string',
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
'forceCanceled': True|False,
'comment': 'string',
'targets': [
'string',
],
'description': 'string',
'presignedUrlConfig': {
'roleArn': 'string',
'expiresInSec': 123
},
'jobExecutionsRolloutConfig': {
'maximumPerMinute': 123
},
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'jobProcessDetails': {
'processingTargets': [
'string',
],
'numberOfCanceledThings': 123,
'numberOfSucceededThings': 123,
'numberOfFailedThings': 123,
'numberOfRejectedThings': 123,
'numberOfQueuedThings': 123,
'numberOfInProgressThings': 123,
'numberOfRemovedThings': 123
}
}
}
Response Structure
An S3 link to the job document.
Information about the job.
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
The unique identifier you assigned to this job when it was created.
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.
The status of the job, one of IN_PROGRESS , CANCELED , or COMPLETED .
Will be true if the job was canceled with the optional force parameter set to true .
If the job was updated, describes the reason for the update.
A list of IoT things and thing groups to which the job should be sent.
A short text description of the job.
Configuration for pre-signed S3 URLs.
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.
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.
Allows you to create a staged rollout of a job.
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
The time, in milliseconds since the epoch, when the job was created.
The time, in milliseconds since the epoch, when the job was last updated.
The time, in milliseconds since the epoch, when the job was completed.
Details about the job process.
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.
The number of things that cancelled the job.
The number of things which successfully completed the job.
The number of things that failed executing the job.
The number of things that rejected the job.
The number of things that are awaiting execution of the job.
The number of things currently executing the job.
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.
Describes a job execution.
See also: AWS API Documentation
Request Syntax
response = client.describe_job_execution(
jobId='string',
thingName='string',
executionNumber=123
)
[REQUIRED]
The unique identifier you assigned to this job when it was created.
[REQUIRED]
The name of the thing on which the job execution is running.
dict
Response Syntax
{
'execution': {
'jobId': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'forceCanceled': True|False,
'statusDetails': {
'detailsMap': {
'string': 'string'
}
},
'thingArn': 'string',
'queuedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'executionNumber': 123,
'versionNumber': 123
}
}
Response Structure
(dict) --
execution (dict) --
Information about the job execution.
jobId (string) --
The unique identifier you assigned to the job when it was created.
status (string) --
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
forceCanceled (boolean) --
Will be true if the job execution was canceled with the optional force parameter set to true .
statusDetails (dict) --
A collection of name/value pairs that describe the status of the job execution.
detailsMap (dict) --
The job execution status.
thingArn (string) --
The ARN of the thing on which the job execution is running.
queuedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was queued.
startedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was last updated.
executionNumber (integer) --
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.
versionNumber (integer) --
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
Describes a role alias.
See also: AWS API Documentation
Request Syntax
response = client.describe_role_alias(
roleAlias='string'
)
[REQUIRED]
The role alias to describe.
{
'roleAliasDescription': {
'roleAlias': 'string',
'roleAliasArn': 'string',
'roleArn': 'string',
'owner': 'string',
'credentialDurationSeconds': 123,
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
}
Response Structure
The role alias description.
The role alias.
The ARN of the role alias.
The role ARN.
The role alias owner.
The number of seconds for which the credential is valid.
The UNIX timestamp of when the role alias was created.
The UNIX timestamp of when the role alias was last modified.
Gets information about a scheduled audit.
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_audit(
scheduledAuditName='string'
)
[REQUIRED]
The name of the scheduled audit whose information you want to get.
{
'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
'dayOfMonth': 'string',
'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
'targetCheckNames': [
'string',
],
'scheduledAuditName': 'string',
'scheduledAuditArn': 'string'
}
Response Structure
How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
The day of the month on which the scheduled audit takes place. 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.
The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT".
Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
The name of the scheduled audit.
The ARN of the scheduled audit.
Gets information about a Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.describe_security_profile(
securityProfileName='string'
)
[REQUIRED]
The name of the security profile whose information you want to get.
{
'securityProfileName': 'string',
'securityProfileArn': 'string',
'securityProfileDescription': 'string',
'behaviors': [
{
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
],
'alertTargets': {
'string': {
'alertTargetArn': 'string',
'roleArn': 'string'
}
},
'version': 123,
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
The name of the security profile.
The ARN of the security profile.
A description of the security profile (associated with the security profile when it was created or updated).
Specifies the behaviors that, when violated by a device (thing), cause an alert.
A Device Defender security profile behavior.
The name you have given to the behavior.
What is measured by the behavior.
The criteria that determine if a device is behaving normally in regard to the metric .
The operator that relates the thing measured (metric ) to the criteria (value ).
The value to be compared with the metric .
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
Where the alerts are sent. (Alerts are always sent to the console.)
The type of alert target: one of "SNS".
A structure containing the alert target ARN and the role ARN.
The ARN of the notification target to which alerts are sent.
The ARN of the role that grants permission to send alerts to the notification target.
The version of the security profile. A new version is generated whenever the security profile is updated.
The time the security profile was created.
The time the security profile was last modified.
Gets information about a stream.
See also: AWS API Documentation
Request Syntax
response = client.describe_stream(
streamId='string'
)
[REQUIRED]
The stream ID.
{
'streamInfo': {
'streamId': 'string',
'streamArn': 'string',
'streamVersion': 123,
'description': 'string',
'files': [
{
'fileId': 123,
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
],
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'roleArn': 'string'
}
}
Response Structure
Information about the stream.
The stream ID.
The stream ARN.
The stream version.
The description of the stream.
The files to stream.
Represents a file to stream.
The file ID.
The location of the file in S3.
The S3 bucket.
The S3 key.
The S3 bucket version.
The date when the stream was created.
The date when the stream was last updated.
An IAM role AWS IoT assumes to access your S3 files.
Gets information about the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.describe_thing(
thingName='string'
)
[REQUIRED]
The name of the thing.
{
'defaultClientId': 'string',
'thingName': 'string',
'thingId': 'string',
'thingArn': 'string',
'thingTypeName': 'string',
'attributes': {
'string': 'string'
},
'version': 123
}
Response Structure
The output from the DescribeThing operation.
The default client ID.
The name of the thing.
The ID of the thing to describe.
The ARN of the thing to describe.
The thing type name.
The thing attributes.
The current version of the thing record in the registry.
Note
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.
Describe a thing group.
See also: AWS API Documentation
Request Syntax
response = client.describe_thing_group(
thingGroupName='string'
)
[REQUIRED]
The name of the thing group.
{
'thingGroupName': 'string',
'thingGroupId': 'string',
'thingGroupArn': 'string',
'version': 123,
'thingGroupProperties': {
'thingGroupDescription': 'string',
'attributePayload': {
'attributes': {
'string': 'string'
},
'merge': True|False
}
},
'thingGroupMetadata': {
'parentGroupName': 'string',
'rootToParentThingGroups': [
{
'groupName': 'string',
'groupArn': 'string'
},
],
'creationDate': datetime(2015, 1, 1)
}
}
Response Structure
The name of the thing group.
The thing group ID.
The thing group ARN.
The version of the thing group.
The thing group properties.
The thing group description.
The thing group attributes in JSON format.
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
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.
Note
The merge attribute is only valid when calling UpdateThing .
Thing group metadata.
The parent thing group name.
The root parent thing group.
The name and ARN of a group.
The group name.
The group ARN.
The UNIX timestamp of when the thing group was created.
Describes a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
response = client.describe_thing_registration_task(
taskId='string'
)
[REQUIRED]
The task ID.
{
'taskId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'templateBody': 'string',
'inputFileBucket': 'string',
'inputFileKey': 'string',
'roleArn': 'string',
'status': 'InProgress'|'Completed'|'Failed'|'Cancelled'|'Cancelling',
'message': 'string',
'successCount': 123,
'failureCount': 123,
'percentageProgress': 123
}
Response Structure
The task ID.
The task creation date.
The date when the task was last modified.
The task's template.
The S3 bucket that contains the input file.
The input file key.
The role ARN that grants access to the input file bucket.
The status of the bulk thing provisioning task.
The message.
The number of things successfully provisioned.
The number of things that failed to be provisioned.
The progress of the bulk provisioning task expressed as a percentage.
Gets information about the specified thing type.
See also: AWS API Documentation
Request Syntax
response = client.describe_thing_type(
thingTypeName='string'
)
[REQUIRED]
The name of the thing type.
{
'thingTypeName': 'string',
'thingTypeId': 'string',
'thingTypeArn': 'string',
'thingTypeProperties': {
'thingTypeDescription': 'string',
'searchableAttributes': [
'string',
]
},
'thingTypeMetadata': {
'deprecated': True|False,
'deprecationDate': datetime(2015, 1, 1),
'creationDate': datetime(2015, 1, 1)
}
}
Response Structure
The output for the DescribeThingType operation.
The name of the thing type.
The thing type ID.
The thing type ARN.
The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
The description of the thing type.
A list of searchable thing attribute names.
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.
Whether the thing type is deprecated. If true , no new things could be associated with this type.
The date and time when the thing type was deprecated.
The date and time when the thing type was created.
Detaches a policy from the specified target.
See also: AWS API Documentation
Request Syntax
response = client.detach_policy(
policyName='string',
target='string'
)
[REQUIRED]
The policy to detach.
[REQUIRED]
The target from which the policy will be detached.
None
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.detach_principal_policy(
policyName='string',
principal='string'
)
[REQUIRED]
The name of the policy to detach.
[REQUIRED]
The principal.
If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
None
Disassociates a Device Defender security profile from a thing group or from this account.
See also: AWS API Documentation
Request Syntax
response = client.detach_security_profile(
securityProfileName='string',
securityProfileTargetArn='string'
)
[REQUIRED]
The security profile that is detached.
[REQUIRED]
The ARN of the thing group from which the security profile is detached.
dict
Response Syntax
{}
Response Structure
Detaches the specified principal from the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.detach_thing_principal(
thingName='string',
principal='string'
)
[REQUIRED]
The name of the thing.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --
The output from the DetachThingPrincipal operation.
Disables the rule.
See also: AWS API Documentation
Request Syntax
response = client.disable_topic_rule(
ruleName='string'
)
[REQUIRED]
The name of the rule to disable.
Enables the rule.
See also: AWS API Documentation
Request Syntax
response = client.enable_topic_rule(
ruleName='string'
)
[REQUIRED]
The name of the topic rule to enable.
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_effective_policies(
principal='string',
cognitoIdentityPoolId='string',
thingName='string'
)
dict
Response Syntax
{
'effectivePolicies': [
{
'policyName': 'string',
'policyArn': 'string',
'policyDocument': 'string'
},
]
}
Response Structure
(dict) --
effectivePolicies (list) --
The effective policies.
(dict) --
The policy that has the effect on the authorization results.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
policyDocument (string) --
The IAM policy document.
Gets the search configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_indexing_configuration()
{
'thingIndexingConfiguration': {
'thingIndexingMode': 'OFF'|'REGISTRY'|'REGISTRY_AND_SHADOW'
},
'thingGroupIndexingConfiguration': {
'thingGroupIndexingMode': 'OFF'|'ON'
}
}
Response Structure
Thing indexing configuration.
Thing indexing mode. Valid values are:
The index configuration.
Thing group indexing mode.
Gets a job document.
See also: AWS API Documentation
Request Syntax
response = client.get_job_document(
jobId='string'
)
[REQUIRED]
The unique identifier you assigned to this job when it was created.
{
'document': 'string'
}
Response Structure
The job document content.
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
See also: AWS API Documentation
Request Syntax
response = client.get_logging_options()
{
'roleArn': 'string',
'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
}
Response Structure
The output from the GetLoggingOptions operation.
The ARN of the IAM role that grants access.
The logging level.
Gets an OTA update.
See also: AWS API Documentation
Request Syntax
response = client.get_ota_update(
otaUpdateId='string'
)
[REQUIRED]
The OTA update ID.
{
'otaUpdateInfo': {
'otaUpdateId': 'string',
'otaUpdateArn': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'description': 'string',
'targets': [
'string',
],
'awsJobExecutionsRolloutConfig': {
'maximumPerMinute': 123
},
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'otaUpdateFiles': [
{
'fileName': 'string',
'fileVersion': 'string',
'fileLocation': {
'stream': {
'streamId': 'string',
'fileId': 123
},
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'codeSigning': {
'awsSignerJobId': 'string',
'startSigningJobParameter': {
'signingProfileParameter': {
'certificateArn': 'string',
'platform': 'string',
'certificatePathOnDevice': 'string'
},
'signingProfileName': 'string',
'destination': {
's3Destination': {
'bucket': 'string',
'prefix': 'string'
}
}
},
'customCodeSigning': {
'signature': {
'inlineDocument': b'bytes'
},
'certificateChain': {
'certificateName': 'string',
'inlineDocument': 'string'
},
'hashAlgorithm': 'string',
'signatureAlgorithm': 'string'
}
},
'attributes': {
'string': 'string'
}
},
],
'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED',
'awsIotJobId': 'string',
'awsIotJobArn': 'string',
'errorInfo': {
'code': 'string',
'message': 'string'
},
'additionalParameters': {
'string': 'string'
}
}
}
Response Structure
The OTA update info.
The OTA update ID.
The OTA update ARN.
The date when the OTA update was created.
The date when the OTA update was last updated.
A description of the OTA update.
The targets of the OTA update.
Configuration for the rollout of OTA updates.
The maximum number of OTA update job executions started per minute.
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.
A list of files associated with the OTA update.
Describes a file to be associated with an OTA update.
The name of the file.
The file version.
The location of the updated firmware.
The stream that contains the OTA update.
The stream ID.
The ID of a file associated with a stream.
The location of the updated firmware in S3.
The S3 bucket.
The S3 key.
The S3 bucket version.
The code signing method of the file.
The ID of the AWSSignerJob which was created to sign the file.
Describes the code-signing job.
Describes the code-signing profile.
Certificate ARN.
The hardware platform of your device.
The location of the code-signing certificate on your device.
The code-signing profile name.
The location to write the code-signed file.
Describes the location in S3 of the updated firmware.
The S3 bucket that contains the updated firmware.
The S3 prefix.
A custom method for code signing a file.
The signature for the file.
A base64 encoded binary representation of the code signing signature.
The certificate chain.
The name of the certificate.
A base64 encoded binary representation of the code signing certificate chain.
The hash algorithm used to code sign the file.
The signature algorithm used to code sign the file.
A list of name/attribute pairs.
The status of the OTA update.
The AWS IoT job ID associated with the OTA update.
The AWS IoT job ARN associated with the OTA update.
Error information associated with the OTA update.
The error code.
The error message.
A collection of name/value pairs
Create a paginator for an operation.
Gets information about the specified policy with the policy document of the default version.
See also: AWS API Documentation
Request Syntax
response = client.get_policy(
policyName='string'
)
[REQUIRED]
The name of the policy.
{
'policyName': 'string',
'policyArn': 'string',
'policyDocument': 'string',
'defaultVersionId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'generationId': 'string'
}
Response Structure
The output from the GetPolicy operation.
The policy name.
The policy ARN.
The JSON document that describes the policy.
The default policy version ID.
The date the policy was created.
The date the policy was last modified.
The generation ID of the policy.
Gets information about the specified policy version.
See also: AWS API Documentation
Request Syntax
response = client.get_policy_version(
policyName='string',
policyVersionId='string'
)
[REQUIRED]
The name of the policy.
[REQUIRED]
The policy version ID.
dict
Response Syntax
{
'policyArn': 'string',
'policyName': 'string',
'policyDocument': 'string',
'policyVersionId': 'string',
'isDefaultVersion': True|False,
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'generationId': 'string'
}
Response Structure
(dict) --
The output from the GetPolicyVersion operation.
policyArn (string) --
The policy ARN.
policyName (string) --
The policy name.
policyDocument (string) --
The JSON document that describes the policy.
policyVersionId (string) --
The policy version ID.
isDefaultVersion (boolean) --
Specifies whether the policy version is the default.
creationDate (datetime) --
The date the policy version was created.
lastModifiedDate (datetime) --
The date the policy version was last modified.
generationId (string) --
The generation ID of the policy version.
Gets a registration code used to register a CA certificate with AWS IoT.
See also: AWS API Documentation
Request Syntax
response = client.get_registration_code()
{
'registrationCode': 'string'
}
Response Structure
The output from the GetRegistrationCode operation.
The CA certificate registration code.
Gets information about the rule.
See also: AWS API Documentation
Request Syntax
response = client.get_topic_rule(
ruleName='string'
)
[REQUIRED]
The name of the rule.
{
'ruleArn': 'string',
'rule': {
'ruleName': 'string',
'sql': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'actions': [
{
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
},
],
'ruleDisabled': True|False,
'awsIotSqlVersion': 'string',
'errorAction': {
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
}
}
}
Response Structure
The output from the GetTopicRule operation.
The rule ARN.
The rule.
The name of the rule.
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
The description of the rule.
The date and time the rule was created.
The actions associated with the rule.
Describes the actions associated with a rule.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
Specifies whether the rule is disabled.
The version of the SQL rules engine to use when evaluating the rule.
The action to perform when an error occurs.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
Gets the fine grained logging options.
See also: AWS API Documentation
Request Syntax
response = client.get_v2_logging_options()
{
'roleArn': 'string',
'defaultLogLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED',
'disableAllLogs': True|False
}
Response Structure
The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
The default log level.
Disables all logs.
Returns an object that can wait for some condition.
Lists the active violations for a given Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.list_active_violations(
thingName='string',
securityProfileName='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'activeViolations': [
{
'violationId': 'string',
'thingName': 'string',
'securityProfileName': 'string',
'behavior': {
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
'lastViolationValue': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'lastViolationTime': datetime(2015, 1, 1),
'violationStartTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
activeViolations (list) --
The list of active violations.
(dict) --
Information about an active Device Defender security profile behavior violation.
violationId (string) --
The ID of the active violation.
thingName (string) --
The name of the thing responsible for the active violation.
securityProfileName (string) --
The security profile whose behavior is in violation.
behavior (dict) --
The behavior which is being violated.
name (string) --
The name you have given to the behavior.
metric (string) --
What is measured by the behavior.
criteria (dict) --
The criteria that determine if a device is behaving normally in regard to the metric .
comparisonOperator (string) --
The operator that relates the thing measured (metric ) to the criteria (value ).
value (dict) --
The value to be compared with the metric .
count (integer) --
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
cidrs (list) --
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
ports (list) --
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
durationSeconds (integer) --
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
lastViolationValue (dict) --
The value of the metric (the measurement) which caused the most recent violation.
count (integer) --
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
cidrs (list) --
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
ports (list) --
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
lastViolationTime (datetime) --
The time the most recent violation occurred.
violationStartTime (datetime) --
The time the violation started.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the policies attached to the specified thing group.
See also: AWS API Documentation
Request Syntax
response = client.list_attached_policies(
target='string',
recursive=True|False,
marker='string',
pageSize=123
)
[REQUIRED]
The group for which the policies will be listed.
dict
Response Syntax
{
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
policies (list) --
The policies.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
nextMarker (string) --
The token to retrieve the next set of results, or null if there are no more results.
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
See also: AWS API Documentation
Request Syntax
response = client.list_audit_findings(
taskId='string',
checkName='string',
resourceIdentifier={
'deviceCertificateId': 'string',
'caCertificateId': 'string',
'cognitoIdentityPoolId': 'string',
'clientId': 'string',
'policyVersionIdentifier': {
'policyName': 'string',
'policyVersionId': 'string'
},
'account': 'string'
},
maxResults=123,
nextToken='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
Information identifying the non-compliant resource.
The ID of the certificate attached to the resource.
The ID of the CA certificate used to authorize the certificate.
The ID of the Cognito Identity Pool.
The client ID.
The version of the policy associated with the resource.
The name of the policy.
The ID of the version of the policy associated with the resource.
The account with which the resource is associated.
dict
Response Syntax
{
'findings': [
{
'taskId': 'string',
'checkName': 'string',
'taskStartTime': datetime(2015, 1, 1),
'findingTime': datetime(2015, 1, 1),
'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW',
'nonCompliantResource': {
'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS',
'resourceIdentifier': {
'deviceCertificateId': 'string',
'caCertificateId': 'string',
'cognitoIdentityPoolId': 'string',
'clientId': 'string',
'policyVersionIdentifier': {
'policyName': 'string',
'policyVersionId': 'string'
},
'account': 'string'
},
'additionalInfo': {
'string': 'string'
}
},
'relatedResources': [
{
'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS',
'resourceIdentifier': {
'deviceCertificateId': 'string',
'caCertificateId': 'string',
'cognitoIdentityPoolId': 'string',
'clientId': 'string',
'policyVersionIdentifier': {
'policyName': 'string',
'policyVersionId': 'string'
},
'account': 'string'
},
'additionalInfo': {
'string': 'string'
}
},
],
'reasonForNonCompliance': 'string',
'reasonForNonComplianceCode': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
findings (list) --
The findings (results) of the audit.
(dict) --
The findings (results) of the audit.
taskId (string) --
The ID of the audit that generated this result (finding)
checkName (string) --
The audit check that generated this result.
taskStartTime (datetime) --
The time the audit started.
findingTime (datetime) --
The time the result (finding) was discovered.
severity (string) --
The severity of the result (finding).
nonCompliantResource (dict) --
The resource that was found to be non-compliant with the audit check.
resourceType (string) --
The type of the non-compliant resource.
resourceIdentifier (dict) --
Information identifying the non-compliant resource.
deviceCertificateId (string) --
The ID of the certificate attached to the resource.
caCertificateId (string) --
The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId (string) --
The ID of the Cognito Identity Pool.
clientId (string) --
The client ID.
policyVersionIdentifier (dict) --
The version of the policy associated with the resource.
policyName (string) --
The name of the policy.
policyVersionId (string) --
The ID of the version of the policy associated with the resource.
account (string) --
The account with which the resource is associated.
additionalInfo (dict) --
Additional information about the non-compliant resource.
relatedResources (list) --
The list of related resources.
(dict) --
Information about a related resource.
resourceType (string) --
The type of resource.
resourceIdentifier (dict) --
Information identifying the resource.
deviceCertificateId (string) --
The ID of the certificate attached to the resource.
caCertificateId (string) --
The ID of the CA certificate used to authorize the certificate.
cognitoIdentityPoolId (string) --
The ID of the Cognito Identity Pool.
clientId (string) --
The client ID.
policyVersionIdentifier (dict) --
The version of the policy associated with the resource.
policyName (string) --
The name of the policy.
policyVersionId (string) --
The ID of the version of the policy associated with the resource.
account (string) --
The account with which the resource is associated.
additionalInfo (dict) --
Additional information about the resource.
reasonForNonCompliance (string) --
The reason the resource was non-compliant.
reasonForNonComplianceCode (string) --
A code which indicates the reason that the resource was non-compliant.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the Device Defender audits that have been performed during a given time period.
See also: AWS API Documentation
Request Syntax
response = client.list_audit_tasks(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
taskType='ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
nextToken='string',
maxResults=123
)
[REQUIRED]
The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
[REQUIRED]
The end of the time period.
dict
Response Syntax
{
'tasks': [
{
'taskId': 'string',
'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tasks (list) --
The audits that were performed during the specified time period.
(dict) --
The audits that were performed.
taskId (string) --
The ID of this audit.
taskStatus (string) --
The status of this audit: one of "IN_PROGRESS", "COMPLETED", "FAILED" or "CANCELED".
taskType (string) --
The type of this audit: one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the authorizers registered in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_authorizers(
pageSize=123,
marker='string',
ascendingOrder=True|False,
status='ACTIVE'|'INACTIVE'
)
dict
Response Syntax
{
'authorizers': [
{
'authorizerName': 'string',
'authorizerArn': 'string'
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
authorizers (list) --
The authorizers.
(dict) --
The authorizer summary.
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
nextMarker (string) --
A marker used to get the next set of results.
Lists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
See also: AWS API Documentation
Request Syntax
response = client.list_ca_certificates(
pageSize=123,
marker='string',
ascendingOrder=True|False
)
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE',
'creationDate': datetime(2015, 1, 1)
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output from the ListCACertificates operation.
certificates (list) --
The CA certificates registered in your AWS account.
(dict) --
A CA certificate.
certificateArn (string) --
The ARN of the CA certificate.
certificateId (string) --
The ID of the CA certificate.
status (string) --
The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date the CA certificate was created.
nextMarker (string) --
The current position within the list of CA certificates.
Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
See also: AWS API Documentation
Request Syntax
response = client.list_certificates(
pageSize=123,
marker='string',
ascendingOrder=True|False
)
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
'creationDate': datetime(2015, 1, 1)
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output of the ListCertificates operation.
certificates (list) --
The descriptions of the certificates.
(dict) --
Information about a certificate.
certificateArn (string) --
The ARN of the certificate.
certificateId (string) --
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
status (string) --
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date and time the certificate was created.
nextMarker (string) --
The marker for the next set of results, or null if there are no additional results.
List the device certificates signed by the specified CA certificate.
See also: AWS API Documentation
Request Syntax
response = client.list_certificates_by_ca(
caCertificateId='string',
pageSize=123,
marker='string',
ascendingOrder=True|False
)
[REQUIRED]
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
'creationDate': datetime(2015, 1, 1)
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output of the ListCertificatesByCA operation.
certificates (list) --
The device certificates signed by the specified CA certificate.
(dict) --
Information about a certificate.
certificateArn (string) --
The ARN of the certificate.
certificateId (string) --
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
status (string) --
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date and time the certificate was created.
nextMarker (string) --
The marker for the next set of results, or null if there are no additional results.
Lists the search indices.
See also: AWS API Documentation
Request Syntax
response = client.list_indices(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'indexNames': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
indexNames (list) --
The index names.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the job executions for a job.
See also: AWS API Documentation
Request Syntax
response = client.list_job_executions_for_job(
jobId='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The unique identifier you assigned to this job when it was created.
dict
Response Syntax
{
'executionSummaries': [
{
'thingArn': 'string',
'jobExecutionSummary': {
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'queuedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'executionNumber': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
executionSummaries (list) --
A list of job execution summaries.
(dict) --
Contains a summary of information about job executions for a specific job.
thingArn (string) --
The ARN of the thing on which the job execution is running.
jobExecutionSummary (dict) --
Contains a subset of information about a job execution.
status (string) --
The status of the job execution.
queuedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was queued.
startedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was last updated.
executionNumber (integer) --
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.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Lists the job executions for the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.list_job_executions_for_thing(
thingName='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The thing name.
dict
Response Syntax
{
'executionSummaries': [
{
'jobId': 'string',
'jobExecutionSummary': {
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'queuedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'executionNumber': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
executionSummaries (list) --
A list of job execution summaries.
(dict) --
The job execution summary for a thing.
jobId (string) --
The unique identifier you assigned to this job when it was created.
jobExecutionSummary (dict) --
Contains a subset of information about a job execution.
status (string) --
The status of the job execution.
queuedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was queued.
startedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the job execution was last updated.
executionNumber (integer) --
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.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Lists jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
status='IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
targetSelection='CONTINUOUS'|'SNAPSHOT',
maxResults=123,
nextToken='string',
thingGroupName='string',
thingGroupId='string'
)
dict
Response Syntax
{
'jobs': [
{
'jobArn': 'string',
'jobId': 'string',
'thingGroupId': 'string',
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
A list of jobs.
(dict) --
The job summary.
jobArn (string) --
The job ARN.
jobId (string) --
The unique identifier you assigned to this job when it was created.
thingGroupId (string) --
The ID of the thing group.
targetSelection (string) --
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.
status (string) --
The job summary status.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the job was created.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the job was last updated.
completedAt (datetime) --
The time, in milliseconds since the epoch, when the job completed.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Lists OTA updates.
See also: AWS API Documentation
Request Syntax
response = client.list_ota_updates(
maxResults=123,
nextToken='string',
otaUpdateStatus='CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
)
dict
Response Syntax
{
'otaUpdates': [
{
'otaUpdateId': 'string',
'otaUpdateArn': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
otaUpdates (list) --
A list of OTA update jobs.
(dict) --
An OTA update summary.
otaUpdateId (string) --
The OTA update ID.
otaUpdateArn (string) --
The OTA update ARN.
creationDate (datetime) --
The date when the OTA update was created.
nextToken (string) --
A token to use to get the next set of results.
Lists certificates that are being transferred but not yet accepted.
See also: AWS API Documentation
Request Syntax
response = client.list_outgoing_certificates(
pageSize=123,
marker='string',
ascendingOrder=True|False
)
dict
Response Syntax
{
'outgoingCertificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'transferredTo': 'string',
'transferDate': datetime(2015, 1, 1),
'transferMessage': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output from the ListOutgoingCertificates operation.
outgoingCertificates (list) --
The certificates that are being transferred but not yet accepted.
(dict) --
A certificate that has been transferred but not yet accepted.
certificateArn (string) --
The certificate ARN.
certificateId (string) --
The certificate ID.
transferredTo (string) --
The AWS account to which the transfer was made.
transferDate (datetime) --
The date the transfer was initiated.
transferMessage (string) --
The transfer message.
creationDate (datetime) --
The certificate creation date.
nextMarker (string) --
The marker for the next set of results.
Lists your policies.
See also: AWS API Documentation
Request Syntax
response = client.list_policies(
marker='string',
pageSize=123,
ascendingOrder=True|False
)
dict
Response Syntax
{
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output from the ListPolicies operation.
policies (list) --
The descriptions of the policies.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
nextMarker (string) --
The marker for the next set of results, or null if there are no additional results.
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.list_policy_principals(
policyName='string',
marker='string',
pageSize=123,
ascendingOrder=True|False
)
[REQUIRED]
The policy name.
dict
Response Syntax
{
'principals': [
'string',
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output from the ListPolicyPrincipals operation.
principals (list) --
The descriptions of the principals.
nextMarker (string) --
The marker for the next set of results, or null if there are no additional results.
Lists the versions of the specified policy and identifies the default version.
See also: AWS API Documentation
Request Syntax
response = client.list_policy_versions(
policyName='string'
)
[REQUIRED]
The policy name.
{
'policyVersions': [
{
'versionId': 'string',
'isDefaultVersion': True|False,
'createDate': datetime(2015, 1, 1)
},
]
}
Response Structure
The output from the ListPolicyVersions operation.
The policy versions.
Describes a policy version.
The policy version ID.
Specifies whether the policy version is the default.
The date and time the policy was created.
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format .
Note: This API is deprecated. Please use ListAttachedPolicies instead.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.list_principal_policies(
principal='string',
marker='string',
pageSize=123,
ascendingOrder=True|False
)
[REQUIRED]
The principal.
dict
Response Syntax
{
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
],
'nextMarker': 'string'
}
Response Structure
(dict) --
The output from the ListPrincipalPolicies operation.
policies (list) --
The policies.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
nextMarker (string) --
The marker for the next set of results, or null if there are no additional results.
Lists the things associated with the specified principal.
See also: AWS API Documentation
Request Syntax
response = client.list_principal_things(
nextToken='string',
maxResults=123,
principal='string'
)
[REQUIRED]
The principal.
dict
Response Syntax
{
'things': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
The output from the ListPrincipalThings operation.
things (list) --
The things.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the role aliases registered in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_role_aliases(
pageSize=123,
marker='string',
ascendingOrder=True|False
)
dict
Response Syntax
{
'roleAliases': [
'string',
],
'nextMarker': 'string'
}
Response Structure
(dict) --
roleAliases (list) --
The role aliases.
nextMarker (string) --
A marker used to get the next set of results.
Lists all of your scheduled audits.
See also: AWS API Documentation
Request Syntax
response = client.list_scheduled_audits(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'scheduledAudits': [
{
'scheduledAuditName': 'string',
'scheduledAuditArn': 'string',
'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
'dayOfMonth': 'string',
'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
scheduledAudits (list) --
The list of scheduled audits.
(dict) --
Information about the scheduled audit.
scheduledAuditName (string) --
The name of the scheduled audit.
scheduledAuditArn (string) --
The ARN of the scheduled audit.
frequency (string) --
How often the scheduled audit takes place.
dayOfMonth (string) --
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.
dayOfWeek (string) --
The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.list_security_profiles(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'securityProfileIdentifiers': [
{
'name': 'string',
'arn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
securityProfileIdentifiers (list) --
A list of security profile identifiers (names and ARNs).
(dict) --
Identifying information for a Device Defender security profile.
name (string) --
The name you have given to the security profile.
arn (string) --
The ARN of the security profile.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the Device Defender security profiles attached to a target (thing group).
See also: AWS API Documentation
Request Syntax
response = client.list_security_profiles_for_target(
nextToken='string',
maxResults=123,
recursive=True|False,
securityProfileTargetArn='string'
)
[REQUIRED]
The ARN of the target (thing group) whose attached security profiles you want to get.
dict
Response Syntax
{
'securityProfileTargetMappings': [
{
'securityProfileIdentifier': {
'name': 'string',
'arn': 'string'
},
'target': {
'arn': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
securityProfileTargetMappings (list) --
A list of security profiles and their associated targets.
(dict) --
Information about a security profile and the target associated with it.
securityProfileIdentifier (dict) --
Information that identifies the security profile.
name (string) --
The name you have given to the security profile.
arn (string) --
The ARN of the security profile.
target (dict) --
Information about the target (thing group) associated with the security profile.
arn (string) --
The ARN of the security profile.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists all of the streams in your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_streams(
maxResults=123,
nextToken='string',
ascendingOrder=True|False
)
dict
Response Syntax
{
'streams': [
{
'streamId': 'string',
'streamArn': 'string',
'streamVersion': 123,
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
streams (list) --
A list of streams.
(dict) --
A summary of a stream.
streamId (string) --
The stream ID.
streamArn (string) --
The stream ARN.
streamVersion (integer) --
The stream version.
description (string) --
A description of the stream.
nextToken (string) --
A token used to get the next set of results.
List targets for the specified policy.
See also: AWS API Documentation
Request Syntax
response = client.list_targets_for_policy(
policyName='string',
marker='string',
pageSize=123
)
[REQUIRED]
The policy name.
dict
Response Syntax
{
'targets': [
'string',
],
'nextMarker': 'string'
}
Response Structure
(dict) --
targets (list) --
The policy targets.
nextMarker (string) --
A marker used to get the next set of results.
Lists the targets (thing groups) associated with a given Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.list_targets_for_security_profile(
securityProfileName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The security profile.
dict
Response Syntax
{
'securityProfileTargets': [
{
'arn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
securityProfileTargets (list) --
The thing groups to which the security profile is attached.
(dict) --
A target to which an alert is sent when a security profile behavior is violated.
arn (string) --
The ARN of the security profile.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
List the thing groups in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_groups(
nextToken='string',
maxResults=123,
parentGroup='string',
namePrefixFilter='string',
recursive=True|False
)
dict
Response Syntax
{
'thingGroups': [
{
'groupName': 'string',
'groupArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
thingGroups (list) --
The thing groups.
(dict) --
The name and ARN of a group.
groupName (string) --
The group name.
groupArn (string) --
The group ARN.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
List the thing groups to which the specified thing belongs.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_groups_for_thing(
thingName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The thing name.
dict
Response Syntax
{
'thingGroups': [
{
'groupName': 'string',
'groupArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
thingGroups (list) --
The thing groups.
(dict) --
The name and ARN of a group.
groupName (string) --
The group name.
groupArn (string) --
The group ARN.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the principals associated with the specified thing.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_principals(
thingName='string'
)
[REQUIRED]
The name of the thing.
{
'principals': [
'string',
]
}
Response Structure
The output from the ListThingPrincipals operation.
The principals associated with the thing.
Information about the thing registration tasks.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_registration_task_reports(
taskId='string',
reportType='ERRORS'|'RESULTS',
nextToken='string',
maxResults=123
)
[REQUIRED]
The id of the task.
[REQUIRED]
The type of task report.
dict
Response Syntax
{
'resourceLinks': [
'string',
],
'reportType': 'ERRORS'|'RESULTS',
'nextToken': 'string'
}
Response Structure
(dict) --
resourceLinks (list) --
Links to the task resources.
reportType (string) --
The type of task report.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
List bulk thing provisioning tasks.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_registration_tasks(
nextToken='string',
maxResults=123,
status='InProgress'|'Completed'|'Failed'|'Cancelled'|'Cancelling'
)
dict
Response Syntax
{
'taskIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskIds (list) --
A list of bulk thing provisioning task IDs.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the existing thing types.
See also: AWS API Documentation
Request Syntax
response = client.list_thing_types(
nextToken='string',
maxResults=123,
thingTypeName='string'
)
dict
Response Syntax
{
'thingTypes': [
{
'thingTypeName': 'string',
'thingTypeArn': 'string',
'thingTypeProperties': {
'thingTypeDescription': 'string',
'searchableAttributes': [
'string',
]
},
'thingTypeMetadata': {
'deprecated': True|False,
'deprecationDate': datetime(2015, 1, 1),
'creationDate': datetime(2015, 1, 1)
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The output for the ListThingTypes operation.
thingTypes (list) --
The thing types.
(dict) --
The definition of the thing type, including thing type name and description.
thingTypeName (string) --
The name of the thing type.
thingTypeArn (string) --
The thing type ARN.
thingTypeProperties (dict) --
The ThingTypeProperties for the thing type.
thingTypeDescription (string) --
The description of the thing type.
searchableAttributes (list) --
A list of searchable thing attribute names.
thingTypeMetadata (dict) --
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.
deprecated (boolean) --
Whether the thing type is deprecated. If true , no new things could be associated with this type.
deprecationDate (datetime) --
The date and time when the thing type was deprecated.
creationDate (datetime) --
The date and time when the thing type was created.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
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 .
See also: AWS API Documentation
Request Syntax
response = client.list_things(
nextToken='string',
maxResults=123,
attributeName='string',
attributeValue='string',
thingTypeName='string'
)
dict
Response Syntax
{
'things': [
{
'thingName': 'string',
'thingTypeName': 'string',
'thingArn': 'string',
'attributes': {
'string': 'string'
},
'version': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The output from the ListThings operation.
things (list) --
The things.
(dict) --
The properties of the thing, including thing name, thing type name, and a list of thing attributes.
thingName (string) --
The name of the thing.
thingTypeName (string) --
The name of the thing type, if the thing has been associated with a type.
thingArn (string) --
The thing ARN.
attributes (dict) --
A list of thing attributes which are name-value pairs.
version (integer) --
The version of the thing record in the registry.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the things in the specified group.
See also: AWS API Documentation
Request Syntax
response = client.list_things_in_thing_group(
thingGroupName='string',
recursive=True|False,
nextToken='string',
maxResults=123
)
[REQUIRED]
The thing group name.
dict
Response Syntax
{
'things': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
things (list) --
The things in the specified thing group.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Lists the rules for the specific topic.
See also: AWS API Documentation
Request Syntax
response = client.list_topic_rules(
topic='string',
maxResults=123,
nextToken='string',
ruleDisabled=True|False
)
dict
Response Syntax
{
'rules': [
{
'ruleArn': 'string',
'ruleName': 'string',
'topicPattern': 'string',
'createdAt': datetime(2015, 1, 1),
'ruleDisabled': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The output from the ListTopicRules operation.
rules (list) --
The rules.
(dict) --
Describes a rule.
ruleArn (string) --
The rule ARN.
ruleName (string) --
The name of the rule.
topicPattern (string) --
The pattern for the topic names that apply.
createdAt (datetime) --
The date and time the rule was created.
ruleDisabled (boolean) --
Specifies whether the rule is disabled.
nextToken (string) --
A token used to retrieve the next value.
Lists logging levels.
See also: AWS API Documentation
Request Syntax
response = client.list_v2_logging_levels(
targetType='DEFAULT'|'THING_GROUP',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'logTargetConfigurations': [
{
'logTarget': {
'targetType': 'DEFAULT'|'THING_GROUP',
'targetName': 'string'
},
'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
logTargetConfigurations (list) --
The logging configuration for a target.
(dict) --
The target configuration.
logTarget (dict) --
A log target
targetType (string) --
The target type.
targetName (string) --
The target name.
logLevel (string) --
The logging level.
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
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).
See also: AWS API Documentation
Request Syntax
response = client.list_violation_events(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
thingName='string',
securityProfileName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The start time for the alerts to be listed.
[REQUIRED]
The end time for the alerts to be listed.
dict
Response Syntax
{
'violationEvents': [
{
'violationId': 'string',
'thingName': 'string',
'securityProfileName': 'string',
'behavior': {
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
'metricValue': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'violationEventType': 'in-alarm'|'alarm-cleared'|'alarm-invalidated',
'violationEventTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
violationEvents (list) --
The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.
(dict) --
Information about a Device Defender security profile behavior violation.
violationId (string) --
The ID of the violation event.
thingName (string) --
The name of the thing responsible for the violation event.
securityProfileName (string) --
The name of the security profile whose behavior was violated.
behavior (dict) --
The behavior which was violated.
name (string) --
The name you have given to the behavior.
metric (string) --
What is measured by the behavior.
criteria (dict) --
The criteria that determine if a device is behaving normally in regard to the metric .
comparisonOperator (string) --
The operator that relates the thing measured (metric ) to the criteria (value ).
value (dict) --
The value to be compared with the metric .
count (integer) --
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
cidrs (list) --
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
ports (list) --
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
durationSeconds (integer) --
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
metricValue (dict) --
The value of the metric (the measurement).
count (integer) --
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
cidrs (list) --
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
ports (list) --
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
violationEventType (string) --
The type of violation event.
violationEventTime (datetime) --
The time the violation event occurred.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
See also: AWS API Documentation
Request Syntax
response = client.register_ca_certificate(
caCertificate='string',
verificationCertificate='string',
setAsActive=True|False,
allowAutoRegistration=True|False,
registrationConfig={
'templateBody': 'string',
'roleArn': 'string'
}
)
[REQUIRED]
The CA certificate.
[REQUIRED]
The private key verification certificate.
Information about the registration configuration.
The template body.
The ARN of the role.
dict
Response Syntax
{
'certificateArn': 'string',
'certificateId': 'string'
}
Response Structure
(dict) --
The output from the RegisterCACertificateResponse operation.
certificateArn (string) --
The CA certificate ARN.
certificateId (string) --
The CA certificate identifier.
Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
See also: AWS API Documentation
Request Syntax
response = client.register_certificate(
certificatePem='string',
caCertificatePem='string',
setAsActive=True|False,
status='ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION'
)
[REQUIRED]
The certificate data, in PEM format.
dict
Response Syntax
{
'certificateArn': 'string',
'certificateId': 'string'
}
Response Structure
(dict) --
The output from the RegisterCertificate operation.
certificateArn (string) --
The certificate ARN.
certificateId (string) --
The certificate identifier.
Provisions a thing.
See also: AWS API Documentation
Request Syntax
response = client.register_thing(
templateBody='string',
parameters={
'string': 'string'
}
)
[REQUIRED]
The provisioning template. See Programmatic Provisioning for more information.
The parameters for provisioning a thing. See Programmatic Provisioning for more information.
dict
Response Syntax
{
'certificatePem': 'string',
'resourceArns': {
'string': 'string'
}
}
Response Structure
(dict) --
certificatePem (string) --
.
resourceArns (dict) --
ARNs for the generated resources.
Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE .
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
See also: AWS API Documentation
Request Syntax
response = client.reject_certificate_transfer(
certificateId='string',
rejectReason='string'
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
None
Remove the specified thing from the specified group.
See also: AWS API Documentation
Request Syntax
response = client.remove_thing_from_thing_group(
thingGroupName='string',
thingGroupArn='string',
thingName='string',
thingArn='string'
)
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.replace_topic_rule(
ruleName='string',
topicRulePayload={
'sql': 'string',
'description': 'string',
'actions': [
{
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
},
],
'ruleDisabled': True|False,
'awsIotSqlVersion': 'string',
'errorAction': {
'dynamoDB': {
'tableName': 'string',
'roleArn': 'string',
'operation': 'string',
'hashKeyField': 'string',
'hashKeyValue': 'string',
'hashKeyType': 'STRING'|'NUMBER',
'rangeKeyField': 'string',
'rangeKeyValue': 'string',
'rangeKeyType': 'STRING'|'NUMBER',
'payloadField': 'string'
},
'dynamoDBv2': {
'roleArn': 'string',
'putItem': {
'tableName': 'string'
}
},
'lambda': {
'functionArn': 'string'
},
'sns': {
'targetArn': 'string',
'roleArn': 'string',
'messageFormat': 'RAW'|'JSON'
},
'sqs': {
'roleArn': 'string',
'queueUrl': 'string',
'useBase64': True|False
},
'kinesis': {
'roleArn': 'string',
'streamName': 'string',
'partitionKey': 'string'
},
'republish': {
'roleArn': 'string',
'topic': 'string'
},
's3': {
'roleArn': 'string',
'bucketName': 'string',
'key': 'string',
'cannedAcl': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'log-delivery-write'
},
'firehose': {
'roleArn': 'string',
'deliveryStreamName': 'string',
'separator': 'string'
},
'cloudwatchMetric': {
'roleArn': 'string',
'metricNamespace': 'string',
'metricName': 'string',
'metricValue': 'string',
'metricUnit': 'string',
'metricTimestamp': 'string'
},
'cloudwatchAlarm': {
'roleArn': 'string',
'alarmName': 'string',
'stateReason': 'string',
'stateValue': 'string'
},
'elasticsearch': {
'roleArn': 'string',
'endpoint': 'string',
'index': 'string',
'type': 'string',
'id': 'string'
},
'salesforce': {
'token': 'string',
'url': 'string'
},
'iotAnalytics': {
'channelArn': 'string',
'channelName': 'string',
'roleArn': 'string'
},
'stepFunctions': {
'executionNamePrefix': 'string',
'stateMachineName': 'string',
'roleArn': 'string'
}
}
}
)
[REQUIRED]
The name of the rule.
[REQUIRED]
The rule payload.
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
The description of the rule.
The actions associated with the rule.
Describes the actions associated with a rule.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
Specifies whether the rule is disabled.
The version of the SQL rules engine to use when evaluating the rule.
The action to take when an error occurs.
Write to a DynamoDB table.
The name of the DynamoDB table.
The ARN of the IAM role that grants access to the DynamoDB table.
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 .
The hash key name.
The hash key value.
The hash key type. Valid values are "STRING" or "NUMBER"
The range key name.
The range key value.
The range key type. Valid values are "STRING" or "NUMBER"
The action payload. This name can be customized.
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.
The ARN of the IAM role that grants access to the DynamoDB table.
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.
The table where the message data will be written
Invoke a Lambda function.
The ARN of the Lambda function.
Publish to an Amazon SNS topic.
The ARN of the SNS topic.
The ARN of the IAM role that grants access.
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Publish to an Amazon SQS queue.
The ARN of the IAM role that grants access.
The URL of the Amazon SQS queue.
Specifies whether to use Base64 encoding.
Write data to an Amazon Kinesis stream.
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
The name of the Amazon Kinesis stream.
The partition key.
Publish to another MQTT topic.
The ARN of the IAM role that grants access.
The name of the MQTT topic.
Write to an Amazon S3 bucket.
The ARN of the IAM role that grants access.
The Amazon S3 bucket.
The object key.
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
Write to an Amazon Kinesis Firehose stream.
The IAM role that grants access to the Amazon Kinesis Firehose stream.
The delivery stream name.
A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' (newline), 't' (tab), 'rn' (Windows newline), ',' (comma).
Capture a CloudWatch metric.
The IAM role that allows access to the CloudWatch metric.
The CloudWatch metric namespace name.
The CloudWatch metric name.
The CloudWatch metric value.
The metric unit supported by CloudWatch.
An optional Unix timestamp .
Change the state of a CloudWatch alarm.
The IAM role that allows access to the CloudWatch alarm.
The CloudWatch alarm name.
The reason for the alarm change.
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Write data to an Amazon Elasticsearch Service domain.
The IAM role ARN that has access to Elasticsearch.
The endpoint of your Elasticsearch domain.
The Elasticsearch index where you want to store your data.
The type of document you are storing.
The unique identifier for the document you are storing.
Send a message to a Salesforce IoT Cloud Input Stream.
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.
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.
Sends message data to an AWS IoT Analytics channel.
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
The name of the IoT Analytics channel to which message data will be sent.
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Starts execution of a Step Functions state machine.
(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.
The name of the Step Functions state machine whose execution will be started.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
None
The query search index.
See also: AWS API Documentation
Request Syntax
response = client.search_index(
indexName='string',
queryString='string',
nextToken='string',
maxResults=123,
queryVersion='string'
)
[REQUIRED]
The search query string.
dict
Response Syntax
{
'nextToken': 'string',
'things': [
{
'thingName': 'string',
'thingId': 'string',
'thingTypeName': 'string',
'thingGroupNames': [
'string',
],
'attributes': {
'string': 'string'
},
'shadow': 'string'
},
],
'thingGroups': [
{
'thingGroupName': 'string',
'thingGroupId': 'string',
'thingGroupDescription': 'string',
'attributes': {
'string': 'string'
},
'parentGroupNames': [
'string',
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
things (list) --
The things that match the search query.
(dict) --
The thing search index document.
thingName (string) --
The thing name.
thingId (string) --
The thing ID.
thingTypeName (string) --
The thing type name.
thingGroupNames (list) --
Thing group names.
attributes (dict) --
The attributes.
shadow (string) --
The shadow.
thingGroups (list) --
The thing groups that match the search query.
(dict) --
The thing group search index document.
thingGroupName (string) --
The thing group name.
thingGroupId (string) --
The thing group ID.
thingGroupDescription (string) --
The thing group description.
attributes (dict) --
The thing group attributes.
parentGroupNames (list) --
Parent group names.
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
See also: AWS API Documentation
Request Syntax
response = client.set_default_authorizer(
authorizerName='string'
)
[REQUIRED]
The authorizer name.
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
The authorizer name.
The authorizer ARN.
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
See also: AWS API Documentation
Request Syntax
response = client.set_default_policy_version(
policyName='string',
policyVersionId='string'
)
[REQUIRED]
The policy name.
[REQUIRED]
The policy version ID.
None
Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
See also: AWS API Documentation
Request Syntax
response = client.set_logging_options(
loggingOptionsPayload={
'roleArn': 'string',
'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
}
)
[REQUIRED]
The logging options payload.
The ARN of the IAM role that grants access.
The log level.
Sets the logging level.
See also: AWS API Documentation
Request Syntax
response = client.set_v2_logging_level(
logTarget={
'targetType': 'DEFAULT'|'THING_GROUP',
'targetName': 'string'
},
logLevel='DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
)
[REQUIRED]
The log target.
The target type.
The target name.
[REQUIRED]
The log level.
None
Sets the logging options for the V2 logging service.
See also: AWS API Documentation
Request Syntax
response = client.set_v2_logging_options(
roleArn='string',
defaultLogLevel='DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED',
disableAllLogs=True|False
)
None
Starts an on-demand Device Defender audit.
See also: AWS API Documentation
Request Syntax
response = client.start_on_demand_audit_task(
targetCheckNames=[
'string',
]
)
[REQUIRED]
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.
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
{
'taskId': 'string'
}
Response Structure
The ID of the on-demand audit you started.
Creates a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
response = client.start_thing_registration_task(
templateBody='string',
inputFileBucket='string',
inputFileKey='string',
roleArn='string'
)
[REQUIRED]
The provisioning template.
[REQUIRED]
The S3 bucket that contains the input file.
[REQUIRED]
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).
[REQUIRED]
The IAM role ARN that grants permission the input file.
dict
Response Syntax
{
'taskId': 'string'
}
Response Structure
(dict) --
taskId (string) --
The bulk thing provisioning task ID.
Cancels a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
response = client.stop_thing_registration_task(
taskId='string'
)
[REQUIRED]
The bulk thing provisioning task ID.
{}
Response Structure
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
See also: AWS API Documentation
Request Syntax
response = client.test_authorization(
principal='string',
cognitoIdentityPoolId='string',
authInfos=[
{
'actionType': 'PUBLISH'|'SUBSCRIBE'|'RECEIVE'|'CONNECT',
'resources': [
'string',
]
},
],
clientId='string',
policyNamesToAdd=[
'string',
],
policyNamesToSkip=[
'string',
]
)
[REQUIRED]
A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
A collection of authorization information.
The type of action for which the principal is being authorized.
The resources for which the principal is being authorized to perform the specified action.
When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
dict
Response Syntax
{
'authResults': [
{
'authInfo': {
'actionType': 'PUBLISH'|'SUBSCRIBE'|'RECEIVE'|'CONNECT',
'resources': [
'string',
]
},
'allowed': {
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
]
},
'denied': {
'implicitDeny': {
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
]
},
'explicitDeny': {
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
]
}
},
'authDecision': 'ALLOWED'|'EXPLICIT_DENY'|'IMPLICIT_DENY',
'missingContextValues': [
'string',
]
},
]
}
Response Structure
(dict) --
authResults (list) --
The authentication results.
(dict) --
The authorizer result.
authInfo (dict) --
Authorization information.
actionType (string) --
The type of action for which the principal is being authorized.
resources (list) --
The resources for which the principal is being authorized to perform the specified action.
allowed (dict) --
The policies and statements that allowed the specified action.
policies (list) --
A list of policies that allowed the authentication.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
denied (dict) --
The policies and statements that denied the specified action.
implicitDeny (dict) --
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.
policies (list) --
Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
explicitDeny (dict) --
Information that explicitly denies the authorization.
policies (list) --
The policies that denied the authorization.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
authDecision (string) --
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.
missingContextValues (list) --
Contains any missing context values found while evaluating policy.
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
See also: AWS API Documentation
Request Syntax
response = client.test_invoke_authorizer(
authorizerName='string',
token='string',
tokenSignature='string'
)
[REQUIRED]
The custom authorizer name.
[REQUIRED]
The token returned by your custom authentication service.
[REQUIRED]
The signature made with the token and your custom authentication service's private key.
dict
Response Syntax
{
'isAuthenticated': True|False,
'principalId': 'string',
'policyDocuments': [
'string',
],
'refreshAfterInSeconds': 123,
'disconnectAfterInSeconds': 123
}
Response Structure
(dict) --
isAuthenticated (boolean) --
True if the token is authenticated, otherwise false.
principalId (string) --
The principal ID.
policyDocuments (list) --
IAM policy documents.
refreshAfterInSeconds (integer) --
The number of seconds after which the temporary credentials are refreshed.
disconnectAfterInSeconds (integer) --
The number of seconds after which the connection is terminated.
Transfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
See also: AWS API Documentation
Request Syntax
response = client.transfer_certificate(
certificateId='string',
targetAwsAccount='string',
transferMessage='string'
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
[REQUIRED]
The AWS account.
dict
Response Syntax
{
'transferredCertificateArn': 'string'
}
Response Structure
(dict) --
The output from the TransferCertificate operation.
transferredCertificateArn (string) --
The ARN of the certificate.
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.
See also: AWS API Documentation
Request Syntax
response = client.update_account_audit_configuration(
roleArn='string',
auditNotificationTargetConfigurations={
'string': {
'targetArn': 'string',
'roleArn': 'string',
'enabled': True|False
}
},
auditCheckConfigurations={
'string': {
'enabled': True|False
}
}
)
Information about the targets to which audit notifications are sent.
Information about the targets to which audit notifications are sent.
The ARN of the target (SNS topic) to which audit notifications are sent.
The ARN of the role that grants permission to send notifications to the target.
True if notifications to the target are enabled.
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.
Note that some data collection may begin 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 is 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.
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
Which audit checks are enabled and disabled for this account.
True if this audit check is enabled for this account.
dict
Response Syntax
{}
Response Structure
Updates an authorizer.
See also: AWS API Documentation
Request Syntax
response = client.update_authorizer(
authorizerName='string',
authorizerFunctionArn='string',
tokenKeyName='string',
tokenSigningPublicKeys={
'string': 'string'
},
status='ACTIVE'|'INACTIVE'
)
[REQUIRED]
The authorizer name.
The public keys used to verify the token signature.
dict
Response Syntax
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
(dict) --
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
Updates a registered CA certificate.
See also: AWS API Documentation
Request Syntax
response = client.update_ca_certificate(
certificateId='string',
newStatus='ACTIVE'|'INACTIVE',
newAutoRegistrationStatus='ENABLE'|'DISABLE',
registrationConfig={
'templateBody': 'string',
'roleArn': 'string'
},
removeAutoRegistration=True|False
)
[REQUIRED]
The CA certificate identifier.
The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
Information about the registration configuration.
The template body.
The ARN of the role.
None
Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
See also: AWS API Documentation
Request Syntax
response = client.update_certificate(
certificateId='string',
newStatus='ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION'
)
[REQUIRED]
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
[REQUIRED]
The new status.
Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
None
Updates the event configurations.
See also: AWS API Documentation
Request Syntax
response = client.update_event_configurations(
eventConfigurations={
'string': {
'Enabled': True|False
}
}
)
The new event configuration values.
Configuration.
True to enable the configuration.
{}
Response Structure
Updates the search configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_indexing_configuration(
thingIndexingConfiguration={
'thingIndexingMode': 'OFF'|'REGISTRY'|'REGISTRY_AND_SHADOW'
},
thingGroupIndexingConfiguration={
'thingGroupIndexingMode': 'OFF'|'ON'
}
)
Thing indexing configuration.
Thing indexing mode. Valid values are:
Thing group indexing configuration.
Thing group indexing mode.
dict
Response Syntax
{}
Response Structure
Updates a role alias.
See also: AWS API Documentation
Request Syntax
response = client.update_role_alias(
roleAlias='string',
roleArn='string',
credentialDurationSeconds=123
)
[REQUIRED]
The role alias to update.
dict
Response Syntax
{
'roleAlias': 'string',
'roleAliasArn': 'string'
}
Response Structure
(dict) --
roleAlias (string) --
The role alias.
roleAliasArn (string) --
The role alias ARN.
Updates a scheduled audit, including what checks are performed and how often the audit takes place.
See also: AWS API Documentation
Request Syntax
response = client.update_scheduled_audit(
frequency='DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
dayOfMonth='string',
dayOfWeek='SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
targetCheckNames=[
'string',
],
scheduledAuditName='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 UpdateAccountAuditConfiguration to select which checks are enabled.)
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 UpdateAccountAuditConfiguration to select which checks are enabled.)
[REQUIRED]
The name of the scheduled audit. (Max. 128 chars)
dict
Response Syntax
{
'scheduledAuditArn': 'string'
}
Response Structure
(dict) --
scheduledAuditArn (string) --
The ARN of the scheduled audit.
Updates a Device Defender security profile.
See also: AWS API Documentation
Request Syntax
response = client.update_security_profile(
securityProfileName='string',
securityProfileDescription='string',
behaviors=[
{
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
],
alertTargets={
'string': {
'alertTargetArn': 'string',
'roleArn': 'string'
}
},
expectedVersion=123
)
[REQUIRED]
The name of the security profile you want to update.
Specifies the behaviors that, when violated by a device (thing), cause an alert.
A Device Defender security profile behavior.
The name you have given to the behavior.
What is measured by the behavior.
The criteria that determine if a device is behaving normally in regard to the metric .
The operator that relates the thing measured (metric ) to the criteria (value ).
The value to be compared with the metric .
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
Where the alerts are sent. (Alerts are always sent to the console.)
The type of alert target: one of "SNS".
A structure containing the alert target ARN and the role ARN.
The ARN of the notification target to which alerts are sent.
The ARN of the role that grants permission to send alerts to the notification target.
dict
Response Syntax
{
'securityProfileName': 'string',
'securityProfileArn': 'string',
'securityProfileDescription': 'string',
'behaviors': [
{
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
],
'alertTargets': {
'string': {
'alertTargetArn': 'string',
'roleArn': 'string'
}
},
'version': 123,
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
securityProfileName (string) --
The name of the security profile that was updated.
securityProfileArn (string) --
The ARN of the security profile that was updated.
securityProfileDescription (string) --
The description of the security profile.
behaviors (list) --
Specifies the behaviors that, when violated by a device (thing), cause an alert.
(dict) --
A Device Defender security profile behavior.
name (string) --
The name you have given to the behavior.
metric (string) --
What is measured by the behavior.
criteria (dict) --
The criteria that determine if a device is behaving normally in regard to the metric .
comparisonOperator (string) --
The operator that relates the thing measured (metric ) to the criteria (value ).
value (dict) --
The value to be compared with the metric .
count (integer) --
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
cidrs (list) --
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
ports (list) --
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
durationSeconds (integer) --
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
alertTargets (dict) --
Where the alerts are sent. (Alerts are always sent to the console.)
(string) --
The type of alert target: one of "SNS".
(dict) --
A structure containing the alert target ARN and the role ARN.
alertTargetArn (string) --
The ARN of the notification target to which alerts are sent.
roleArn (string) --
The ARN of the role that grants permission to send alerts to the notification target.
version (integer) --
The updated version of the security profile.
creationDate (datetime) --
The time the security profile was created.
lastModifiedDate (datetime) --
The time the security profile was last modified.
Updates an existing stream. The stream version will be incremented by one.
See also: AWS API Documentation
Request Syntax
response = client.update_stream(
streamId='string',
description='string',
files=[
{
'fileId': 123,
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
],
roleArn='string'
)
[REQUIRED]
The stream ID.
The files associated with the stream.
Represents a file to stream.
The file ID.
The location of the file in S3.
The S3 bucket.
The S3 key.
The S3 bucket version.
dict
Response Syntax
{
'streamId': 'string',
'streamArn': 'string',
'description': 'string',
'streamVersion': 123
}
Response Structure
(dict) --
streamId (string) --
The stream ID.
streamArn (string) --
The stream ARN.
description (string) --
A description of the stream.
streamVersion (integer) --
The stream version.
Updates the data for a thing.
See also: AWS API Documentation
Request Syntax
response = client.update_thing(
thingName='string',
thingTypeName='string',
attributePayload={
'attributes': {
'string': 'string'
},
'merge': True|False
},
expectedVersion=123,
removeThingType=True|False
)
[REQUIRED]
The name of the thing to update.
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.
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
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.
Note
The merge attribute is only valid when calling UpdateThing .
dict
Response Syntax
{}
Response Structure
(dict) --
The output from the UpdateThing operation.
Update a thing group.
See also: AWS API Documentation
Request Syntax
response = client.update_thing_group(
thingGroupName='string',
thingGroupProperties={
'thingGroupDescription': 'string',
'attributePayload': {
'attributes': {
'string': 'string'
},
'merge': True|False
}
},
expectedVersion=123
)
[REQUIRED]
The thing group to update.
[REQUIRED]
The thing group properties.
The thing group description.
The thing group attributes in JSON format.
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
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.
Note
The merge attribute is only valid when calling UpdateThing .
dict
Response Syntax
{
'version': 123
}
Response Structure
(dict) --
version (integer) --
The version of the updated thing group.
Updates the groups to which the thing belongs.
See also: AWS API Documentation
Request Syntax
response = client.update_thing_groups_for_thing(
thingName='string',
thingGroupsToAdd=[
'string',
],
thingGroupsToRemove=[
'string',
]
)
The groups to which the thing will be added.
The groups from which the thing will be removed.
dict
Response Syntax
{}
Response Structure
Validates a Device Defender security profile behaviors specification.
See also: AWS API Documentation
Request Syntax
response = client.validate_security_profile_behaviors(
behaviors=[
{
'name': 'string',
'metric': 'string',
'criteria': {
'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
'value': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
]
},
'durationSeconds': 123
}
},
]
)
[REQUIRED]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
A Device Defender security profile behavior.
The name you have given to the behavior.
What is measured by the behavior.
The criteria that determine if a device is behaving normally in regard to the metric .
The operator that relates the thing measured (metric ) to the criteria (value ).
The value to be compared with the metric .
If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .
If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .
If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .
Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).
{
'valid': True|False,
'validationErrors': [
{
'errorMessage': 'string'
},
]
}
Response Structure
True if the behaviors were valid.
The list of any errors found in the behaviors.
Information about an error found in a behavior specification.
The description of an error found in the behaviors.
The available paginators are:
paginator = client.get_paginator('list_ca_certificates')
Creates an iterator that will paginate through responses from IoT.Client.list_ca_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListCACertificates operation.
certificates (list) --
The CA certificates registered in your AWS account.
(dict) --
A CA certificate.
certificateArn (string) --
The ARN of the CA certificate.
certificateId (string) --
The ID of the CA certificate.
status (string) --
The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date the CA certificate was created.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_certificates')
Creates an iterator that will paginate through responses from IoT.Client.list_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output of the ListCertificates operation.
certificates (list) --
The descriptions of the certificates.
(dict) --
Information about a certificate.
certificateArn (string) --
The ARN of the certificate.
certificateId (string) --
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
status (string) --
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date and time the certificate was created.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_certificates_by_ca')
Creates an iterator that will paginate through responses from IoT.Client.list_certificates_by_ca().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
caCertificateId='string',
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'certificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output of the ListCertificatesByCA operation.
certificates (list) --
The device certificates signed by the specified CA certificate.
(dict) --
Information about a certificate.
certificateArn (string) --
The ARN of the certificate.
certificateId (string) --
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
status (string) --
The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
creationDate (datetime) --
The date and time the certificate was created.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_outgoing_certificates')
Creates an iterator that will paginate through responses from IoT.Client.list_outgoing_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'outgoingCertificates': [
{
'certificateArn': 'string',
'certificateId': 'string',
'transferredTo': 'string',
'transferDate': datetime(2015, 1, 1),
'transferMessage': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListOutgoingCertificates operation.
outgoingCertificates (list) --
The certificates that are being transferred but not yet accepted.
(dict) --
A certificate that has been transferred but not yet accepted.
certificateArn (string) --
The certificate ARN.
certificateId (string) --
The certificate ID.
transferredTo (string) --
The AWS account to which the transfer was made.
transferDate (datetime) --
The date the transfer was initiated.
transferMessage (string) --
The transfer message.
creationDate (datetime) --
The certificate creation date.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_policies')
Creates an iterator that will paginate through responses from IoT.Client.list_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListPolicies operation.
policies (list) --
The descriptions of the policies.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_policy_principals')
Creates an iterator that will paginate through responses from IoT.Client.list_policy_principals().
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
policyName='string',
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The policy name.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'principals': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListPolicyPrincipals operation.
principals (list) --
The descriptions of the principals.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_principal_policies')
Creates an iterator that will paginate through responses from IoT.Client.list_principal_policies().
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
principal='string',
ascendingOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The principal.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'policies': [
{
'policyName': 'string',
'policyArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListPrincipalPolicies operation.
policies (list) --
The policies.
(dict) --
Describes an AWS IoT policy.
policyName (string) --
The policy name.
policyArn (string) --
The policy ARN.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_principal_things')
Creates an iterator that will paginate through responses from IoT.Client.list_principal_things().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
principal='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The principal.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'things': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListPrincipalThings operation.
things (list) --
The things.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_thing_types')
Creates an iterator that will paginate through responses from IoT.Client.list_thing_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
thingTypeName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'thingTypes': [
{
'thingTypeName': 'string',
'thingTypeArn': 'string',
'thingTypeProperties': {
'thingTypeDescription': 'string',
'searchableAttributes': [
'string',
]
},
'thingTypeMetadata': {
'deprecated': True|False,
'deprecationDate': datetime(2015, 1, 1),
'creationDate': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for the ListThingTypes operation.
thingTypes (list) --
The thing types.
(dict) --
The definition of the thing type, including thing type name and description.
thingTypeName (string) --
The name of the thing type.
thingTypeArn (string) --
The thing type ARN.
thingTypeProperties (dict) --
The ThingTypeProperties for the thing type.
thingTypeDescription (string) --
The description of the thing type.
searchableAttributes (list) --
A list of searchable thing attribute names.
thingTypeMetadata (dict) --
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.
deprecated (boolean) --
Whether the thing type is deprecated. If true , no new things could be associated with this type.
deprecationDate (datetime) --
The date and time when the thing type was deprecated.
creationDate (datetime) --
The date and time when the thing type was created.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_things')
Creates an iterator that will paginate through responses from IoT.Client.list_things().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
attributeName='string',
attributeValue='string',
thingTypeName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'things': [
{
'thingName': 'string',
'thingTypeName': 'string',
'thingArn': 'string',
'attributes': {
'string': 'string'
},
'version': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListThings operation.
things (list) --
The things.
(dict) --
The properties of the thing, including thing name, thing type name, and a list of thing attributes.
thingName (string) --
The name of the thing.
thingTypeName (string) --
The name of the thing type, if the thing has been associated with a type.
thingArn (string) --
The thing ARN.
attributes (dict) --
A list of thing attributes which are name-value pairs.
version (integer) --
The version of the thing record in the registry.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_topic_rules')
Creates an iterator that will paginate through responses from IoT.Client.list_topic_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
topic='string',
ruleDisabled=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'rules': [
{
'ruleArn': 'string',
'ruleName': 'string',
'topicPattern': 'string',
'createdAt': datetime(2015, 1, 1),
'ruleDisabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output from the ListTopicRules operation.
rules (list) --
The rules.
(dict) --
Describes a rule.
ruleArn (string) --
The rule ARN.
ruleName (string) --
The name of the rule.
topicPattern (string) --
The pattern for the topic names that apply.
createdAt (datetime) --
The date and time the rule was created.
ruleDisabled (boolean) --
Specifies whether the rule is disabled.
NextToken (string) --
A token to resume pagination.