IoT

Table of Contents

Client

class IoT.Client

A low-level client representing AWS IoT:

import boto3

client = boto3.client('iot')

These are the available methods:

accept_certificate_transfer(**kwargs)

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
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The ID of the certificate.

  • setAsActive (boolean) -- Specifies whether the certificate is active.
Returns

None

add_thing_to_thing_group(**kwargs)

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'
)
Parameters
  • thingGroupName (string) -- The name of the group to which you are adding a thing.
  • thingGroupArn (string) -- The ARN of the group to which you are adding a thing.
  • thingName (string) -- The name of the thing to add to a group.
  • thingArn (string) -- The ARN of the thing to add to a group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

associate_targets_with_job(**kwargs)

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

response = client.associate_targets_with_job(
    targets=[
        'string',
    ],
    jobId='string',
    comment='string'
)
Parameters
  • targets (list) --

    [REQUIRED]

    A list of thing group ARNs that define the targets of the job.

    • (string) --
  • jobId (string) --

    [REQUIRED]

    The unique identifier you assigned to this job when it was created.

  • comment (string) -- An optional comment string describing why the job was associated with the targets.
Return type

dict

Returns

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.

attach_policy(**kwargs)

Attaches a policy to the specified target.

See also: AWS API Documentation

Request Syntax

response = client.attach_policy(
    policyName='string',
    target='string'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The name of the policy to attach.

  • target (string) --

    [REQUIRED]

    The identity to which the policy is attached.

Returns

None

attach_principal_policy(**kwargs)

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'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • principal (string) --

    [REQUIRED]

    The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

Returns

None

attach_thing_principal(**kwargs)

Attaches the specified principal to the specified thing.

See also: AWS API Documentation

Request Syntax

response = client.attach_thing_principal(
    thingName='string',
    principal='string'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • principal (string) --

    [REQUIRED]

    The principal, such as a certificate or other credential.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The output from the AttachThingPrincipal operation.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_certificate_transfer(**kwargs)

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'
)
Parameters
certificateId (string) --

[REQUIRED]

The ID of the certificate.

Returns
None
cancel_job(**kwargs)

Cancels a job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job(
    jobId='string',
    comment='string'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique identifier you assigned to this job when it was created.

  • comment (string) -- An optional comment string describing why the job was canceled.
Return type

dict

Returns

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.

clear_default_authorizer()

Clears the default authorizer.

See also: AWS API Documentation

Request Syntax

response = client.clear_default_authorizer()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
create_authorizer(**kwargs)

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'
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The authorizer name.

  • authorizerFunctionArn (string) --

    [REQUIRED]

    The ARN of the authorizer's Lambda function.

  • tokenKeyName (string) --

    [REQUIRED]

    The name of the token key used to extract the token from the HTTP headers.

  • tokenSigningPublicKeys (dict) --

    [REQUIRED]

    The public keys used to verify the digital signature returned by your custom authentication service.

    • (string) --
      • (string) --
  • status (string) -- The status of the create authorizer request.
Return type

dict

Returns

Response Syntax

{
    'authorizerName': 'string',
    'authorizerArn': 'string'
}

Response Structure

  • (dict) --

    • authorizerName (string) --

      The authorizer's name.

    • authorizerArn (string) --

      The authorizer ARN.

create_certificate_from_csr(**kwargs)

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
)
Parameters
  • certificateSigningRequest (string) --

    [REQUIRED]

    The certificate signing request (CSR).

  • setAsActive (boolean) -- Specifies whether the certificate is active.
Return type

dict

Returns

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.

create_job(**kwargs)

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
    },
    documentParameters={
        'string': 'string'
    }
)
Parameters
  • jobId (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.

  • targets (list) --

    [REQUIRED]

    A list of things and thing groups to which the job should be sent.

    • (string) --
  • documentSource (string) -- An S3 link to the job document.
  • document (string) -- The job document.
  • description (string) -- A short text description of the job.
  • presignedUrlConfig (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.

  • 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.
  • jobExecutionsRolloutConfig (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.

  • documentParameters (dict) --

    Parameters for the job document.

    • (string) --
      • (string) --
Return type

dict

Returns

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.

create_keys_and_certificate(**kwargs)

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
)
Parameters
setAsActive (boolean) -- Specifies whether the certificate is active.
Return type
dict
Returns
Response Syntax
{
    'certificateArn': 'string',
    'certificateId': 'string',
    'certificatePem': 'string',
    'keyPair': {
        'PublicKey': 'string',
        'PrivateKey': 'string'
    }
}

Response Structure

  • (dict) --

    The output of the CreateKeysAndCertificate operation.

    • certificateArn (string) --

      The ARN of the certificate.

    • certificateId (string) --

      The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).

    • certificatePem (string) --

      The certificate data, in PEM format.

    • keyPair (dict) --

      The generated key pair.

      • PublicKey (string) --

        The public key.

      • PrivateKey (string) --

        The private key.

create_policy(**kwargs)

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'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • policyDocument (string) --

    [REQUIRED]

    The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Return type

dict

Returns

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.

create_policy_version(**kwargs)

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
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • policyDocument (string) --

    [REQUIRED]

    The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

  • setAsDefault (boolean) -- Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
Return type

dict

Returns

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.

create_role_alias(**kwargs)

Creates a role alias.

See also: AWS API Documentation

Request Syntax

response = client.create_role_alias(
    roleAlias='string',
    roleArn='string',
    credentialDurationSeconds=123
)
Parameters
  • roleAlias (string) --

    [REQUIRED]

    The role alias that points to a role ARN. This allows you to change the role without having to update the device.

  • roleArn (string) --

    [REQUIRED]

    The role ARN.

  • credentialDurationSeconds (integer) -- How long (in seconds) the credentials will be valid.
Return type

dict

Returns

Response Syntax

{
    'roleAlias': 'string',
    'roleAliasArn': 'string'
}

Response Structure

  • (dict) --

    • roleAlias (string) --

      The role alias.

    • roleAliasArn (string) --

      The role alias ARN.

create_thing(**kwargs)

Creates a thing record in the thing registry.

See also: AWS API Documentation

Request Syntax

response = client.create_thing(
    thingName='string',
    thingTypeName='string',
    attributePayload={
        'attributes': {
            'string': 'string'
        },
        'merge': True|False
    }
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing to create.

  • thingTypeName (string) -- The name of the thing type associated with the new thing.
  • attributePayload (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 .

Return type

dict

Returns

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_thing_group(**kwargs)

Create a thing group.

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
        }
    }
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The thing group name to create.

  • parentGroupName (string) -- The name of the parent 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 .

Return type

dict

Returns

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.

create_thing_type(**kwargs)

Creates a new thing type.

See also: AWS API Documentation

Request Syntax

response = client.create_thing_type(
    thingTypeName='string',
    thingTypeProperties={
        'thingTypeDescription': 'string',
        'searchableAttributes': [
            'string',
        ]
    }
)
Parameters
  • thingTypeName (string) --

    [REQUIRED]

    The name of the thing type.

  • thingTypeProperties (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) --
Return type

dict

Returns

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.

create_topic_rule(**kwargs)

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'
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string'
    }
)
Parameters
  • ruleName (string) --

    [REQUIRED]

    The name of the rule.

  • topicRulePayload (dict) --

    [REQUIRED]

    The rule payload.

    • sql (string) -- [REQUIRED]

      The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

    • description (string) --

      The description of the rule.

    • actions (list) -- [REQUIRED]

      The actions associated with the rule.

      • (dict) --

        Describes the actions associated with a rule.

        • dynamoDB (dict) --

          Write to a DynamoDB table.

          • tableName (string) -- [REQUIRED]

            The name of the DynamoDB table.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access to the DynamoDB table.

          • operation (string) --

            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 .

          • hashKeyField (string) -- [REQUIRED]

            The hash key name.

          • hashKeyValue (string) -- [REQUIRED]

            The hash key value.

          • hashKeyType (string) --

            The hash key type. Valid values are "STRING" or "NUMBER"

          • rangeKeyField (string) --

            The range key name.

          • rangeKeyValue (string) --

            The range key value.

          • rangeKeyType (string) --

            The range key type. Valid values are "STRING" or "NUMBER"

          • payloadField (string) --

            The action payload. This name can be customized.

        • dynamoDBv2 (dict) --

          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.

          • roleArn (string) --

            The ARN of the IAM role that grants access to the DynamoDB table.

          • putItem (dict) --

            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.

            • tableName (string) -- [REQUIRED]

              The table where the message data will be written

        • lambda (dict) --

          Invoke a Lambda function.

          • functionArn (string) -- [REQUIRED]

            The ARN of the Lambda function.

        • sns (dict) --

          Publish to an Amazon SNS topic.

          • targetArn (string) -- [REQUIRED]

            The ARN of the SNS topic.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • messageFormat (string) --

            The message format of the message to publish. Optional. 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.

        • sqs (dict) --

          Publish to an Amazon SQS queue.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • queueUrl (string) -- [REQUIRED]

            The URL of the Amazon SQS queue.

          • useBase64 (boolean) --

            Specifies whether to use Base64 encoding.

        • kinesis (dict) --

          Write data to an Amazon Kinesis stream.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access to the Amazon Kinesis stream.

          • streamName (string) -- [REQUIRED]

            The name of the Amazon Kinesis stream.

          • partitionKey (string) --

            The partition key.

        • republish (dict) --

          Publish to another MQTT topic.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • topic (string) -- [REQUIRED]

            The name of the MQTT topic.

        • s3 (dict) --

          Write to an Amazon S3 bucket.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • bucketName (string) -- [REQUIRED]

            The Amazon S3 bucket.

          • key (string) -- [REQUIRED]

            The object key.

          • cannedAcl (string) --

            The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .

        • firehose (dict) --

          Write to an Amazon Kinesis Firehose stream.

          • roleArn (string) -- [REQUIRED]

            The IAM role that grants access to the Amazon Kinesis Firehose stream.

          • deliveryStreamName (string) -- [REQUIRED]

            The delivery stream name.

          • separator (string) --

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

        • cloudwatchMetric (dict) --

          Capture a CloudWatch metric.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch metric.

          • metricNamespace (string) -- [REQUIRED]

            The CloudWatch metric namespace name.

          • metricName (string) -- [REQUIRED]

            The CloudWatch metric name.

          • metricValue (string) -- [REQUIRED]

            The CloudWatch metric value.

          • metricUnit (string) -- [REQUIRED]

            The metric unit supported by CloudWatch.

          • metricTimestamp (string) --

            An optional Unix timestamp .

        • cloudwatchAlarm (dict) --

          Change the state of a CloudWatch alarm.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch alarm.

          • alarmName (string) -- [REQUIRED]

            The CloudWatch alarm name.

          • stateReason (string) -- [REQUIRED]

            The reason for the alarm change.

          • stateValue (string) -- [REQUIRED]

            The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

        • elasticsearch (dict) --

          Write data to an Amazon Elasticsearch Service domain.

          • roleArn (string) -- [REQUIRED]

            The IAM role ARN that has access to Elasticsearch.

          • endpoint (string) -- [REQUIRED]

            The endpoint of your Elasticsearch domain.

          • index (string) -- [REQUIRED]

            The Elasticsearch index where you want to store your data.

          • type (string) -- [REQUIRED]

            The type of document you are storing.

          • id (string) -- [REQUIRED]

            The unique identifier for the document you are storing.

        • salesforce (dict) --

          Send a message to a Salesforce IoT Cloud Input Stream.

          • token (string) -- [REQUIRED]

            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.

          • url (string) -- [REQUIRED]

            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.

    • ruleDisabled (boolean) --

      Specifies whether the rule is disabled.

    • awsIotSqlVersion (string) --

      The version of the SQL rules engine to use when evaluating the rule.

Returns

None

delete_authorizer(**kwargs)

Deletes an authorizer.

See also: AWS API Documentation

Request Syntax

response = client.delete_authorizer(
    authorizerName='string'
)
Parameters
authorizerName (string) --

[REQUIRED]

The name of the authorizer to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_ca_certificate(**kwargs)

Deletes a registered CA certificate.

See also: AWS API Documentation

Request Syntax

response = client.delete_ca_certificate(
    certificateId='string'
)
Parameters
certificateId (string) --

[REQUIRED]

The ID of the certificate to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    The output for the DeleteCACertificate operation.

delete_certificate(**kwargs)

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
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The ID of the certificate.

  • forceDelete (boolean) -- Forces a certificate request to be deleted.
Returns

None

delete_policy(**kwargs)

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'
)
Parameters
policyName (string) --

[REQUIRED]

The name of the policy to delete.

Returns
None
delete_policy_version(**kwargs)

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'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The name of the policy.

  • policyVersionId (string) --

    [REQUIRED]

    The policy version ID.

Returns

None

delete_registration_code()

Deletes a CA certificate registration code.

See also: AWS API Documentation

Request Syntax

response = client.delete_registration_code()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    The output for the DeleteRegistrationCode operation.

delete_role_alias(**kwargs)

Deletes a role alias

See also: AWS API Documentation

Request Syntax

response = client.delete_role_alias(
    roleAlias='string'
)
Parameters
roleAlias (string) --

[REQUIRED]

The role alias to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_thing(**kwargs)

Deletes the specified thing.

See also: AWS API Documentation

Request Syntax

response = client.delete_thing(
    thingName='string',
    expectedVersion=123
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing to delete.

  • expectedVersion (integer) -- The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException .
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The output of the DeleteThing operation.

delete_thing_group(**kwargs)

Deletes a thing group.

See also: AWS API Documentation

Request Syntax

response = client.delete_thing_group(
    thingGroupName='string',
    expectedVersion=123
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The name of the thing group to delete.

  • expectedVersion (integer) -- The expected version of the thing group to delete.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_thing_type(**kwargs)

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'
)
Parameters
thingTypeName (string) --

[REQUIRED]

The name of the thing type.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    The output for the DeleteThingType operation.

delete_topic_rule(**kwargs)

Deletes the rule.

See also: AWS API Documentation

Request Syntax

response = client.delete_topic_rule(
    ruleName='string'
)
Parameters
ruleName (string) --

[REQUIRED]

The name of the rule.

Returns
None
delete_v2_logging_level(**kwargs)

Deletes a logging level.

See also: AWS API Documentation

Request Syntax

response = client.delete_v2_logging_level(
    targetType='DEFAULT'|'THING_GROUP',
    targetName='string'
)
Parameters
  • targetType (string) --

    [REQUIRED]

    The type of resource for which you are configuring logging. Must be THING_Group .

  • targetName (string) --

    [REQUIRED]

    The name of the resource for which you are configuring logging.

Returns

None

deprecate_thing_type(**kwargs)

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
)
Parameters
  • thingTypeName (string) --

    [REQUIRED]

    The name of the thing type to deprecate.

  • undoDeprecate (boolean) -- Whether to undeprecate a deprecated thing type. If true , the thing type will not be deprecated anymore and you can associate it with things.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The output for the DeprecateThingType operation.

describe_authorizer(**kwargs)

Describes an authorizer.

See also: AWS API Documentation

Request Syntax

response = client.describe_authorizer(
    authorizerName='string'
)
Parameters
authorizerName (string) --

[REQUIRED]

The name of the authorizer to describe.

Return type
dict
Returns
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.

describe_ca_certificate(**kwargs)

Describes a registered CA certificate.

See also: AWS API Documentation

Request Syntax

response = client.describe_ca_certificate(
    certificateId='string'
)
Parameters
certificateId (string) --

[REQUIRED]

The CA certificate identifier.

Return type
dict
Returns
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.

describe_certificate(**kwargs)

Gets information about the specified certificate. You may specify the certificate using either its ID or PEM.

See also: AWS API Documentation

Request Syntax

response = client.describe_certificate(
    certificateId='string'
)
Parameters
certificateId (string) --

[REQUIRED]

The ID of the certificate.

Return type
dict
Returns
Response Syntax
{
    '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),
        'transferData': {
            'transferMessage': 'string',
            'rejectReason': 'string',
            'transferDate': datetime(2015, 1, 1),
            'acceptDate': datetime(2015, 1, 1),
            'rejectDate': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    The output of the DescribeCertificate operation.

    • certificateDescription (dict) --

      The description of the certificate.

      • certificateArn (string) --

        The ARN of the certificate.

      • certificateId (string) --

        The ID of the certificate.

      • caCertificateId (string) --

        The certificate ID of the CA certificate used to sign this certificate.

      • status (string) --

        The status of the certificate.

      • certificatePem (string) --

        The certificate data, in PEM format.

      • ownedBy (string) --

        The ID of the AWS account that owns the certificate.

      • previousOwnedBy (string) --

        The ID of the AWS account of the previous owner of the certificate.

      • creationDate (datetime) --

        The date and time the certificate was created.

      • lastModifiedDate (datetime) --

        The date and time the certificate was last modified.

      • transferData (dict) --

        The transfer data.

        • transferMessage (string) --

          The transfer message.

        • rejectReason (string) --

          The reason why the transfer was rejected.

        • transferDate (datetime) --

          The date the transfer took place.

        • acceptDate (datetime) --

          The date the transfer was accepted.

        • rejectDate (datetime) --

          The date the transfer was rejected.

describe_default_authorizer()

Describes the default authorizer.

See also: AWS API Documentation

Request Syntax

response = client.describe_default_authorizer()
Return type
dict
Returns
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.

describe_endpoint(**kwargs)

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'
)
Parameters
endpointType (string) -- The endpoint type.
Return type
dict
Returns
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.

describe_event_configurations()

Describes event configurations.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_configurations()
Return type
dict
Returns
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.

describe_index(**kwargs)

Describes a search index.

See also: AWS API Documentation

Request Syntax

response = client.describe_index(
    indexName='string'
)
Parameters
indexName (string) --

[REQUIRED]

The index name.

Return type
dict
Returns
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.
describe_job(**kwargs)

Describes a job.

See also: AWS API Documentation

Request Syntax

response = client.describe_job(
    jobId='string'
)
Parameters
jobId (string) --

[REQUIRED]

The unique identifier you assigned to this job when it was created.

Return type
dict
Returns
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) --
describe_job_execution(**kwargs)

Describes a job execution.

See also: AWS API Documentation

Request Syntax

response = client.describe_job_execution(
    jobId='string',
    thingName='string',
    executionNumber=123
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique identifier you assigned to this job when it was created.

  • thingName (string) --

    [REQUIRED]

    The name of the thing on which the job execution is running.

  • executionNumber (integer) -- A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.
Return type

dict

Returns

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.

describe_role_alias(**kwargs)

Describes a role alias.

See also: AWS API Documentation

Request Syntax

response = client.describe_role_alias(
    roleAlias='string'
)
Parameters
roleAlias (string) --

[REQUIRED]

The role alias to describe.

Return type
dict
Returns
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.

describe_thing(**kwargs)

Gets information about the specified thing.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing(
    thingName='string'
)
Parameters
thingName (string) --

[REQUIRED]

The name of the thing.

Return type
dict
Returns
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.

describe_thing_group(**kwargs)

Describe a thing group.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_group(
    thingGroupName='string'
)
Parameters
thingGroupName (string) --

[REQUIRED]

The name of the thing group.

Return type
dict
Returns
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.

describe_thing_registration_task(**kwargs)

Describes a bulk thing provisioning task.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_registration_task(
    taskId='string'
)
Parameters
taskId (string) --

[REQUIRED]

The task ID.

Return type
dict
Returns
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.

describe_thing_type(**kwargs)

Gets information about the specified thing type.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_type(
    thingTypeName='string'
)
Parameters
thingTypeName (string) --

[REQUIRED]

The name of the thing type.

Return type
dict
Returns
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.

detach_policy(**kwargs)

Detaches a policy from the specified target.

See also: AWS API Documentation

Request Syntax

response = client.detach_policy(
    policyName='string',
    target='string'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy to detach.

  • target (string) --

    [REQUIRED]

    The target from which the policy will be detached.

Returns

None

detach_principal_policy(**kwargs)

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'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The name of the policy to detach.

  • principal (string) --

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

Returns

None

detach_thing_principal(**kwargs)

Detaches the specified principal from the specified thing.

See also: AWS API Documentation

Request Syntax

response = client.detach_thing_principal(
    thingName='string',
    principal='string'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • principal (string) --

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The output from the DetachThingPrincipal operation.

disable_topic_rule(**kwargs)

Disables the rule.

See also: AWS API Documentation

Request Syntax

response = client.disable_topic_rule(
    ruleName='string'
)
Parameters
ruleName (string) --

[REQUIRED]

The name of the rule to disable.

Returns
None
enable_topic_rule(**kwargs)

Enables the rule.

See also: AWS API Documentation

Request Syntax

response = client.enable_topic_rule(
    ruleName='string'
)
Parameters
ruleName (string) --

[REQUIRED]

The name of the topic rule to enable.

Returns
None
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_effective_policies(**kwargs)

Gets effective policies.

See also: AWS API Documentation

Request Syntax

response = client.get_effective_policies(
    principal='string',
    cognitoIdentityPoolId='string',
    thingName='string'
)
Parameters
  • principal (string) -- The principal.
  • cognitoIdentityPoolId (string) -- The Cognito identity pool ID.
  • thingName (string) -- The thing name.
Return type

dict

Returns

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.

get_indexing_configuration()

Gets the search configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_indexing_configuration()
Return type
dict
Returns
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.
get_job_document(**kwargs)

Gets a job document.

See also: AWS API Documentation

Request Syntax

response = client.get_job_document(
    jobId='string'
)
Parameters
jobId (string) --

[REQUIRED]

The unique identifier you assigned to this job when it was created.

Return type
dict
Returns
Response Syntax
{
    'document': 'string'
}

Response Structure

  • (dict) --
    • document (string) --

      The job document content.

get_logging_options()

Gets the logging options.

See also: AWS API Documentation

Request Syntax

response = client.get_logging_options()
Return type
dict
Returns
Response Syntax
{
    'roleArn': 'string',
    'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
}

Response Structure

  • (dict) --

    The output from the GetLoggingOptions operation.

    • roleArn (string) --

      The ARN of the IAM role that grants access.

    • logLevel (string) --

      The logging level.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_policy(**kwargs)

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'
)
Parameters
policyName (string) --

[REQUIRED]

The name of the policy.

Return type
dict
Returns
Response Syntax
{
    'policyName': 'string',
    'policyArn': 'string',
    'policyDocument': 'string',
    'defaultVersionId': 'string'
}

Response Structure

  • (dict) --

    The output from the GetPolicy operation.

    • policyName (string) --

      The policy name.

    • policyArn (string) --

      The policy ARN.

    • policyDocument (string) --

      The JSON document that describes the policy.

    • defaultVersionId (string) --

      The default policy version ID.

get_policy_version(**kwargs)

Gets information about the specified policy version.

See also: AWS API Documentation

Request Syntax

response = client.get_policy_version(
    policyName='string',
    policyVersionId='string'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The name of the policy.

  • policyVersionId (string) --

    [REQUIRED]

    The policy version ID.

Return type

dict

Returns

Response Syntax

{
    'policyArn': 'string',
    'policyName': 'string',
    'policyDocument': 'string',
    'policyVersionId': 'string',
    'isDefaultVersion': True|False
}

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.

get_registration_code()

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()
Return type
dict
Returns
Response Syntax
{
    'registrationCode': 'string'
}

Response Structure

  • (dict) --

    The output from the GetRegistrationCode operation.

    • registrationCode (string) --

      The CA certificate registration code.

get_topic_rule(**kwargs)

Gets information about the rule.

See also: AWS API Documentation

Request Syntax

response = client.get_topic_rule(
    ruleName='string'
)
Parameters
ruleName (string) --

[REQUIRED]

The name of the rule.

Return type
dict
Returns
Response Syntax
{
    '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'
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string'
    }
}

Response Structure

  • (dict) --

    The output from the GetTopicRule operation.

    • ruleArn (string) --

      The rule ARN.

    • rule (dict) --

      The rule.

      • ruleName (string) --

        The name of the rule.

      • sql (string) --

        The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

      • description (string) --

        The description of the rule.

      • createdAt (datetime) --

        The date and time the rule was created.

      • actions (list) --

        The actions associated with the rule.

        • (dict) --

          Describes the actions associated with a rule.

          • dynamoDB (dict) --

            Write to a DynamoDB table.

            • tableName (string) --

              The name of the DynamoDB table.

            • roleArn (string) --

              The ARN of the IAM role that grants access to the DynamoDB table.

            • operation (string) --

              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 .

            • hashKeyField (string) --

              The hash key name.

            • hashKeyValue (string) --

              The hash key value.

            • hashKeyType (string) --

              The hash key type. Valid values are "STRING" or "NUMBER"

            • rangeKeyField (string) --

              The range key name.

            • rangeKeyValue (string) --

              The range key value.

            • rangeKeyType (string) --

              The range key type. Valid values are "STRING" or "NUMBER"

            • payloadField (string) --

              The action payload. This name can be customized.

          • dynamoDBv2 (dict) --

            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.

            • roleArn (string) --

              The ARN of the IAM role that grants access to the DynamoDB table.

            • putItem (dict) --

              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.

              • tableName (string) --

                The table where the message data will be written

          • lambda (dict) --

            Invoke a Lambda function.

            • functionArn (string) --

              The ARN of the Lambda function.

          • sns (dict) --

            Publish to an Amazon SNS topic.

            • targetArn (string) --

              The ARN of the SNS topic.

            • roleArn (string) --

              The ARN of the IAM role that grants access.

            • messageFormat (string) --

              The message format of the message to publish. Optional. 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.

          • sqs (dict) --

            Publish to an Amazon SQS queue.

            • roleArn (string) --

              The ARN of the IAM role that grants access.

            • queueUrl (string) --

              The URL of the Amazon SQS queue.

            • useBase64 (boolean) --

              Specifies whether to use Base64 encoding.

          • kinesis (dict) --

            Write data to an Amazon Kinesis stream.

            • roleArn (string) --

              The ARN of the IAM role that grants access to the Amazon Kinesis stream.

            • streamName (string) --

              The name of the Amazon Kinesis stream.

            • partitionKey (string) --

              The partition key.

          • republish (dict) --

            Publish to another MQTT topic.

            • roleArn (string) --

              The ARN of the IAM role that grants access.

            • topic (string) --

              The name of the MQTT topic.

          • s3 (dict) --

            Write to an Amazon S3 bucket.

            • roleArn (string) --

              The ARN of the IAM role that grants access.

            • bucketName (string) --

              The Amazon S3 bucket.

            • key (string) --

              The object key.

            • cannedAcl (string) --

              The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .

          • firehose (dict) --

            Write to an Amazon Kinesis Firehose stream.

            • roleArn (string) --

              The IAM role that grants access to the Amazon Kinesis Firehose stream.

            • deliveryStreamName (string) --

              The delivery stream name.

            • separator (string) --

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

          • cloudwatchMetric (dict) --

            Capture a CloudWatch metric.

            • roleArn (string) --

              The IAM role that allows access to the CloudWatch metric.

            • metricNamespace (string) --

              The CloudWatch metric namespace name.

            • metricName (string) --

              The CloudWatch metric name.

            • metricValue (string) --

              The CloudWatch metric value.

            • metricUnit (string) --

              The metric unit supported by CloudWatch.

            • metricTimestamp (string) --

              An optional Unix timestamp .

          • cloudwatchAlarm (dict) --

            Change the state of a CloudWatch alarm.

            • roleArn (string) --

              The IAM role that allows access to the CloudWatch alarm.

            • alarmName (string) --

              The CloudWatch alarm name.

            • stateReason (string) --

              The reason for the alarm change.

            • stateValue (string) --

              The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

          • elasticsearch (dict) --

            Write data to an Amazon Elasticsearch Service domain.

            • roleArn (string) --

              The IAM role ARN that has access to Elasticsearch.

            • endpoint (string) --

              The endpoint of your Elasticsearch domain.

            • index (string) --

              The Elasticsearch index where you want to store your data.

            • type (string) --

              The type of document you are storing.

            • id (string) --

              The unique identifier for the document you are storing.

          • salesforce (dict) --

            Send a message to a Salesforce IoT Cloud Input Stream.

            • token (string) --

              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.

            • url (string) --

              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.

      • ruleDisabled (boolean) --

        Specifies whether the rule is disabled.

      • awsIotSqlVersion (string) --

        The version of the SQL rules engine to use when evaluating the rule.

get_v2_logging_options()

Gets the fine grained logging options.

See also: AWS API Documentation

Request Syntax

response = client.get_v2_logging_options()
Return type
dict
Returns
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.

get_waiter(waiter_name)
list_attached_policies(**kwargs)

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
)
Parameters
  • target (string) --

    [REQUIRED]

    The group for which the policies will be listed.

  • recursive (boolean) -- When true, recursively list attached policies.
  • marker (string) -- The token to retrieve the next set of results.
  • pageSize (integer) -- The maximum number of results to be returned per request.
Return type

dict

Returns

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.

list_authorizers(**kwargs)

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'
)
Parameters
  • pageSize (integer) -- The maximum number of results to return at one time.
  • marker (string) -- A marker used to get the next set of results.
  • ascendingOrder (boolean) -- Return the list of authorizers in ascending alphabetical order.
  • status (string) -- The status of the list authorizers request.
Return type

dict

Returns

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.

list_ca_certificates(**kwargs)

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
)
Parameters
  • pageSize (integer) -- The result page size.
  • marker (string) -- The marker for the next set of results.
  • ascendingOrder (boolean) -- Determines the order of the results.
Return type

dict

Returns

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.

list_certificates(**kwargs)

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
)
Parameters
  • pageSize (integer) -- The result page size.
  • marker (string) -- The marker for the next set of results.
  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
Return type

dict

Returns

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.

        • 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_certificates_by_ca(**kwargs)

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
)
Parameters
  • caCertificateId (string) --

    [REQUIRED]

    The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

  • pageSize (integer) -- The result page size.
  • marker (string) -- The marker for the next set of results.
  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
Return type

dict

Returns

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.

        • 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_indices(**kwargs)

Lists the search indices.

See also: AWS API Documentation

Request Syntax

response = client.list_indices(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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.

list_job_executions_for_job(**kwargs)

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'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique identifier you assigned to this job when it was created.

  • status (string) -- The status of the job.
  • maxResults (integer) -- The maximum number of results to be returned per request.
  • nextToken (string) -- The token to retrieve the next set of results.
Return type

dict

Returns

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.

list_job_executions_for_thing(**kwargs)

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'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The thing name.

  • status (string) -- An optional filter that lets you search for jobs that have the specified status.
  • maxResults (integer) -- The maximum number of results to be returned per request.
  • nextToken (string) -- The token to retrieve the next set of results.
Return type

dict

Returns

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.

list_jobs(**kwargs)

Lists jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    status='IN_PROGRESS'|'CANCELED'|'COMPLETED',
    targetSelection='CONTINUOUS'|'SNAPSHOT',
    maxResults=123,
    nextToken='string',
    thingGroupName='string',
    thingGroupId='string'
)
Parameters
  • status (string) -- An optional filter that lets you search for jobs that have the specified status.
  • 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.
  • maxResults (integer) -- The maximum number of results to return per request.
  • nextToken (string) -- The token to retrieve the next set of results.
  • thingGroupName (string) -- A filter that limits the returned jobs to those for the specified group.
  • thingGroupId (string) -- A filter that limits the returned jobs to those for the specified group.
Return type

dict

Returns

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_outgoing_certificates(**kwargs)

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
)
Parameters
  • pageSize (integer) -- The result page size.
  • marker (string) -- The marker for the next set of results.
  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
Return type

dict

Returns

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.

list_policies(**kwargs)

Lists your policies.

See also: AWS API Documentation

Request Syntax

response = client.list_policies(
    marker='string',
    pageSize=123,
    ascendingOrder=True|False
)
Parameters
  • marker (string) -- The marker for the next set of results.
  • pageSize (integer) -- The result page size.
  • ascendingOrder (boolean) -- Specifies the order for results. If true, the results are returned in ascending creation order.
Return type

dict

Returns

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.

list_policy_principals(**kwargs)

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
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • marker (string) -- The marker for the next set of results.
  • pageSize (integer) -- The result page size.
  • ascendingOrder (boolean) -- Specifies the order for results. If true, the results are returned in ascending creation order.
Return type

dict

Returns

Response Syntax

{
    'principals': [
        'string',
    ],
    'nextMarker': 'string'
}

Response Structure

  • (dict) --

    The output from the ListPolicyPrincipals operation.

    • principals (list) --

      The descriptions of the principals.

      • (string) --
    • nextMarker (string) --

      The marker for the next set of results, or null if there are no additional results.

list_policy_versions(**kwargs)

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'
)
Parameters
policyName (string) --

[REQUIRED]

The policy name.

Return type
dict
Returns
Response Syntax
{
    'policyVersions': [
        {
            'versionId': 'string',
            'isDefaultVersion': True|False,
            'createDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    The output from the ListPolicyVersions operation.

    • policyVersions (list) --

      The policy versions.

      • (dict) --

        Describes a policy version.

        • versionId (string) --

          The policy version ID.

        • isDefaultVersion (boolean) --

          Specifies whether the policy version is the default.

        • createDate (datetime) --

          The date and time the policy was created.

list_principal_policies(**kwargs)

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
)
Parameters
  • principal (string) --

    [REQUIRED]

    The principal.

  • marker (string) -- The marker for the next set of results.
  • pageSize (integer) -- The result page size.
  • ascendingOrder (boolean) -- Specifies the order for results. If true, results are returned in ascending creation order.
Return type

dict

Returns

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.

list_principal_things(**kwargs)

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'
)
Parameters
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return in this operation.
  • principal (string) --

    [REQUIRED]

    The principal.

Return type

dict

Returns

Response Syntax

{
    'things': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The output from the ListPrincipalThings operation.

    • things (list) --

      The things.

      • (string) --
    • nextToken (string) --

      The token used to get the next set of results, or null if there are no additional results.

list_role_aliases(**kwargs)

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
)
Parameters
  • pageSize (integer) -- The maximum number of results to return at one time.
  • marker (string) -- A marker used to get the next set of results.
  • ascendingOrder (boolean) -- Return the list of role aliases in ascending alphabetical order.
Return type

dict

Returns

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.

list_targets_for_policy(**kwargs)

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
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • marker (string) -- A marker used to get the next set of results.
  • pageSize (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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.

list_thing_groups(**kwargs)

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
)
Parameters
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
  • parentGroup (string) -- A filter that limits the results to those with the specified parent group.
  • namePrefixFilter (string) -- A filter that limits the results to those with the specified name prefix.
  • recursive (boolean) -- If true, return child groups as well.
Return type

dict

Returns

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_thing_groups_for_thing(**kwargs)

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
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The thing name.

  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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_thing_principals(**kwargs)

Lists the principals associated with the specified thing.

See also: AWS API Documentation

Request Syntax

response = client.list_thing_principals(
    thingName='string'
)
Parameters
thingName (string) --

[REQUIRED]

The name of the thing.

Return type
dict
Returns
Response Syntax
{
    'principals': [
        'string',
    ]
}

Response Structure

  • (dict) --

    The output from the ListThingPrincipals operation.

    • principals (list) --

      The principals associated with the thing.

      • (string) --
list_thing_registration_task_reports(**kwargs)

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
)
Parameters
  • taskId (string) --

    [REQUIRED]

    The id of the task.

  • reportType (string) --

    [REQUIRED]

    The type of task report.

  • nextToken (string) -- The token to retrieve the next set of results.
  • maxResults (integer) -- The maximum number of results to return per request.
Return type

dict

Returns

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.

list_thing_registration_tasks(**kwargs)

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'
)
Parameters
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
  • status (string) -- The status of the bulk thing provisioning task.
Return type

dict

Returns

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.

list_thing_types(**kwargs)

Lists the existing thing types.

See also: AWS API Documentation

Request Syntax

response = client.list_thing_types(
    nextToken='string',
    maxResults=123,
    thingTypeName='string'
)
Parameters
  • nextToken (string) -- The token for the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return in this operation.
  • thingTypeName (string) -- The name of the thing type.
Return type

dict

Returns

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.

list_things(**kwargs)

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'
)
Parameters
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return in this operation.
  • attributeName (string) -- The attribute name used to search for things.
  • attributeValue (string) -- The attribute value used to search for things.
  • thingTypeName (string) -- The name of the thing type used to search for things.
Return type

dict

Returns

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.

list_things_in_thing_group(**kwargs)

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
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The thing group name.

  • recursive (boolean) -- When true, list things in this thing group and in all child groups as well.
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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.

list_topic_rules(**kwargs)

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
)
Parameters
  • topic (string) -- The topic.
  • maxResults (integer) -- The maximum number of results to return.
  • nextToken (string) -- A token used to retrieve the next value.
  • ruleDisabled (boolean) -- Specifies whether the rule is disabled.
Return type

dict

Returns

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.

list_v2_logging_levels(**kwargs)

Lists logging levels.

See also: AWS API Documentation

Request Syntax

response = client.list_v2_logging_levels(
    targetType='DEFAULT'|'THING_GROUP',
    nextToken='string',
    maxResults=123
)
Parameters
  • targetType (string) -- The type of resource for which you are configuring logging. Must be THING_Group .
  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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.

register_ca_certificate(**kwargs)

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'
    }
)
Parameters
  • caCertificate (string) --

    [REQUIRED]

    The CA certificate.

  • verificationCertificate (string) --

    [REQUIRED]

    The private key verification certificate.

  • setAsActive (boolean) -- A boolean value that specifies if the CA certificate is set to active.
  • allowAutoRegistration (boolean) -- Allows this CA certificate to be used for auto registration of device certificates.
  • registrationConfig (dict) --

    Information about the registration configuration.

    • templateBody (string) --

      The template body.

    • roleArn (string) --

      The ARN of the role.

Return type

dict

Returns

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.

register_certificate(**kwargs)

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'
)
Parameters
  • certificatePem (string) --

    [REQUIRED]

    The certificate data, in PEM format.

  • caCertificatePem (string) -- The CA certificate used to sign the device certificate being registered.
  • setAsActive (boolean) -- A boolean value that specifies if the CA certificate is set to active.
  • status (string) -- The status of the register certificate request.
Return type

dict

Returns

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.

register_thing(**kwargs)

Provisions a thing.

See also: AWS API Documentation

Request Syntax

response = client.register_thing(
    templateBody='string',
    parameters={
        'string': 'string'
    }
)
Parameters
  • templateBody (string) --

    [REQUIRED]

    The provisioning template.

  • parameters (dict) --

    The parameters for provisioning a thing.

    • (string) --
      • (string) --
Return type

dict

Returns

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

reject_certificate_transfer(**kwargs)

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'
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The ID of the certificate.

  • rejectReason (string) -- The reason the certificate transfer was rejected.
Returns

None

remove_thing_from_thing_group(**kwargs)

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'
)
Parameters
  • thingGroupName (string) -- The group name.
  • thingGroupArn (string) -- The group ARN.
  • thingName (string) -- The name of the thing to remove from the group.
  • thingArn (string) -- The ARN of the thing to remove from the group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

replace_topic_rule(**kwargs)

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'
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string'
    }
)
Parameters
  • ruleName (string) --

    [REQUIRED]

    The name of the rule.

  • topicRulePayload (dict) --

    [REQUIRED]

    The rule payload.

    • sql (string) -- [REQUIRED]

      The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

    • description (string) --

      The description of the rule.

    • actions (list) -- [REQUIRED]

      The actions associated with the rule.

      • (dict) --

        Describes the actions associated with a rule.

        • dynamoDB (dict) --

          Write to a DynamoDB table.

          • tableName (string) -- [REQUIRED]

            The name of the DynamoDB table.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access to the DynamoDB table.

          • operation (string) --

            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 .

          • hashKeyField (string) -- [REQUIRED]

            The hash key name.

          • hashKeyValue (string) -- [REQUIRED]

            The hash key value.

          • hashKeyType (string) --

            The hash key type. Valid values are "STRING" or "NUMBER"

          • rangeKeyField (string) --

            The range key name.

          • rangeKeyValue (string) --

            The range key value.

          • rangeKeyType (string) --

            The range key type. Valid values are "STRING" or "NUMBER"

          • payloadField (string) --

            The action payload. This name can be customized.

        • dynamoDBv2 (dict) --

          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.

          • roleArn (string) --

            The ARN of the IAM role that grants access to the DynamoDB table.

          • putItem (dict) --

            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.

            • tableName (string) -- [REQUIRED]

              The table where the message data will be written

        • lambda (dict) --

          Invoke a Lambda function.

          • functionArn (string) -- [REQUIRED]

            The ARN of the Lambda function.

        • sns (dict) --

          Publish to an Amazon SNS topic.

          • targetArn (string) -- [REQUIRED]

            The ARN of the SNS topic.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • messageFormat (string) --

            The message format of the message to publish. Optional. 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.

        • sqs (dict) --

          Publish to an Amazon SQS queue.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • queueUrl (string) -- [REQUIRED]

            The URL of the Amazon SQS queue.

          • useBase64 (boolean) --

            Specifies whether to use Base64 encoding.

        • kinesis (dict) --

          Write data to an Amazon Kinesis stream.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access to the Amazon Kinesis stream.

          • streamName (string) -- [REQUIRED]

            The name of the Amazon Kinesis stream.

          • partitionKey (string) --

            The partition key.

        • republish (dict) --

          Publish to another MQTT topic.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • topic (string) -- [REQUIRED]

            The name of the MQTT topic.

        • s3 (dict) --

          Write to an Amazon S3 bucket.

          • roleArn (string) -- [REQUIRED]

            The ARN of the IAM role that grants access.

          • bucketName (string) -- [REQUIRED]

            The Amazon S3 bucket.

          • key (string) -- [REQUIRED]

            The object key.

          • cannedAcl (string) --

            The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .

        • firehose (dict) --

          Write to an Amazon Kinesis Firehose stream.

          • roleArn (string) -- [REQUIRED]

            The IAM role that grants access to the Amazon Kinesis Firehose stream.

          • deliveryStreamName (string) -- [REQUIRED]

            The delivery stream name.

          • separator (string) --

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

        • cloudwatchMetric (dict) --

          Capture a CloudWatch metric.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch metric.

          • metricNamespace (string) -- [REQUIRED]

            The CloudWatch metric namespace name.

          • metricName (string) -- [REQUIRED]

            The CloudWatch metric name.

          • metricValue (string) -- [REQUIRED]

            The CloudWatch metric value.

          • metricUnit (string) -- [REQUIRED]

            The metric unit supported by CloudWatch.

          • metricTimestamp (string) --

            An optional Unix timestamp .

        • cloudwatchAlarm (dict) --

          Change the state of a CloudWatch alarm.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch alarm.

          • alarmName (string) -- [REQUIRED]

            The CloudWatch alarm name.

          • stateReason (string) -- [REQUIRED]

            The reason for the alarm change.

          • stateValue (string) -- [REQUIRED]

            The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

        • elasticsearch (dict) --

          Write data to an Amazon Elasticsearch Service domain.

          • roleArn (string) -- [REQUIRED]

            The IAM role ARN that has access to Elasticsearch.

          • endpoint (string) -- [REQUIRED]

            The endpoint of your Elasticsearch domain.

          • index (string) -- [REQUIRED]

            The Elasticsearch index where you want to store your data.

          • type (string) -- [REQUIRED]

            The type of document you are storing.

          • id (string) -- [REQUIRED]

            The unique identifier for the document you are storing.

        • salesforce (dict) --

          Send a message to a Salesforce IoT Cloud Input Stream.

          • token (string) -- [REQUIRED]

            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.

          • url (string) -- [REQUIRED]

            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.

    • ruleDisabled (boolean) --

      Specifies whether the rule is disabled.

    • awsIotSqlVersion (string) --

      The version of the SQL rules engine to use when evaluating the rule.

Returns

None

search_index(**kwargs)

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'
)
Parameters
  • indexName (string) -- The search index name.
  • queryString (string) --

    [REQUIRED]

    The search query string.

  • nextToken (string) -- The token used to get the next set of results, or null if there are no additional results.
  • maxResults (integer) -- The maximum number of results to return at one time.
  • queryVersion (string) -- The query version.
Return type

dict

Returns

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.

set_default_authorizer(**kwargs)

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'
)
Parameters
authorizerName (string) --

[REQUIRED]

The authorizer name.

Return type
dict
Returns
Response Syntax
{
    'authorizerName': 'string',
    'authorizerArn': 'string'
}

Response Structure

  • (dict) --
    • authorizerName (string) --

      The authorizer name.

    • authorizerArn (string) --

      The authorizer ARN.

set_default_policy_version(**kwargs)

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'
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • policyVersionId (string) --

    [REQUIRED]

    The policy version ID.

Returns

None

set_logging_options(**kwargs)

Sets the logging options.

See also: AWS API Documentation

Request Syntax

response = client.set_logging_options(
    loggingOptionsPayload={
        'roleArn': 'string',
        'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
    }
)
Parameters
loggingOptionsPayload (dict) --

[REQUIRED]

The logging options payload.

  • roleArn (string) -- [REQUIRED]

    The ARN of the IAM role that grants access.

  • logLevel (string) --

    The log level.

Returns
None
set_v2_logging_level(**kwargs)

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'
)
Parameters
  • logTarget (dict) --

    [REQUIRED]

    The log target.

    • targetType (string) -- [REQUIRED]

      The target type.

    • targetName (string) --

      The target name.

  • logLevel (string) --

    [REQUIRED]

    The log level.

Returns

None

set_v2_logging_options(**kwargs)

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
)
Parameters
  • roleArn (string) -- The role ARN that allows IoT to write to Cloudwatch logs.
  • defaultLogLevel (string) -- The default logging level.
  • disableAllLogs (boolean) -- Set to true to disable all logs, otherwise set to false.
Returns

None

start_thing_registration_task(**kwargs)

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'
)
Parameters
  • templateBody (string) --

    [REQUIRED]

    The provisioning template.

  • inputFileBucket (string) --

    [REQUIRED]

    The S3 bucket that contains the input file.

  • inputFileKey (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).

  • roleArn (string) --

    [REQUIRED]

    The IAM role ARN that grants permission the input file.

Return type

dict

Returns

Response Syntax

{
    'taskId': 'string'
}

Response Structure

  • (dict) --

    • taskId (string) --

      The bulk thing provisioning task ID.

stop_thing_registration_task(**kwargs)

Cancels a bulk thing provisioning task.

See also: AWS API Documentation

Request Syntax

response = client.stop_thing_registration_task(
    taskId='string'
)
Parameters
taskId (string) --

[REQUIRED]

The bulk thing provisioning task ID.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
test_authorization(**kwargs)

Test custom authorization.

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',
    ]
)
Parameters
  • principal (string) -- The principal.
  • cognitoIdentityPoolId (string) -- The Cognito identity pool ID.
  • authInfos (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) --
  • clientId (string) -- The MQTT client ID.
  • policyNamesToAdd (list) --

    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

    • (string) --
  • policyNamesToSkip (list) --

    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

    • (string) --
Return type

dict

Returns

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

test_invoke_authorizer(**kwargs)

Invoke the specified custom authorizer for testing purposes.

See also: AWS API Documentation

Request Syntax

response = client.test_invoke_authorizer(
    authorizerName='string',
    token='string',
    tokenSignature='string'
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The custom authorizer name.

  • token (string) --

    [REQUIRED]

    The token returned by your custom authentication service.

  • tokenSignature (string) --

    [REQUIRED]

    The signature made with the token and your custom authentication service's private key.

Return type

dict

Returns

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.

transfer_certificate(**kwargs)

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'
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The ID of the certificate.

  • targetAwsAccount (string) --

    [REQUIRED]

    The AWS account.

  • transferMessage (string) -- The transfer message.
Return type

dict

Returns

Response Syntax

{
    'transferredCertificateArn': 'string'
}

Response Structure

  • (dict) --

    The output from the TransferCertificate operation.

    • transferredCertificateArn (string) --

      The ARN of the certificate.

update_authorizer(**kwargs)

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'
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The authorizer name.

  • authorizerFunctionArn (string) -- The ARN of the authorizer's Lambda function.
  • tokenKeyName (string) -- The key used to extract the token from the HTTP headers.
  • tokenSigningPublicKeys (dict) --

    The public keys used to verify the token signature.

    • (string) --
      • (string) --
  • status (string) -- The status of the update authorizer request.
Return type

dict

Returns

Response Syntax

{
    'authorizerName': 'string',
    'authorizerArn': 'string'
}

Response Structure

  • (dict) --

    • authorizerName (string) --

      The authorizer name.

    • authorizerArn (string) --

      The authorizer ARN.

update_ca_certificate(**kwargs)

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
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The CA certificate identifier.

  • newStatus (string) --

    The updated status of the CA certificate.

    Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
  • newAutoRegistrationStatus (string) -- The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
  • registrationConfig (dict) --

    Information about the registration configuration.

    • templateBody (string) --

      The template body.

    • roleArn (string) --

      The ARN of the role.

  • removeAutoRegistration (boolean) -- If true, remove auto registration.
Returns

None

update_certificate(**kwargs)

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'
)
Parameters
  • certificateId (string) --

    [REQUIRED]

    The ID of the certificate.

  • newStatus (string) --

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

Returns

None

update_event_configurations(**kwargs)

Updates the event configurations.

See also: AWS API Documentation

Request Syntax

response = client.update_event_configurations(
    eventConfigurations={
        'string': {
            'Enabled': True|False
        }
    }
)
Parameters
eventConfigurations (dict) --

The new event configuration values.

  • (string) --
    • (dict) --

      Configuration.

      • Enabled (boolean) --

        True to enable the configuration.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
update_indexing_configuration(**kwargs)

Updates the search configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_indexing_configuration(
    thingIndexingConfiguration={
        'thingIndexingMode': 'OFF'|'REGISTRY'|'REGISTRY_AND_SHADOW'
    }
)
Parameters
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.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
update_role_alias(**kwargs)

Updates a role alias.

See also: AWS API Documentation

Request Syntax

response = client.update_role_alias(
    roleAlias='string',
    roleArn='string',
    credentialDurationSeconds=123
)
Parameters
  • roleAlias (string) --

    [REQUIRED]

    The role alias to update.

  • roleArn (string) -- The role ARN.
  • credentialDurationSeconds (integer) -- The number of seconds the credential will be valid.
Return type

dict

Returns

Response Syntax

{
    'roleAlias': 'string',
    'roleAliasArn': 'string'
}

Response Structure

  • (dict) --

    • roleAlias (string) --

      The role alias.

    • roleAliasArn (string) --

      The role alias ARN.

update_thing(**kwargs)

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
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing to update.

  • thingTypeName (string) -- The name of the thing type.
  • attributePayload (dict) --

    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.

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

  • expectedVersion (integer) -- The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException .
  • removeThingType (boolean) -- Remove a thing type association. If true , the association is removed.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The output from the UpdateThing operation.

update_thing_group(**kwargs)

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
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The thing group to update.

  • thingGroupProperties (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 .

  • expectedVersion (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.
Return type

dict

Returns

Response Syntax

{
    'version': 123
}

Response Structure

  • (dict) --

    • version (integer) --

      The version of the updated thing group.

update_thing_groups_for_thing(**kwargs)

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',
    ]
)
Parameters
  • thingName (string) -- The thing whose group memberships will be updated.
  • thingGroupsToAdd (list) --

    The groups to which the thing will be added.

    • (string) --
  • thingGroupsToRemove (list) --

    The groups from which the thing will be removed.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are:

class IoT.Paginator.ListCACertificates
paginator = client.get_paginator('list_ca_certificates')
paginate(**kwargs)

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'
    }
)
Parameters
  • ascendingOrder (boolean) -- Determines the order of the results.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class IoT.Paginator.ListCertificates
paginator = client.get_paginator('list_certificates')
paginate(**kwargs)

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'
    }
)
Parameters
  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

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

class IoT.Paginator.ListCertificatesByCA
paginator = client.get_paginator('list_certificates_by_ca')
paginate(**kwargs)

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'
    }
)
Parameters
  • caCertificateId (string) --

    [REQUIRED]

    The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

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

class IoT.Paginator.ListOutgoingCertificates
paginator = client.get_paginator('list_outgoing_certificates')
paginate(**kwargs)

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'
    }
)
Parameters
  • ascendingOrder (boolean) -- Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class IoT.Paginator.ListPolicies
paginator = client.get_paginator('list_policies')
paginate(**kwargs)

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'
    }
)
Parameters
  • ascendingOrder (boolean) -- Specifies the order for results. If true, the results are returned in ascending creation order.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class IoT.Paginator.ListPolicyPrincipals
paginator = client.get_paginator('list_policy_principals')
paginate(**kwargs)

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'
    }
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • ascendingOrder (boolean) -- Specifies the order for results. If true, the results are returned in ascending creation order.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'principals': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The output from the ListPolicyPrincipals operation.

    • principals (list) --

      The descriptions of the principals.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListPrincipalPolicies
paginator = client.get_paginator('list_principal_policies')
paginate(**kwargs)

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'
    }
)
Parameters
  • principal (string) --

    [REQUIRED]

    The principal.

  • ascendingOrder (boolean) -- Specifies the order for results. If true, results are returned in ascending creation order.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class IoT.Paginator.ListPrincipalThings
paginator = client.get_paginator('list_principal_things')
paginate(**kwargs)

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'
    }
)
Parameters
  • principal (string) --

    [REQUIRED]

    The principal.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'things': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The output from the ListPrincipalThings operation.

    • things (list) --

      The things.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListThingTypes
paginator = client.get_paginator('list_thing_types')
paginate(**kwargs)

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'
    }
)
Parameters
  • thingTypeName (string) -- The name of the thing type.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      A token to resume pagination.

class IoT.Paginator.ListThings
paginator = client.get_paginator('list_things')
paginate(**kwargs)

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'
    }
)
Parameters
  • attributeName (string) -- The attribute name used to search for things.
  • attributeValue (string) -- The attribute value used to search for things.
  • thingTypeName (string) -- The name of the thing type used to search for things.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      A token to resume pagination.

class IoT.Paginator.ListTopicRules
paginator = client.get_paginator('list_topic_rules')
paginate(**kwargs)

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'
    }
)
Parameters
  • topic (string) -- The topic.
  • ruleDisabled (boolean) -- Specifies whether the rule is disabled.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.