2017/11/29 - AWS IoT - 57 new 11 updated api methods
Changes This release adds support for a number of new IoT features, including AWS IoT Device Management (Jobs, Fleet Index and Thing Registration), Thing Groups, Policies on Thing Groups, Registry & Job Events, JSON Logs, Fine-Grained Logging Controls, Custom Authorization and AWS Service Authentication Using X.509 Certificates.
Creates a job.
See also: AWS API Documentation
Request Syntax
client.create_job(
jobId='string',
targets=[
'string',
],
documentSource='string',
document='string',
description='string',
presignedUrlConfig={
'roleArn': 'string',
'expiresInSec': 123
},
targetSelection='CONTINUOUS'|'SNAPSHOT',
jobExecutionsRolloutConfig={
'maximumPerMinute': 123
},
documentParameters={
'string': 'string'
}
)
string
[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.
list
[REQUIRED]
A list of things and thing groups to which the job should be sent.
(string) --
string
An S3 link to the job document.
string
The job document.
string
A short text description of the job.
dict
Configuration information for pre-signed S3 URLs.
roleArn (string) --
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.
expiresInSec (integer) --
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.
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.
dict
Allows you to create a staged rollout of the job.
maximumPerMinute (integer) --
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
Parameters for the job document.
(string) --
(string) --
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.
Information about the thing registration tasks.
See also: AWS API Documentation
Request Syntax
client.list_thing_registration_task_reports(
taskId='string',
reportType='ERRORS'|'RESULTS',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The id of the task.
string
[REQUIRED]
The type of task report.
string
The token to retrieve the next set of results.
integer
The maximum number of results to return per request.
dict
Response Syntax
{
'resourceLinks': [
'string',
],
'reportType': 'ERRORS'|'RESULTS',
'nextToken': 'string'
}
Response Structure
(dict) --
resourceLinks (list) --
Links to the task resources.
(string) --
reportType (string) --
The type of task report.
nextToken (string) --
The token to retrieve the next set of results.
Gets the search configuration.
See also: AWS API Documentation
Request Syntax
client.get_indexing_configuration()
dict
Response Syntax
{
'thingIndexingConfiguration': {
'thingIndexingMode': 'OFF'|'REGISTRY'|'REGISTRY_AND_SHADOW'
}
}
Response Structure
(dict) --
thingIndexingConfiguration (dict) --
Thing indexing configuration.
thingIndexingMode (string) --
Thing indexing mode. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
OFF - Thing indexing is disabled.
Lists jobs.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
status='IN_PROGRESS'|'CANCELED'|'COMPLETED',
targetSelection='CONTINUOUS'|'SNAPSHOT',
maxResults=123,
nextToken='string',
thingGroupName='string',
thingGroupId='string'
)
string
An optional filter that lets you search for jobs that have the specified status.
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.
integer
The maximum number of results to return per request.
string
The token to retrieve the next set of results.
string
A filter that limits the returned jobs to those for the specified group.
string
A filter that limits the returned jobs to those for the specified group.
dict
Response Syntax
{
'jobs': [
{
'jobArn': 'string',
'jobId': 'string',
'thingGroupId': 'string',
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED',
'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.
List the thing groups in your account.
See also: AWS API Documentation
Request Syntax
client.list_thing_groups(
nextToken='string',
maxResults=123,
parentGroup='string',
namePrefixFilter='string',
recursive=True|False
)
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
string
A filter that limits the results to those with the specified parent group.
string
A filter that limits the results to those with the specified name prefix.
boolean
If true, return child groups as well.
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.
Describes a role alias.
See also: AWS API Documentation
Request Syntax
client.describe_role_alias(
roleAlias='string'
)
string
[REQUIRED]
The role alias to describe.
dict
Response Syntax
{
'roleAliasDescription': {
'roleAlias': 'string',
'roleArn': 'string',
'owner': 'string',
'credentialDurationSeconds': 123,
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
roleAliasDescription (dict) --
The role alias description.
roleAlias (string) --
The role alias.
roleArn (string) --
The role ARN.
owner (string) --
The role alias owner.
credentialDurationSeconds (integer) --
The number of seconds for which the credential is valid.
creationDate (datetime) --
The UNIX timestamp of when the role alias was created.
lastModifiedDate (datetime) --
The UNIX timestamp of when the role alias was last modified.
Provisions a thing.
See also: AWS API Documentation
Request Syntax
client.register_thing(
templateBody='string',
parameters={
'string': 'string'
}
)
string
[REQUIRED]
The provisioning template.
dict
The parameters for provisioning a thing.
(string) --
(string) --
dict
Response Syntax
{
'certificatePem': 'string',
'resourceArns': {
'string': 'string'
}
}
Response Structure
(dict) --
certificatePem (string) --
The PEM of a certificate.
resourceArns (dict) --
ARNs for the generated resources.
(string) --
(string) --
Updates the event configurations.
See also: AWS API Documentation
Request Syntax
client.update_event_configurations(
eventConfigurations={
'string': {
'Enabled': True|False
}
}
)
dict
The new event configuration values.
(string) --
(dict) --
Configuration.
Enabled (boolean) --
True to enable the configuration.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
client.start_thing_registration_task(
templateBody='string',
inputFileBucket='string',
inputFileKey='string',
roleArn='string'
)
string
[REQUIRED]
The provisioning template.
string
[REQUIRED]
The S3 bucket that contains the input file.
string
[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).
string
[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.
List the thing groups to which the specified thing belongs.
See also: AWS API Documentation
Request Syntax
client.list_thing_groups_for_thing(
thingName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The thing name.
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
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 policies attached to the specified thing group.
See also: AWS API Documentation
Request Syntax
client.list_attached_policies(
target='string',
recursive=True|False,
marker='string',
pageSize=123
)
string
[REQUIRED]
The group for which the policies will be listed.
boolean
When true, recursively list attached policies.
string
The token to retrieve the next set of results.
integer
The maximum number of results to be returned per request.
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.
Update a thing group.
See also: AWS API Documentation
Request Syntax
client.update_thing_group(
thingGroupName='string',
thingGroupProperties={
'thingGroupDescription': 'string',
'attributePayload': {
'attributes': {
'string': 'string'
},
'merge': True|False
}
},
expectedVersion=123
)
string
[REQUIRED]
The thing group to update.
dict
[REQUIRED]
The thing group properties.
thingGroupDescription (string) --
The thing group description.
attributePayload (dict) --
The thing group attributes in JSON format.
attributes (dict) --
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
(string) --
(string) --
merge (boolean) --
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 .
integer
The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
dict
Response Syntax
{
'version': 123
}
Response Structure
(dict) --
version (integer) --
The version of the updated thing group.
Updates a role alias.
See also: AWS API Documentation
Request Syntax
client.update_role_alias(
roleAlias='string',
roleArn='string',
credentialDurationSeconds=123
)
string
[REQUIRED]
The role alias to update.
string
The role ARN.
integer
The number of seconds the credential will be valid.
dict
Response Syntax
{
'roleAlias': 'string',
'roleAliasArn': 'string'
}
Response Structure
(dict) --
roleAlias (string) --
The role alias.
roleAliasArn (string) --
The role alias ARN.
Updates an authorizer.
See also: AWS API Documentation
Request Syntax
client.update_authorizer(
authorizerName='string',
authorizerFunctionArn='string',
tokenKeyName='string',
tokenSigningPublicKeys={
'string': 'string'
},
status='ACTIVE'|'INACTIVE'
)
string
[REQUIRED]
The authorizer name.
string
The ARN of the authorizer's Lambda function.
string
The key used to extract the token from the HTTP headers.
dict
The public keys used to verify the token signature.
(string) --
(string) --
string
The status of the update authorizer request.
dict
Response Syntax
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
(dict) --
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
Lists the things in the specified group.
See also: AWS API Documentation
Request Syntax
client.list_things_in_thing_group(
thingGroupName='string',
recursive=True|False,
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The thing group name.
boolean
When true, list things in this thing group and in all child groups as well.
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'things': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
things (list) --
The things in the specified thing group.
(string) --
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Deletes an authorizer.
See also: AWS API Documentation
Request Syntax
client.delete_authorizer(
authorizerName='string'
)
string
[REQUIRED]
The name of the authorizer to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a logging level.
See also: AWS API Documentation
Request Syntax
client.delete_v2_logging_level(
targetType='DEFAULT'|'THING_GROUP',
targetName='string'
)
string
[REQUIRED]
The type of resource for which you are configuring logging. Must be THING_Group .
string
[REQUIRED]
The name of the resource for which you are configuring logging.
None
Sets the logging level.
See also: AWS API Documentation
Request Syntax
client.set_v2_logging_level(
logTarget={
'targetType': 'DEFAULT'|'THING_GROUP',
'targetName': 'string'
},
logLevel='DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
)
dict
[REQUIRED]
The log target.
targetType (string) -- [REQUIRED]
The target type.
targetName (string) --
The target name.
string
[REQUIRED]
The log level.
None
Gets the fine grained logging options.
See also: AWS API Documentation
Request Syntax
client.get_v2_logging_options()
dict
Response Syntax
{
'roleArn': 'string',
'defaultLogLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED',
'disableAllLogs': True|False
}
Response Structure
(dict) --
roleArn (string) --
The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
defaultLogLevel (string) --
The default log level.
disableAllLogs (boolean) --
Disables all logs.
Lists the authorizers registered in your account.
See also: AWS API Documentation
Request Syntax
client.list_authorizers(
pageSize=123,
marker='string',
ascendingOrder=True|False,
status='ACTIVE'|'INACTIVE'
)
integer
The maximum number of results to return at one time.
string
A marker used to get the next set of results.
boolean
Return the list of authorizers in ascending alphabetical order.
string
The status of the list authorizers request.
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.
Updates the groups to which the thing belongs.
See also: AWS API Documentation
Request Syntax
client.update_thing_groups_for_thing(
thingName='string',
thingGroupsToAdd=[
'string',
],
thingGroupsToRemove=[
'string',
]
)
string
The thing whose group memberships will be updated.
list
The groups to which the thing will be added.
(string) --
list
The groups from which the thing will be removed.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets effective policies.
See also: AWS API Documentation
Request Syntax
client.get_effective_policies(
principal='string',
cognitoIdentityPoolId='string',
thingName='string'
)
string
The principal.
string
The Cognito identity pool ID.
string
The thing name.
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.
Cancels a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
client.stop_thing_registration_task(
taskId='string'
)
string
[REQUIRED]
The bulk thing provisioning task ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes a job execution.
See also: AWS API Documentation
Request Syntax
client.describe_job_execution(
jobId='string',
thingName='string',
executionNumber=123
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
string
[REQUIRED]
The name of the thing on which the job execution is running.
integer
A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.
dict
Response Syntax
{
'execution': {
'jobId': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
'statusDetails': {
'detailsMap': {
'string': 'string'
}
},
'thingArn': 'string',
'queuedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'executionNumber': 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).
statusDetails (dict) --
A collection of name/value pairs that describe the status of the job execution.
detailsMap (dict) --
The job execution status.
(string) --
(string) --
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.
List bulk thing provisioning tasks.
See also: AWS API Documentation
Request Syntax
client.list_thing_registration_tasks(
nextToken='string',
maxResults=123,
status='InProgress'|'Completed'|'Failed'|'Cancelled'|'Cancelling'
)
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
string
The status of the bulk thing provisioning task.
dict
Response Syntax
{
'taskIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskIds (list) --
A list of bulk thing provisioning task IDs.
(string) --
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Creates a role alias.
See also: AWS API Documentation
Request Syntax
client.create_role_alias(
roleAlias='string',
roleArn='string',
credentialDurationSeconds=123
)
string
[REQUIRED]
The role alias that points to a role ARN. This allows you to change the role without having to update the device.
string
[REQUIRED]
The role ARN.
integer
How long (in seconds) the credentials will be valid.
dict
Response Syntax
{
'roleAlias': 'string',
'roleAliasArn': 'string'
}
Response Structure
(dict) --
roleAlias (string) --
The role alias.
roleAliasArn (string) --
The role alias ARN.
Describes a bulk thing provisioning task.
See also: AWS API Documentation
Request Syntax
client.describe_thing_registration_task(
taskId='string'
)
string
[REQUIRED]
The task ID.
dict
Response Syntax
{
'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
(dict) --
taskId (string) --
The task ID.
creationDate (datetime) --
The task creation date.
lastModifiedDate (datetime) --
The date when the task was last modified.
templateBody (string) --
The task's template.
inputFileBucket (string) --
The S3 bucket that contains the input file.
inputFileKey (string) --
The input file key.
roleArn (string) --
The role ARN that grants access to the input file bucket.
status (string) --
The status of the bulk thing provisioning task.
message (string) --
The message.
successCount (integer) --
The number of things successfully provisioned.
failureCount (integer) --
The number of things that failed to be provisioned.
percentageProgress (integer) --
The progress of the bulk provisioning task expressed as a percentage.
Gets a job document.
See also: AWS API Documentation
Request Syntax
client.get_job_document(
jobId='string'
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
dict
Response Syntax
{
'document': 'string'
}
Response Structure
(dict) --
document (string) --
The job document content.
The query search index.
See also: AWS API Documentation
Request Syntax
client.search_index(
indexName='string',
queryString='string',
nextToken='string',
maxResults=123,
queryVersion='string'
)
string
The search index name.
string
[REQUIRED]
The search query string.
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
string
The query version.
dict
Response Syntax
{
'nextToken': 'string',
'things': [
{
'thingName': 'string',
'thingId': 'string',
'thingTypeName': 'string',
'thingGroupNames': [
'string',
],
'attributes': {
'string': 'string'
},
'shadow': '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.
(string) --
attributes (dict) --
The attributes.
(string) --
(string) --
shadow (string) --
The thing shadow.
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
See also: AWS API Documentation
Request Syntax
client.associate_targets_with_job(
targets=[
'string',
],
jobId='string',
comment='string'
)
list
[REQUIRED]
A list of thing group ARNs that define the targets of the job.
(string) --
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
string
An optional comment string describing why the job was associated with the targets.
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.
Deletes a role alias
See also: AWS API Documentation
Request Syntax
client.delete_role_alias(
roleAlias='string'
)
string
[REQUIRED]
The role alias to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Clears the default authorizer.
See also: AWS API Documentation
Request Syntax
client.clear_default_authorizer()
dict
Response Syntax
{}
Response Structure
(dict) --
Cancels a job.
See also: AWS API Documentation
Request Syntax
client.cancel_job(
jobId='string',
comment='string'
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
string
An optional comment string describing why the job was canceled.
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.
Lists logging levels.
See also: AWS API Documentation
Request Syntax
client.list_v2_logging_levels(
targetType='DEFAULT'|'THING_GROUP',
nextToken='string',
maxResults=123
)
string
The type of resource for which you are configuring logging. Must be THING_Group .
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
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.
Invoke the specified custom authorizer for testing purposes.
See also: AWS API Documentation
Request Syntax
client.test_invoke_authorizer(
authorizerName='string',
token='string',
tokenSignature='string'
)
string
[REQUIRED]
The custom authorizer name.
string
[REQUIRED]
The token returned by your custom authentication service.
string
[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.
(string) --
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.
Lists the role aliases registered in your account.
See also: AWS API Documentation
Request Syntax
client.list_role_aliases(
pageSize=123,
marker='string',
ascendingOrder=True|False
)
integer
The maximum number of results to return at one time.
string
A marker used to get the next set of results.
boolean
Return the list of role aliases in ascending alphabetical order.
dict
Response Syntax
{
'roleAliases': [
'string',
],
'nextMarker': 'string'
}
Response Structure
(dict) --
roleAliases (list) --
The role aliases.
(string) --
nextMarker (string) --
A marker used to get the next set of results.
Describes event configurations.
See also: AWS API Documentation
Request Syntax
client.describe_event_configurations()
dict
Response Syntax
{
'eventConfigurations': {
'string': {
'Enabled': True|False
}
},
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
eventConfigurations (dict) --
The event configurations.
(string) --
(dict) --
Configuration.
Enabled (boolean) --
True to enable the configuration.
creationDate (datetime) --
The creation date of the event configuration.
lastModifiedDate (datetime) --
The date the event configurations were last modified.
Describes the default authorizer.
See also: AWS API Documentation
Request Syntax
client.describe_default_authorizer()
dict
Response Syntax
{
'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
(dict) --
authorizerDescription (dict) --
The default authorizer's description.
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
authorizerFunctionArn (string) --
The authorizer's Lambda function ARN.
tokenKeyName (string) --
The key used to extract the token from the HTTP headers.
tokenSigningPublicKeys (dict) --
The public keys used to validate the token signature returned by your custom authentication service.
(string) --
(string) --
status (string) --
The status of the authorizer.
creationDate (datetime) --
The UNIX timestamp of when the authorizer was created.
lastModifiedDate (datetime) --
The UNIX timestamp of when the authorizer was last updated.
Attaches a policy to the specified target.
See also: AWS API Documentation
Request Syntax
client.attach_policy(
policyName='string',
target='string'
)
string
[REQUIRED]
The name of the policy to attach.
string
[REQUIRED]
The identity to which the policy is attached.
None
Updates the search configuration.
See also: AWS API Documentation
Request Syntax
client.update_indexing_configuration(
thingIndexingConfiguration={
'thingIndexingMode': 'OFF'|'REGISTRY'|'REGISTRY_AND_SHADOW'
}
)
dict
Thing indexing configuration.
thingIndexingMode (string) --
Thing indexing mode. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
OFF - Thing indexing is disabled.
dict
Response Syntax
{}
Response Structure
(dict) --
Test custom authorization.
See also: AWS API Documentation
Request Syntax
client.test_authorization(
principal='string',
cognitoIdentityPoolId='string',
authInfos=[
{
'actionType': 'PUBLISH'|'SUBSCRIBE'|'RECEIVE'|'CONNECT',
'resources': [
'string',
]
},
],
clientId='string',
policyNamesToAdd=[
'string',
],
policyNamesToSkip=[
'string',
]
)
string
The principal.
string
The Cognito identity pool ID.
list
[REQUIRED]
A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
(dict) --
A collection of 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.
(string) --
string
The MQTT client ID.
list
When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
(string) --
list
When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
(string) --
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.
(string) --
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.
(string) --
Sets the logging options for the V2 logging service.
See also: AWS API Documentation
Request Syntax
client.set_v2_logging_options(
roleArn='string',
defaultLogLevel='DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED',
disableAllLogs=True|False
)
string
The role ARN that allows IoT to write to Cloudwatch logs.
string
The default logging level.
boolean
Set to true to disable all logs, otherwise set to false.
None
Describes a search index.
See also: AWS API Documentation
Request Syntax
client.describe_index(
indexName='string'
)
string
[REQUIRED]
The index name.
dict
Response Syntax
{
'indexName': 'string',
'indexStatus': 'ACTIVE'|'BUILDING'|'REBUILDING',
'schema': 'string'
}
Response Structure
(dict) --
indexName (string) --
The index name.
indexStatus (string) --
The index status.
schema (string) --
Contains a value that specifies the type of indexing performed. Valid values are:
REGISTRY – Your thing index will contain only registry data.
REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
Describes an authorizer.
See also: AWS API Documentation
Request Syntax
client.describe_authorizer(
authorizerName='string'
)
string
[REQUIRED]
The name of the authorizer to describe.
dict
Response Syntax
{
'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
(dict) --
authorizerDescription (dict) --
The authorizer description.
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
authorizerFunctionArn (string) --
The authorizer's Lambda function ARN.
tokenKeyName (string) --
The key used to extract the token from the HTTP headers.
tokenSigningPublicKeys (dict) --
The public keys used to validate the token signature returned by your custom authentication service.
(string) --
(string) --
status (string) --
The status of the authorizer.
creationDate (datetime) --
The UNIX timestamp of when the authorizer was created.
lastModifiedDate (datetime) --
The UNIX timestamp of when the authorizer was last updated.
Create a thing group.
See also: AWS API Documentation
Request Syntax
client.create_thing_group(
thingGroupName='string',
parentGroupName='string',
thingGroupProperties={
'thingGroupDescription': 'string',
'attributePayload': {
'attributes': {
'string': 'string'
},
'merge': True|False
}
}
)
string
[REQUIRED]
The thing group name to create.
string
The name of the parent thing group.
dict
The thing group properties.
thingGroupDescription (string) --
The thing group description.
attributePayload (dict) --
The thing group attributes in JSON format.
attributes (dict) --
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
(string) --
(string) --
merge (boolean) --
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.
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
client.set_default_authorizer(
authorizerName='string'
)
string
[REQUIRED]
The authorizer name.
dict
Response Syntax
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
(dict) --
authorizerName (string) --
The authorizer name.
authorizerArn (string) --
The authorizer ARN.
Detaches a policy from the specified target.
See also: AWS API Documentation
Request Syntax
client.detach_policy(
policyName='string',
target='string'
)
string
[REQUIRED]
The policy to detach.
string
[REQUIRED]
The target from which the policy will be detached.
None
List targets for the specified policy.
See also: AWS API Documentation
Request Syntax
client.list_targets_for_policy(
policyName='string',
marker='string',
pageSize=123
)
string
[REQUIRED]
The policy name.
string
A marker used to get the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'targets': [
'string',
],
'nextMarker': 'string'
}
Response Structure
(dict) --
targets (list) --
The policy targets.
(string) --
nextMarker (string) --
A marker used to get the next set of results.
Adds a thing to a thing group.
See also: AWS API Documentation
Request Syntax
client.add_thing_to_thing_group(
thingGroupName='string',
thingGroupArn='string',
thingName='string',
thingArn='string'
)
string
The name of the group to which you are adding a thing.
string
The ARN of the group to which you are adding a thing.
string
The name of the thing to add to a group.
string
The ARN of the thing to add to a group.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a thing group.
See also: AWS API Documentation
Request Syntax
client.delete_thing_group(
thingGroupName='string',
expectedVersion=123
)
string
[REQUIRED]
The name of the thing group to delete.
integer
The expected version of the thing group to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the search indices.
See also: AWS API Documentation
Request Syntax
client.list_indices(
nextToken='string',
maxResults=123
)
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'indexNames': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
indexNames (list) --
The index names.
(string) --
nextToken (string) --
The token used to get the next set of results, or null if there are no additional results.
Creates an authorizer.
See also: AWS API Documentation
Request Syntax
client.create_authorizer(
authorizerName='string',
authorizerFunctionArn='string',
tokenKeyName='string',
tokenSigningPublicKeys={
'string': 'string'
},
status='ACTIVE'|'INACTIVE'
)
string
[REQUIRED]
The authorizer name.
string
[REQUIRED]
The ARN of the authorizer's Lambda function.
string
[REQUIRED]
The name of the token key used to extract the token from the HTTP headers.
dict
[REQUIRED]
The public keys used to verify the digital signature returned by your custom authentication service.
(string) --
(string) --
string
The status of the create authorizer request.
dict
Response Syntax
{
'authorizerName': 'string',
'authorizerArn': 'string'
}
Response Structure
(dict) --
authorizerName (string) --
The authorizer's name.
authorizerArn (string) --
The authorizer ARN.
Lists the job executions for the specified thing.
See also: AWS API Documentation
Request Syntax
client.list_job_executions_for_thing(
thingName='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The thing name.
string
An optional filter that lets you search for jobs that have the specified status.
integer
The maximum number of results to be returned per request.
string
The token to retrieve the next set of results.
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.
Remove the specified thing from the specified group.
See also: AWS API Documentation
Request Syntax
client.remove_thing_from_thing_group(
thingGroupName='string',
thingGroupArn='string',
thingName='string',
thingArn='string'
)
string
The group name.
string
The group ARN.
string
The name of the thing to remove from the group.
string
The ARN of the thing to remove from the group.
dict
Response Syntax
{}
Response Structure
(dict) --
Describe a thing group.
See also: AWS API Documentation
Request Syntax
client.describe_thing_group(
thingGroupName='string'
)
string
[REQUIRED]
The name of the thing group.
dict
Response Syntax
{
'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
(dict) --
thingGroupName (string) --
The name of the thing group.
thingGroupId (string) --
The thing group ID.
thingGroupArn (string) --
The thing group ARN.
version (integer) --
The version of the thing group.
thingGroupProperties (dict) --
The thing group properties.
thingGroupDescription (string) --
The thing group description.
attributePayload (dict) --
The thing group attributes in JSON format.
attributes (dict) --
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
(string) --
(string) --
merge (boolean) --
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 .
thingGroupMetadata (dict) --
Thing group metadata.
parentGroupName (string) --
The parent thing group name.
rootToParentThingGroups (list) --
The root parent thing group.
(dict) --
The name and ARN of a group.
groupName (string) --
The group name.
groupArn (string) --
The group ARN.
creationDate (datetime) --
The UNIX timestamp of when the thing group was created.
Lists the job executions for a job.
See also: AWS API Documentation
Request Syntax
client.list_job_executions_for_job(
jobId='string',
status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'REJECTED'|'REMOVED'|'CANCELED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
string
The status of the job.
integer
The maximum number of results to be returned per request.
string
The token to retrieve the next set of results.
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.
Describes a job.
See also: AWS API Documentation
Request Syntax
client.describe_job(
jobId='string'
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
dict
Response Syntax
{
'documentSource': 'string',
'job': {
'jobArn': 'string',
'jobId': 'string',
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED',
'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
},
'documentParameters': {
'string': 'string'
}
}
}
Response Structure
(dict) --
documentSource (string) --
An S3 link to the job document.
job (dict) --
Information about the job.
jobArn (string) --
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
jobId (string) --
The unique identifier you assigned to this job when it was created.
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 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.
status (string) --
The status of the job, one of IN_PROGRESS , CANCELED , or COMPLETED .
comment (string) --
If the job was updated, describes the reason for the update.
targets (list) --
A list of IoT things and thing groups to which the job should be sent.
(string) --
description (string) --
A short text description of the job.
presignedUrlConfig (dict) --
Configuration for pre-signed S3 URLs.
roleArn (string) --
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.
expiresInSec (integer) --
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.
jobExecutionsRolloutConfig (dict) --
Allows you to create a staged rollout of a job.
maximumPerMinute (integer) --
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
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 was completed.
jobProcessDetails (dict) --
Details about the job process.
processingTargets (list) --
The devices on which the job is executing.
(string) --
numberOfCanceledThings (integer) --
The number of things that cancelled the job.
numberOfSucceededThings (integer) --
The number of things which successfully completed the job.
numberOfFailedThings (integer) --
The number of things that failed executing the job.
numberOfRejectedThings (integer) --
The number of things that rejected the job.
numberOfQueuedThings (integer) --
The number of things that are awaiting execution of the job.
numberOfInProgressThings (integer) --
The number of things currently executing the job.
numberOfRemovedThings (integer) --
The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
documentParameters (dict) --
The parameters specified for the job document.
(string) --
(string) --
{'thingId': 'string'}
Creates a thing record in the thing registry.
See also: AWS API Documentation
Request Syntax
client.create_thing(
thingName='string',
thingTypeName='string',
attributePayload={
'attributes': {
'string': 'string'
},
'merge': True|False
}
)
string
[REQUIRED]
The name of the thing to create.
string
The name of the thing type associated with the new thing.
dict
The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
{\"attributes\":{\"string1\":\"string2\"}}
attributes (dict) --
A JSON string containing up to three key-value pair in JSON format. For example:
{\"attributes\":{\"string1\":\"string2\"}}
(string) --
(string) --
merge (boolean) --
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.
{'thingTypeId': 'string'}
Creates a new thing type.
See also: AWS API Documentation
Request Syntax
client.create_thing_type(
thingTypeName='string',
thingTypeProperties={
'thingTypeDescription': 'string',
'searchableAttributes': [
'string',
]
}
)
string
[REQUIRED]
The name of the thing type.
dict
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.
thingTypeDescription (string) --
The description of the thing type.
searchableAttributes (list) --
A list of searchable thing attribute names.
(string) --
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.
{'forceDelete': 'boolean'}
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
client.delete_certificate(
certificateId='string',
forceDelete=True|False
)
string
[REQUIRED]
The ID of the certificate.
boolean
Forces a certificate request to be deleted.
None
{'registrationConfig': {'roleArn': 'string', 'templateBody': 'string'}}
Describes a registered CA certificate.
See also: AWS API Documentation
Request Syntax
client.describe_ca_certificate(
certificateId='string'
)
string
[REQUIRED]
The CA certificate identifier.
dict
Response Syntax
{
'certificateDescription': {
'certificateArn': 'string',
'certificateId': 'string',
'status': 'ACTIVE'|'INACTIVE',
'certificatePem': 'string',
'ownedBy': 'string',
'creationDate': datetime(2015, 1, 1),
'autoRegistrationStatus': 'ENABLE'|'DISABLE'
},
'registrationConfig': {
'templateBody': 'string',
'roleArn': 'string'
}
}
Response Structure
(dict) --
The output from the DescribeCACertificate operation.
certificateDescription (dict) --
The CA certificate description.
certificateArn (string) --
The CA certificate ARN.
certificateId (string) --
The CA certificate ID.
status (string) --
The status of a CA certificate.
certificatePem (string) --
The CA certificate data, in PEM format.
ownedBy (string) --
The owner of the CA certificate.
creationDate (datetime) --
The date the CA certificate was created.
autoRegistrationStatus (string) --
Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
registrationConfig (dict) --
Information about the registration configuration.
templateBody (string) --
The template body.
roleArn (string) --
The ARN of the role.
{'endpointType': 'string'}
Returns a unique endpoint specific to the AWS account making the call.
See also: AWS API Documentation
Request Syntax
client.describe_endpoint(
endpointType='string'
)
string
The endpoint type.
dict
Response Syntax
{
'endpointAddress': 'string'
}
Response Structure
(dict) --
The output from the DescribeEndpoint operation.
endpointAddress (string) --
The endpoint. The format of the endpoint is as follows: identifier .iot.*region* .amazonaws.com.
{'thingArn': 'string', 'thingId': 'string'}
Gets information about the specified thing.
See also: AWS API Documentation
Request Syntax
client.describe_thing(
thingName='string'
)
string
[REQUIRED]
The name of the thing.
dict
Response Syntax
{
'defaultClientId': 'string',
'thingName': 'string',
'thingId': 'string',
'thingArn': 'string',
'thingTypeName': 'string',
'attributes': {
'string': 'string'
},
'version': 123
}
Response Structure
(dict) --
The output from the DescribeThing operation.
defaultClientId (string) --
The default client ID.
thingName (string) --
The name of the thing.
thingId (string) --
The ID of the thing to describe.
thingArn (string) --
The ARN of the thing to describe.
thingTypeName (string) --
The thing type name.
attributes (dict) --
The thing attributes.
(string) --
(string) --
version (integer) --
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.
{'thingTypeArn': 'string', 'thingTypeId': 'string'}
Gets information about the specified thing type.
See also: AWS API Documentation
Request Syntax
client.describe_thing_type(
thingTypeName='string'
)
string
[REQUIRED]
The name of the thing type.
dict
Response Syntax
{
'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
(dict) --
The output for the DescribeThingType operation.
thingTypeName (string) --
The name of the thing type.
thingTypeId (string) --
The thing type ID.
thingTypeArn (string) --
The thing type ARN.
thingTypeProperties (dict) --
The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
thingTypeDescription (string) --
The description of the thing type.
searchableAttributes (list) --
A list of searchable thing attribute names.
(string) --
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.
{'thingTypes': {'thingTypeArn': 'string'}}
Lists the existing thing types.
See also: AWS API Documentation
Request Syntax
client.list_thing_types(
nextToken='string',
maxResults=123,
thingTypeName='string'
)
string
The token for the next set of results, or null if there are no additional results.
integer
The maximum number of results to return in this operation.
string
The name of the thing type.
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.
(string) --
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.
{'things': {'thingArn': 'string'}}
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
client.list_things(
nextToken='string',
maxResults=123,
attributeName='string',
attributeValue='string',
thingTypeName='string'
)
string
The token used to get the next set of results, or null if there are no additional results.
integer
The maximum number of results to return in this operation.
string
The attribute name used to search for things.
string
The attribute value used to search for things.
string
The name of the thing type used to search for things.
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.
(string) --
(string) --
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.
{'registrationConfig': {'roleArn': 'string', 'templateBody': 'string'}}
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
client.register_ca_certificate(
caCertificate='string',
verificationCertificate='string',
setAsActive=True|False,
allowAutoRegistration=True|False,
registrationConfig={
'templateBody': 'string',
'roleArn': 'string'
}
)
string
[REQUIRED]
The CA certificate.
string
[REQUIRED]
The private key verification certificate.
boolean
A boolean value that specifies if the CA certificate is set to active.
boolean
Allows this CA certificate to be used for auto registration of device certificates.
dict
Information about the registration configuration.
templateBody (string) --
The template body.
roleArn (string) --
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.
{'registrationConfig': {'roleArn': 'string', 'templateBody': 'string'},
'removeAutoRegistration': 'boolean'}
Updates a registered CA certificate.
See also: AWS API Documentation
Request Syntax
client.update_ca_certificate(
certificateId='string',
newStatus='ACTIVE'|'INACTIVE',
newAutoRegistrationStatus='ENABLE'|'DISABLE',
registrationConfig={
'templateBody': 'string',
'roleArn': 'string'
},
removeAutoRegistration=True|False
)
string
[REQUIRED]
The CA certificate identifier.
string
The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
string
The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
dict
Information about the registration configuration.
templateBody (string) --
The template body.
roleArn (string) --
The ARN of the role.
boolean
If true, remove auto registration.
None