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. (The last part of the certificate ARN contains the certificate ID.)

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

None

add_thing_to_billing_group(**kwargs)

Adds a thing to a billing group.

See also: AWS API Documentation

Request Syntax

response = client.add_thing_to_billing_group(
    billingGroupName='string',
    billingGroupArn='string',
    thingName='string',
    thingArn='string'
)
Parameters
  • billingGroupName (string) -- The name of the billing group.
  • billingGroupArn (string) -- The ARN of the billing group.
  • thingName (string) -- The name of the thing to be added to the billing group.
  • thingArn (string) -- The ARN of the thing to be added to the billing group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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',
    overrideDynamicGroups=True|False
)
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.
  • overrideDynamicGroups (boolean) -- Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
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_security_profile(**kwargs)

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

See also: AWS API Documentation

Request Syntax

response = client.attach_security_profile(
    securityProfileName='string',
    securityProfileTargetArn='string'
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The security profile that is attached.

  • securityProfileTargetArn (string) --

    [REQUIRED]

    The ARN of the target (thing group) to which the security profile is attached.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

attach_thing_principal(**kwargs)

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

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, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

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

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The unique identifier for the task that you want to cancel.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
cancel_audit_task(**kwargs)

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
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. (The last part of the certificate ARN contains the certificate ID.)

Returns
None
cancel_job(**kwargs)

Cancels a job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job(
    jobId='string',
    reasonCode='string',
    comment='string',
    force=True|False
)
Parameters
  • jobId (string) --

    [REQUIRED]

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

  • reasonCode (string) -- (Optional)A reason code string that explains why the job was canceled.
  • comment (string) -- An optional comment string describing why the job was canceled.
  • force (boolean) --

    (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false .

    Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

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.

cancel_job_execution(**kwargs)

Cancels the execution of a job for a given thing.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job_execution(
    jobId='string',
    thingName='string',
    force=True|False,
    expectedVersion=123,
    statusDetails={
        'string': 'string'
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job to be canceled.

  • thingName (string) --

    [REQUIRED]

    The name of the thing whose execution of the job will be canceled.

  • force (boolean) --

    (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true , then an InvalidStateTransitionException will be thrown. The default is false .

    Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

  • expectedVersion (integer) -- (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
  • statusDetails (dict) --

    A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

    • (string) --
      • (string) --
Returns

None

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

Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

See also: AWS API Documentation

Request Syntax

response = client.confirm_topic_rule_destination(
    confirmationToken='string'
)
Parameters
confirmationToken (string) --

[REQUIRED]

The token used to confirm ownership or access to the topic rule confirmation URL.

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',
    signingDisabled=True|False
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The authorizer name.

  • authorizerFunctionArn (string) --

    [REQUIRED]

    The ARN of the authorizer's Lambda function.

  • tokenKeyName (string) -- The name of the token key used to extract the token from the HTTP headers.
  • tokenSigningPublicKeys (dict) --

    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.
  • signingDisabled (boolean) -- Specifies whether AWS IoT validates the token signature in an authorization 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_billing_group(**kwargs)

Creates a billing group.

See also: AWS API Documentation

Request Syntax

response = client.create_billing_group(
    billingGroupName='string',
    billingGroupProperties={
        'billingGroupDescription': 'string'
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • billingGroupName (string) --

    [REQUIRED]

    The name you wish to give to the billing group.

  • billingGroupProperties (dict) --

    The properties of the billing group.

    • billingGroupDescription (string) --

      The description of the billing group.

  • tags (list) --

    Metadata which can be used to manage the billing group.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'billingGroupName': 'string',
    'billingGroupArn': 'string',
    'billingGroupId': 'string'
}

Response Structure

  • (dict) --

    • billingGroupName (string) --

      The name you gave to the billing group.

    • billingGroupArn (string) --

      The ARN of the billing group.

    • billingGroupId (string) --

      The ID of the billing group.

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

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

See also: AWS API Documentation

Request Syntax

response = client.create_dimension(
    name='string',
    type='TOPIC_FILTER',
    stringValues=[
        'string',
    ],
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    clientRequestToken='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

  • type (string) --

    [REQUIRED]

    Specifies the type of dimension. Supported types: TOPIC_FILTER.

  • stringValues (list) --

    [REQUIRED]

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

    • (string) --
  • tags (list) --

    Metadata that can be used to manage the dimension.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

  • clientRequestToken (string) --

    [REQUIRED]

    Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'name': 'string',
    'arn': 'string'
}

Response Structure

  • (dict) --

    • name (string) --

      A unique identifier for the dimension.

    • arn (string) --

      The ARN (Amazon resource name) of the created dimension.

create_domain_configuration(**kwargs)

Creates a domain configuration.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

Request Syntax

response = client.create_domain_configuration(
    domainConfigurationName='string',
    domainName='string',
    serverCertificateArns=[
        'string',
    ],
    validationCertificateArn='string',
    authorizerConfig={
        'defaultAuthorizerName': 'string',
        'allowAuthorizerOverride': True|False
    },
    serviceType='DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
)
Parameters
  • domainConfigurationName (string) --

    [REQUIRED]

    The name of the domain configuration. This value must be unique to a region.

  • domainName (string) -- The name of the domain.
  • serverCertificateArns (list) --

    The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.

    • (string) --
  • validationCertificateArn (string) -- The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.
  • authorizerConfig (dict) --

    An object that specifies the authorization service for a domain.

    • defaultAuthorizerName (string) --

      The name of the authorization service for a domain configuration.

    • allowAuthorizerOverride (boolean) --

      A Boolean that specifies whether the domain configuration's authorization service can be overridden.

  • serviceType (string) -- The type of service delivered by the endpoint.
Return type

dict

Returns

Response Syntax

{
    'domainConfigurationName': 'string',
    'domainConfigurationArn': 'string'
}

Response Structure

  • (dict) --

    • domainConfigurationName (string) --

      The name of the domain configuration.

    • domainConfigurationArn (string) --

      The ARN of the domain configuration.

create_dynamic_thing_group(**kwargs)

Creates a dynamic thing group.

See also: AWS API Documentation

Request Syntax

response = client.create_dynamic_thing_group(
    thingGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    indexName='string',
    queryString='string',
    queryVersion='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The dynamic thing group name to create.

  • thingGroupProperties (dict) --

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

  • indexName (string) --

    The dynamic thing group index name.

    Note

    Currently one index is supported: "AWS_Things".

  • queryString (string) --

    [REQUIRED]

    The dynamic thing group search query string.

    See Query Syntax for information about query string syntax.

  • queryVersion (string) --

    The dynamic thing group query version.

    Note

    Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

  • tags (list) --

    Metadata which can be used to manage the dynamic thing group.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'thingGroupName': 'string',
    'thingGroupArn': 'string',
    'thingGroupId': 'string',
    'indexName': 'string',
    'queryString': 'string',
    'queryVersion': 'string'
}

Response Structure

  • (dict) --

    • thingGroupName (string) --

      The dynamic thing group name.

    • thingGroupArn (string) --

      The dynamic thing group ARN.

    • thingGroupId (string) --

      The dynamic thing group ID.

    • indexName (string) --

      The dynamic thing group index name.

    • queryString (string) --

      The dynamic thing group search query string.

    • queryVersion (string) --

      The dynamic thing group query version.

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,
        'exponentialRate': {
            'baseRatePerMinute': 123,
            'incrementFactor': 123.0,
            'rateIncreaseCriteria': {
                'numberOfNotifiedThings': 123,
                'numberOfSucceededThings': 123
            }
        }
    },
    abortConfig={
        'criteriaList': [
            {
                'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
                'action': 'CANCEL',
                'thresholdPercentage': 123.0,
                'minNumberOfExecutedThings': 123
            },
        ]
    },
    timeoutConfig={
        'inProgressTimeoutInMinutes': 123
    },
    tags=[
        {
            'Key': 'string',
            'Value': '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.

    Note

    If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

    The placeholder link is of the following form:

    ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/*bucket* /*key* }

    where bucket is your bucket name and key is the object in the bucket to which you are linking.

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

    • exponentialRate (dict) --

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

      • baseRatePerMinute (integer) -- [REQUIRED]

        The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

      • incrementFactor (float) -- [REQUIRED]

        The exponential factor to increase the rate of rollout for a job.

      • rateIncreaseCriteria (dict) -- [REQUIRED]

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

        AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

        • numberOfNotifiedThings (integer) --

          The threshold for number of notified things that will initiate the increase in rate of rollout.

        • numberOfSucceededThings (integer) --

          The threshold for number of succeeded things that will initiate the increase in rate of rollout.

  • abortConfig (dict) --

    Allows you to create criteria to abort a job.

    • criteriaList (list) -- [REQUIRED]

      The list of abort criteria to define rules to abort the job.

      • (dict) --

        Details of abort criteria to define rules to abort the job.

        • failureType (string) -- [REQUIRED]

          The type of job execution failure to define a rule to initiate a job abort.

        • action (string) -- [REQUIRED]

          The type of abort action to initiate a job abort.

        • thresholdPercentage (float) -- [REQUIRED]

          The threshold as a percentage of the total number of executed things that will initiate a job abort.

          AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

        • minNumberOfExecutedThings (integer) -- [REQUIRED]

          Minimum number of executed things before evaluating an abort rule.

  • timeoutConfig (dict) --

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

    • inProgressTimeoutInMinutes (integer) --

      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

  • tags (list) --

    Metadata which can be used to manage the job.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

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. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API .

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

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.

See also: AWS API Documentation

Request Syntax

response = client.create_mitigation_action(
    actionName='string',
    roleArn='string',
    actionParams={
        'updateDeviceCertificateParams': {
            'action': 'DEACTIVATE'
        },
        'updateCACertificateParams': {
            'action': 'DEACTIVATE'
        },
        'addThingsToThingGroupParams': {
            'thingGroupNames': [
                'string',
            ],
            'overrideDynamicGroups': True|False
        },
        'replaceDefaultPolicyVersionParams': {
            'templateName': 'BLANK_POLICY'
        },
        'enableIoTLoggingParams': {
            'roleArnForLogging': 'string',
            'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
        },
        'publishFindingToSnsParams': {
            'topicArn': 'string'
        }
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • actionName (string) --

    [REQUIRED]

    A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction ).

  • roleArn (string) --

    [REQUIRED]

    The ARN of the IAM role that is used to apply the mitigation action.

  • actionParams (dict) --

    [REQUIRED]

    Defines the type of action and the parameters for that action.

    • updateDeviceCertificateParams (dict) --

      Parameters to define a mitigation action that changes the state of the device certificate to inactive.

      • action (string) -- [REQUIRED]

        The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE .

    • updateCACertificateParams (dict) --

      Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

      • action (string) -- [REQUIRED]

        The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE .

    • addThingsToThingGroupParams (dict) --

      Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

      • thingGroupNames (list) -- [REQUIRED]

        The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.

        • (string) --
      • overrideDynamicGroups (boolean) --

        Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.

    • replaceDefaultPolicyVersionParams (dict) --

      Parameters to define a mitigation action that adds a blank policy to restrict permissions.

      • templateName (string) -- [REQUIRED]

        The name of the template to be applied. The only supported value is BLANK_POLICY .

    • enableIoTLoggingParams (dict) --

      Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

      • roleArnForLogging (string) -- [REQUIRED]

        The ARN of the IAM role used for logging.

      • logLevel (string) -- [REQUIRED]

        Specifies the types of information to be logged.

    • publishFindingToSnsParams (dict) --

      Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

      • topicArn (string) -- [REQUIRED]

        The ARN of the topic to which you want to publish the findings.

  • tags (list) --

    Metadata that can be used to manage the mitigation action.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'actionArn': 'string',
    'actionId': 'string'
}

Response Structure

  • (dict) --

    • actionArn (string) --

      The ARN for the new mitigation action.

    • actionId (string) --

      A unique identifier for the new mitigation action.

create_ota_update(**kwargs)

Creates an AWS IoT OTAUpdate on a target group of things or groups.

See also: AWS API Documentation

Request Syntax

response = client.create_ota_update(
    otaUpdateId='string',
    description='string',
    targets=[
        'string',
    ],
    protocols=[
        'MQTT'|'HTTP',
    ],
    targetSelection='CONTINUOUS'|'SNAPSHOT',
    awsJobExecutionsRolloutConfig={
        'maximumPerMinute': 123
    },
    awsJobPresignedUrlConfig={
        'expiresInSec': 123
    },
    files=[
        {
            'fileName': 'string',
            'fileVersion': 'string',
            'fileLocation': {
                'stream': {
                    'streamId': 'string',
                    'fileId': 123
                },
                's3Location': {
                    'bucket': 'string',
                    'key': 'string',
                    'version': 'string'
                }
            },
            'codeSigning': {
                'awsSignerJobId': 'string',
                'startSigningJobParameter': {
                    'signingProfileParameter': {
                        'certificateArn': 'string',
                        'platform': 'string',
                        'certificatePathOnDevice': 'string'
                    },
                    'signingProfileName': 'string',
                    'destination': {
                        's3Destination': {
                            'bucket': 'string',
                            'prefix': 'string'
                        }
                    }
                },
                'customCodeSigning': {
                    'signature': {
                        'inlineDocument': b'bytes'
                    },
                    'certificateChain': {
                        'certificateName': 'string',
                        'inlineDocument': 'string'
                    },
                    'hashAlgorithm': 'string',
                    'signatureAlgorithm': 'string'
                }
            },
            'attributes': {
                'string': 'string'
            }
        },
    ],
    roleArn='string',
    additionalParameters={
        'string': 'string'
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • otaUpdateId (string) --

    [REQUIRED]

    The ID of the OTA update to be created.

  • description (string) -- The description of the OTA update.
  • targets (list) --

    [REQUIRED]

    The targeted devices to receive OTA updates.

    • (string) --
  • protocols (list) --

    The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

    • (string) --
  • targetSelection (string) -- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
  • awsJobExecutionsRolloutConfig (dict) --

    Configuration for the rollout of OTA updates.

    • maximumPerMinute (integer) --

      The maximum number of OTA update job executions started per minute.

  • awsJobPresignedUrlConfig (dict) --

    Configuration information for pre-signed URLs.

    • expiresInSec (integer) --

      How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

  • files (list) --

    [REQUIRED]

    The files to be streamed by the OTA update.

    • (dict) --

      Describes a file to be associated with an OTA update.

      • fileName (string) --

        The name of the file.

      • fileVersion (string) --

        The file version.

      • fileLocation (dict) --

        The location of the updated firmware.

        • stream (dict) --

          The stream that contains the OTA update.

          • streamId (string) --

            The stream ID.

          • fileId (integer) --

            The ID of a file associated with a stream.

        • s3Location (dict) --

          The location of the updated firmware in S3.

          • bucket (string) --

            The S3 bucket.

          • key (string) --

            The S3 key.

          • version (string) --

            The S3 bucket version.

      • codeSigning (dict) --

        The code signing method of the file.

        • awsSignerJobId (string) --

          The ID of the AWSSignerJob which was created to sign the file.

        • startSigningJobParameter (dict) --

          Describes the code-signing job.

          • signingProfileParameter (dict) --

            Describes the code-signing profile.

            • certificateArn (string) --

              Certificate ARN.

            • platform (string) --

              The hardware platform of your device.

            • certificatePathOnDevice (string) --

              The location of the code-signing certificate on your device.

          • signingProfileName (string) --

            The code-signing profile name.

          • destination (dict) --

            The location to write the code-signed file.

            • s3Destination (dict) --

              Describes the location in S3 of the updated firmware.

              • bucket (string) --

                The S3 bucket that contains the updated firmware.

              • prefix (string) --

                The S3 prefix.

        • customCodeSigning (dict) --

          A custom method for code signing a file.

          • signature (dict) --

            The signature for the file.

            • inlineDocument (bytes) --

              A base64 encoded binary representation of the code signing signature.

          • certificateChain (dict) --

            The certificate chain.

            • certificateName (string) --

              The name of the certificate.

            • inlineDocument (string) --

              A base64 encoded binary representation of the code signing certificate chain.

          • hashAlgorithm (string) --

            The hash algorithm used to code sign the file.

          • signatureAlgorithm (string) --

            The signature algorithm used to code sign the file.

      • attributes (dict) --

        A list of name/attribute pairs.

        • (string) --
          • (string) --
  • roleArn (string) --

    [REQUIRED]

    The IAM role that allows access to the AWS IoT Jobs service.

  • additionalParameters (dict) --

    A list of additional OTA update parameters which are name-value pairs.

    • (string) --
      • (string) --
  • tags (list) --

    Metadata which can be used to manage updates.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'otaUpdateId': 'string',
    'awsIotJobId': 'string',
    'otaUpdateArn': 'string',
    'awsIotJobArn': 'string',
    'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
}

Response Structure

  • (dict) --

    • otaUpdateId (string) --

      The OTA update ID.

    • awsIotJobId (string) --

      The AWS IoT job ID associated with the OTA update.

    • otaUpdateArn (string) --

      The OTA update ARN.

    • awsIotJobArn (string) --

      The AWS IoT job ARN associated with the OTA update.

    • otaUpdateStatus (string) --

      The OTA update status.

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

Creates a provisioning claim.

See also: AWS API Documentation

Request Syntax

response = client.create_provisioning_claim(
    templateName='string'
)
Parameters
templateName (string) --

[REQUIRED]

The name of the provisioning template to use.

Return type
dict
Returns
Response Syntax
{
    'certificateId': 'string',
    'certificatePem': 'string',
    'keyPair': {
        'PublicKey': 'string',
        'PrivateKey': 'string'
    },
    'expiration': datetime(2015, 1, 1)
}

Response Structure

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

      The ID of the certificate.

    • certificatePem (string) --

      The provisioning claim certificate.

    • keyPair (dict) --

      The provisioning claim key pair.

      • PublicKey (string) --

        The public key.

      • PrivateKey (string) --

        The private key.

    • expiration (datetime) --

      The provisioning claim expiration time.

create_provisioning_template(**kwargs)

Creates a fleet provisioning template.

See also: AWS API Documentation

Request Syntax

response = client.create_provisioning_template(
    templateName='string',
    description='string',
    templateBody='string',
    enabled=True|False,
    provisioningRoleArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The name of the fleet provisioning template.

  • description (string) -- The description of the fleet provisioning template.
  • templateBody (string) --

    [REQUIRED]

    The JSON formatted contents of the fleet provisioning template.

  • enabled (boolean) -- True to enable the fleet provisioning template, otherwise false.
  • provisioningRoleArn (string) --

    [REQUIRED]

    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

  • tags (list) --

    Metadata which can be used to manage the fleet provisioning template.

    Note

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'templateArn': 'string',
    'templateName': 'string',
    'defaultVersionId': 123
}

Response Structure

  • (dict) --

    • templateArn (string) --

      The ARN that identifies the provisioning template.

    • templateName (string) --

      The name of the fleet provisioning template.

    • defaultVersionId (integer) --

      The default version of the fleet provisioning template.

create_provisioning_template_version(**kwargs)

Creates a new version of a fleet provisioning template.

See also: AWS API Documentation

Request Syntax

response = client.create_provisioning_template_version(
    templateName='string',
    templateBody='string',
    setAsDefault=True|False
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The name of the fleet provisioning template.

  • templateBody (string) --

    [REQUIRED]

    The JSON formatted contents of the fleet provisioning template.

  • setAsDefault (boolean) -- Sets a fleet provision template version as the default version.
Return type

dict

Returns

Response Syntax

{
    'templateArn': 'string',
    'templateName': 'string',
    'versionId': 123,
    'isDefaultVersion': True|False
}

Response Structure

  • (dict) --

    • templateArn (string) --

      The ARN that identifies the provisioning template.

    • templateName (string) --

      The name of the fleet provisioning template.

    • versionId (integer) --

      The version of the fleet provisioning template.

    • isDefaultVersion (boolean) --

      True if the fleet provisioning template version is the default version, otherwise false.

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

Creates a scheduled audit that is run at a specified time interval.

See also: AWS API Documentation

Request Syntax

response = client.create_scheduled_audit(
    frequency='DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
    dayOfMonth='string',
    dayOfWeek='SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
    targetCheckNames=[
        'string',
    ],
    scheduledAuditName='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • frequency (string) --

    [REQUIRED]

    How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.

  • dayOfMonth (string) -- The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
  • dayOfWeek (string) -- The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
  • targetCheckNames (list) --

    [REQUIRED]

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    • (string) --

      An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • scheduledAuditName (string) --

    [REQUIRED]

    The name you want to give to the scheduled audit. (Max. 128 chars)

  • tags (list) --

    Metadata that can be used to manage the scheduled audit.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'scheduledAuditArn': 'string'
}

Response Structure

  • (dict) --

    • scheduledAuditArn (string) --

      The ARN of the scheduled audit.

create_security_profile(**kwargs)

Creates a Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.create_security_profile(
    securityProfileName='string',
    securityProfileDescription='string',
    behaviors=[
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                }
            }
        },
    ],
    alertTargets={
        'string': {
            'alertTargetArn': 'string',
            'roleArn': 'string'
        }
    },
    additionalMetricsToRetain=[
        'string',
    ],
    additionalMetricsToRetainV2=[
        {
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            }
        },
    ],
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The name you are giving to the security profile.

  • securityProfileDescription (string) -- A description of the security profile.
  • behaviors (list) --

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

    • (dict) --

      A Device Defender security profile behavior.

      • name (string) -- [REQUIRED]

        The name you have given to the behavior.

      • metric (string) --

        What is measured by the behavior.

      • metricDimension (dict) --

        The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

        • dimensionName (string) -- [REQUIRED]

          A unique identifier for the dimension.

        • operator (string) --

          Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

      • criteria (dict) --

        The criteria that determine if a device is behaving normally in regard to the metric .

        • comparisonOperator (string) --

          The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

        • value (dict) --

          The value to be compared with the metric .

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • durationSeconds (integer) --

          Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

        • consecutiveDatapointsToAlarm (integer) --

          If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

        • consecutiveDatapointsToClear (integer) --

          If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

        • statisticalThreshold (dict) --

          A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

          • statistic (string) --

            The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

  • alertTargets (dict) --

    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

    • (string) --

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

      • (dict) --

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

        • alertTargetArn (string) -- [REQUIRED]

          The ARN of the notification target to which alerts are sent.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants permission to send alerts to the notification target.

  • additionalMetricsToRetain (list) --

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors , but it is also retained for any metric specified here.

    Note: This API field is deprecated. Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
    • (string) --
  • additionalMetricsToRetainV2 (list) --

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors , but it is also retained for any metric specified here.

    • (dict) --

      The metric you want to retain. Dimensions are optional.

      • metric (string) -- [REQUIRED]

        What is measured by the behavior.

      • metricDimension (dict) --

        The dimension of a metric.

        • dimensionName (string) -- [REQUIRED]

          A unique identifier for the dimension.

        • operator (string) --

          Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

  • tags (list) --

    Metadata that can be used to manage the security profile.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'securityProfileName': 'string',
    'securityProfileArn': 'string'
}

Response Structure

  • (dict) --

    • securityProfileName (string) --

      The name you gave to the security profile.

    • securityProfileArn (string) --

      The ARN of the security profile.

create_stream(**kwargs)

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

See also: AWS API Documentation

Request Syntax

response = client.create_stream(
    streamId='string',
    description='string',
    files=[
        {
            'fileId': 123,
            's3Location': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
    ],
    roleArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • streamId (string) --

    [REQUIRED]

    The stream ID.

  • description (string) -- A description of the stream.
  • files (list) --

    [REQUIRED]

    The files to stream.

    • (dict) --

      Represents a file to stream.

      • fileId (integer) --

        The file ID.

      • s3Location (dict) --

        The location of the file in S3.

        • bucket (string) --

          The S3 bucket.

        • key (string) --

          The S3 key.

        • version (string) --

          The S3 bucket version.

  • roleArn (string) --

    [REQUIRED]

    An IAM role that allows the IoT service principal assumes to access your S3 files.

  • tags (list) --

    Metadata which can be used to manage streams.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{
    'streamId': 'string',
    'streamArn': 'string',
    'description': 'string',
    'streamVersion': 123
}

Response Structure

  • (dict) --

    • streamId (string) --

      The stream ID.

    • streamArn (string) --

      The stream ARN.

    • description (string) --

      A description of the stream.

    • streamVersion (integer) --

      The version of the stream.

create_thing(**kwargs)

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

Note

This is a control plane operation. See Authorization for information about authorizing control plane actions.

See also: AWS API Documentation

Request Syntax

response = client.create_thing(
    thingName='string',
    thingTypeName='string',
    attributePayload={
        'attributes': {
            'string': 'string'
        },
        'merge': True|False
    },
    billingGroupName='string'
)
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 or UpdateThingGroup .

  • billingGroupName (string) -- The name of the billing group the thing will be added to.
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.

Note

This is a control plane operation. See Authorization for information about authorizing control plane actions.

See also: AWS API Documentation

Request Syntax

response = client.create_thing_group(
    thingGroupName='string',
    parentGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
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 or UpdateThingGroup .

  • tags (list) --

    Metadata which can be used to manage the thing group.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

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',
        ]
    },
    tags=[
        {
            'Key': 'string',
            'Value': '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) --
  • tags (list) --

    Metadata which can be used to manage the thing type.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

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',
                    'qos': 123
                },
                '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'
                },
                'cloudwatchLogs': {
                    'roleArn': 'string',
                    'logGroupName': 'string'
                },
                'elasticsearch': {
                    'roleArn': 'string',
                    'endpoint': 'string',
                    'index': 'string',
                    'type': 'string',
                    'id': 'string'
                },
                'salesforce': {
                    'token': 'string',
                    'url': 'string'
                },
                'iotAnalytics': {
                    'channelArn': 'string',
                    'channelName': 'string',
                    'roleArn': 'string'
                },
                'iotEvents': {
                    'inputName': 'string',
                    'messageId': 'string',
                    'roleArn': 'string'
                },
                'iotSiteWise': {
                    'putAssetPropertyValueEntries': [
                        {
                            'entryId': 'string',
                            'assetId': 'string',
                            'propertyId': 'string',
                            'propertyAlias': 'string',
                            'propertyValues': [
                                {
                                    'value': {
                                        'stringValue': 'string',
                                        'integerValue': 'string',
                                        'doubleValue': 'string',
                                        'booleanValue': 'string'
                                    },
                                    'timestamp': {
                                        'timeInSeconds': 'string',
                                        'offsetInNanos': 'string'
                                    },
                                    'quality': 'string'
                                },
                            ]
                        },
                    ],
                    'roleArn': 'string'
                },
                'stepFunctions': {
                    'executionNamePrefix': 'string',
                    'stateMachineName': 'string',
                    'roleArn': 'string'
                },
                'http': {
                    'url': 'string',
                    'confirmationUrl': 'string',
                    'headers': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'auth': {
                        'sigv4': {
                            'signingRegion': 'string',
                            'serviceName': 'string',
                            'roleArn': 'string'
                        }
                    }
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string',
        'errorAction': {
            'dynamoDB': {
                'tableName': 'string',
                'roleArn': 'string',
                'operation': 'string',
                'hashKeyField': 'string',
                'hashKeyValue': 'string',
                'hashKeyType': 'STRING'|'NUMBER',
                'rangeKeyField': 'string',
                'rangeKeyValue': 'string',
                'rangeKeyType': 'STRING'|'NUMBER',
                'payloadField': 'string'
            },
            'dynamoDBv2': {
                'roleArn': 'string',
                'putItem': {
                    'tableName': 'string'
                }
            },
            'lambda': {
                'functionArn': 'string'
            },
            'sns': {
                'targetArn': 'string',
                'roleArn': 'string',
                'messageFormat': 'RAW'|'JSON'
            },
            'sqs': {
                'roleArn': 'string',
                'queueUrl': 'string',
                'useBase64': True|False
            },
            'kinesis': {
                'roleArn': 'string',
                'streamName': 'string',
                'partitionKey': 'string'
            },
            'republish': {
                'roleArn': 'string',
                'topic': 'string',
                'qos': 123
            },
            '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'
            },
            'cloudwatchLogs': {
                'roleArn': 'string',
                'logGroupName': 'string'
            },
            'elasticsearch': {
                'roleArn': 'string',
                'endpoint': 'string',
                'index': 'string',
                'type': 'string',
                'id': 'string'
            },
            'salesforce': {
                'token': 'string',
                'url': 'string'
            },
            'iotAnalytics': {
                'channelArn': 'string',
                'channelName': 'string',
                'roleArn': 'string'
            },
            'iotEvents': {
                'inputName': 'string',
                'messageId': 'string',
                'roleArn': 'string'
            },
            'iotSiteWise': {
                'putAssetPropertyValueEntries': [
                    {
                        'entryId': 'string',
                        'assetId': 'string',
                        'propertyId': 'string',
                        'propertyAlias': 'string',
                        'propertyValues': [
                            {
                                'value': {
                                    'stringValue': 'string',
                                    'integerValue': 'string',
                                    'doubleValue': 'string',
                                    'booleanValue': 'string'
                                },
                                'timestamp': {
                                    'timeInSeconds': 'string',
                                    'offsetInNanos': 'string'
                                },
                                'quality': 'string'
                            },
                        ]
                    },
                ],
                'roleArn': 'string'
            },
            'stepFunctions': {
                'executionNamePrefix': 'string',
                'stateMachineName': 'string',
                'roleArn': 'string'
            },
            'http': {
                'url': 'string',
                'confirmationUrl': 'string',
                'headers': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'auth': {
                    'sigv4': {
                        'signingRegion': 'string',
                        'serviceName': 'string',
                        'roleArn': 'string'
                    }
                }
            }
        }
    },
    tags='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) -- [REQUIRED]

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

          • putItem (dict) -- [REQUIRED]

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

            (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

          • qos (integer) --

            The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

        • cloudwatchLogs (dict) --

          Send data to CloudWatch Logs.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch log.

          • logGroupName (string) -- [REQUIRED]

            The CloudWatch log group to which the action sends 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.

        • iotAnalytics (dict) --

          Sends message data to an AWS IoT Analytics channel.

          • channelArn (string) --

            (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

          • channelName (string) --

            The name of the IoT Analytics channel to which message data will be sent.

          • roleArn (string) --

            The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

        • iotEvents (dict) --

          Sends an input to an AWS IoT Events detector.

          • inputName (string) -- [REQUIRED]

            The name of the AWS IoT Events input.

          • messageId (string) --

            [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

        • iotSiteWise (dict) --

          Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

          • putAssetPropertyValueEntries (list) -- [REQUIRED]

            A list of asset property value entries.

            • (dict) --

              An asset property value entry containing the following information.

              • entryId (string) --

                Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

              • assetId (string) --

                The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyId (string) --

                The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyAlias (string) --

                The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyValues (list) -- [REQUIRED]

                A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

                • (dict) --

                  An asset property value entry containing the following information.

                  • value (dict) -- [REQUIRED]

                    The value of the asset property.

                    • stringValue (string) --

                      Optional. The string value of the value entry. Accepts substitution templates.

                    • integerValue (string) --

                      Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                    • doubleValue (string) --

                      Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                    • booleanValue (string) --

                      Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                  • timestamp (dict) -- [REQUIRED]

                    The asset property value timestamp.

                    • timeInSeconds (string) -- [REQUIRED]

                      A string that contains the time in seconds since epoch. Accepts substitution templates.

                    • offsetInNanos (string) --

                      Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                  • quality (string) --

                    Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

        • stepFunctions (dict) --

          Starts execution of a Step Functions state machine.

          • executionNamePrefix (string) --

            (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

          • stateMachineName (string) -- [REQUIRED]

            The name of the Step Functions state machine whose execution will be started.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

        • http (dict) --

          Send data to an HTTPS endpoint.

          • url (string) -- [REQUIRED]

            The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

          • confirmationUrl (string) --

            The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

          • headers (list) --

            The HTTP headers to send with the message data.

            • (dict) --

              The HTTP action header.

              • key (string) -- [REQUIRED]

                The HTTP header key.

              • value (string) -- [REQUIRED]

                The HTTP header value. Substitution templates are supported.

          • auth (dict) --

            The authentication method to use when sending data to an HTTPS endpoint.

            • sigv4 (dict) --

              Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

              • signingRegion (string) -- [REQUIRED]

                The signing region.

              • serviceName (string) -- [REQUIRED]

                The service name to use while signing with Sig V4.

              • roleArn (string) -- [REQUIRED]

                The ARN of the signing role.

    • ruleDisabled (boolean) --

      Specifies whether the rule is disabled.

    • awsIotSqlVersion (string) --

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

    • errorAction (dict) --

      The action to take when an error occurs.

      • 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) -- [REQUIRED]

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

        • putItem (dict) -- [REQUIRED]

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

          (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

        • qos (integer) --

          The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

      • cloudwatchLogs (dict) --

        Send data to CloudWatch Logs.

        • roleArn (string) -- [REQUIRED]

          The IAM role that allows access to the CloudWatch log.

        • logGroupName (string) -- [REQUIRED]

          The CloudWatch log group to which the action sends 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.

      • iotAnalytics (dict) --

        Sends message data to an AWS IoT Analytics channel.

        • channelArn (string) --

          (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

        • channelName (string) --

          The name of the IoT Analytics channel to which message data will be sent.

        • roleArn (string) --

          The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

      • iotEvents (dict) --

        Sends an input to an AWS IoT Events detector.

        • inputName (string) -- [REQUIRED]

          The name of the AWS IoT Events input.

        • messageId (string) --

          [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

      • iotSiteWise (dict) --

        Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

        • putAssetPropertyValueEntries (list) -- [REQUIRED]

          A list of asset property value entries.

          • (dict) --

            An asset property value entry containing the following information.

            • entryId (string) --

              Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

            • assetId (string) --

              The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyId (string) --

              The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyAlias (string) --

              The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyValues (list) -- [REQUIRED]

              A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

              • (dict) --

                An asset property value entry containing the following information.

                • value (dict) -- [REQUIRED]

                  The value of the asset property.

                  • stringValue (string) --

                    Optional. The string value of the value entry. Accepts substitution templates.

                  • integerValue (string) --

                    Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                  • doubleValue (string) --

                    Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                  • booleanValue (string) --

                    Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                • timestamp (dict) -- [REQUIRED]

                  The asset property value timestamp.

                  • timeInSeconds (string) -- [REQUIRED]

                    A string that contains the time in seconds since epoch. Accepts substitution templates.

                  • offsetInNanos (string) --

                    Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                • quality (string) --

                  Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

      • stepFunctions (dict) --

        Starts execution of a Step Functions state machine.

        • executionNamePrefix (string) --

          (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

        • stateMachineName (string) -- [REQUIRED]

          The name of the Step Functions state machine whose execution will be started.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

      • http (dict) --

        Send data to an HTTPS endpoint.

        • url (string) -- [REQUIRED]

          The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

        • confirmationUrl (string) --

          The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

        • headers (list) --

          The HTTP headers to send with the message data.

          • (dict) --

            The HTTP action header.

            • key (string) -- [REQUIRED]

              The HTTP header key.

            • value (string) -- [REQUIRED]

              The HTTP header value. Substitution templates are supported.

        • auth (dict) --

          The authentication method to use when sending data to an HTTPS endpoint.

          • sigv4 (dict) --

            Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

            • signingRegion (string) -- [REQUIRED]

              The signing region.

            • serviceName (string) -- [REQUIRED]

              The service name to use while signing with Sig V4.

            • roleArn (string) -- [REQUIRED]

              The ARN of the signing role.

  • tags (string) --

    Metadata which can be used to manage the topic rule.

    Note

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns

None

create_topic_rule_destination(**kwargs)

Creates a topic rule destination. The destination must be confirmed prior to use.

See also: AWS API Documentation

Request Syntax

response = client.create_topic_rule_destination(
    destinationConfiguration={
        'httpUrlConfiguration': {
            'confirmationUrl': 'string'
        }
    }
)
Parameters
destinationConfiguration (dict) --

[REQUIRED]

The topic rule destination configuration.

  • httpUrlConfiguration (dict) --

    Configuration of the HTTP URL.

    • confirmationUrl (string) -- [REQUIRED]

      The URL AWS IoT uses to confirm ownership of or access to the topic rule destination URL.

Return type
dict
Returns
Response Syntax
{
    'topicRuleDestination': {
        'arn': 'string',
        'status': 'ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR',
        'statusReason': 'string',
        'httpUrlProperties': {
            'confirmationUrl': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • topicRuleDestination (dict) --

      The topic rule destination.

      • arn (string) --

        The topic rule destination URL.

      • status (string) --

        The status of the topic rule destination. Valid values are:

        IN_PROGRESS

        A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

        ENABLED

        Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination .

        DISABLED

        Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .

        ERROR

        Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      • statusReason (string) --

        Additional details or reason why the topic rule destination is in the current status.

      • httpUrlProperties (dict) --

        Properties of the HTTP URL.

        • confirmationUrl (string) --

          The URL used to confirm the HTTP topic rule destination URL.

delete_account_audit_configuration(**kwargs)

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

See also: AWS API Documentation

Request Syntax

response = client.delete_account_audit_configuration(
    deleteScheduledAudits=True|False
)
Parameters
deleteScheduledAudits (boolean) -- If true, all scheduled audits are deleted.
Return type
dict
Returns
Response Syntax
{}

Response Structure

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

Deletes the billing group.

See also: AWS API Documentation

Request Syntax

response = client.delete_billing_group(
    billingGroupName='string',
    expectedVersion=123
)
Parameters
  • billingGroupName (string) --

    [REQUIRED]

    The name of the billing group.

  • expectedVersion (integer) -- The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException .
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. (The last part of the certificate ARN contains the certificate ID.)

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 or IoT thing 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. (The last part of the certificate ARN contains the certificate ID.)

  • forceDelete (boolean) -- Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
Returns

None

delete_dimension(**kwargs)

Removes the specified dimension from your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.delete_dimension(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The unique identifier for the dimension that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_domain_configuration(**kwargs)

Deletes the specified domain configuration.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain_configuration(
    domainConfigurationName='string'
)
Parameters
domainConfigurationName (string) --

[REQUIRED]

The name of the domain configuration to be deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_dynamic_thing_group(**kwargs)

Deletes a dynamic thing group.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the dynamic thing group to delete.

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

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_job(**kwargs)

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

See also: AWS API Documentation

Request Syntax

response = client.delete_job(
    jobId='string',
    force=True|False
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job to be deleted.

    After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

  • force (boolean) --

    (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

    Note

    Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

Returns

None

delete_job_execution(**kwargs)

Deletes a job execution.

See also: AWS API Documentation

Request Syntax

response = client.delete_job_execution(
    jobId='string',
    thingName='string',
    executionNumber=123,
    force=True|False
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job whose execution on a particular device will be deleted.

  • thingName (string) --

    [REQUIRED]

    The name of the thing whose job execution will be deleted.

  • executionNumber (integer) --

    [REQUIRED]

    The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

    Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

  • force (boolean) --

    (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

    Note

    Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Returns

None

delete_mitigation_action(**kwargs)

Deletes a defined mitigation action from your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.delete_mitigation_action(
    actionName='string'
)
Parameters
actionName (string) --

[REQUIRED]

The name of the mitigation action that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_ota_update(**kwargs)

Delete an OTA update.

See also: AWS API Documentation

Request Syntax

response = client.delete_ota_update(
    otaUpdateId='string',
    deleteStream=True|False,
    forceDeleteAWSJob=True|False
)
Parameters
  • otaUpdateId (string) --

    [REQUIRED]

    The OTA update ID to delete.

  • deleteStream (boolean) -- Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
  • forceDeleteAWSJob (boolean) -- Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

Deletes a fleet provisioning template.

See also: AWS API Documentation

Request Syntax

response = client.delete_provisioning_template(
    templateName='string'
)
Parameters
templateName (string) --

[REQUIRED]

The name of the fleet provision template to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_provisioning_template_version(**kwargs)

Deletes a fleet provisioning template version.

See also: AWS API Documentation

Request Syntax

response = client.delete_provisioning_template_version(
    templateName='string',
    versionId=123
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The name of the fleet provisioning template version to delete.

  • versionId (integer) --

    [REQUIRED]

    The fleet provisioning template version ID to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

Deletes a scheduled audit.

See also: AWS API Documentation

Request Syntax

response = client.delete_scheduled_audit(
    scheduledAuditName='string'
)
Parameters
scheduledAuditName (string) --

[REQUIRED]

The name of the scheduled audit you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_security_profile(**kwargs)

Deletes a Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.delete_security_profile(
    securityProfileName='string',
    expectedVersion=123
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The name of the security profile to be deleted.

  • expectedVersion (integer) -- The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_stream(**kwargs)

Deletes a stream.

See also: AWS API Documentation

Request Syntax

response = client.delete_stream(
    streamId='string'
)
Parameters
streamId (string) --

[REQUIRED]

The stream ID.

Return type
dict
Returns
Response Syntax
{}

Response Structure

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

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

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

Deletes a topic rule destination.

See also: AWS API Documentation

Request Syntax

response = client.delete_topic_rule_destination(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

The ARN of the topic rule destination to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
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_account_audit_configuration()

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_audit_configuration()
Return type
dict
Returns
Response Syntax
{
    'roleArn': 'string',
    'auditNotificationTargetConfigurations': {
        'string': {
            'targetArn': 'string',
            'roleArn': 'string',
            'enabled': True|False
        }
    },
    'auditCheckConfigurations': {
        'string': {
            'enabled': True|False
        }
    }
}

Response Structure

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

      The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

      On the first call to UpdateAccountAuditConfiguration , this parameter is required.

    • auditNotificationTargetConfigurations (dict) --

      Information about the targets to which audit notifications are sent for this account.

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

          Information about the targets to which audit notifications are sent.

          • targetArn (string) --

            The ARN of the target (SNS topic) to which audit notifications are sent.

          • roleArn (string) --

            The ARN of the role that grants permission to send notifications to the target.

          • enabled (boolean) --

            True if notifications to the target are enabled.

    • auditCheckConfigurations (dict) --

      Which audit checks are enabled and disabled for this account.

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

        • (dict) --

          Which audit checks are enabled and disabled for this account.

          • enabled (boolean) --

            True if this audit check is enabled for this account.

describe_audit_finding(**kwargs)

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.

See also: AWS API Documentation

Request Syntax

response = client.describe_audit_finding(
    findingId='string'
)
Parameters
findingId (string) --

[REQUIRED]

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

Return type
dict
Returns
Response Syntax
{
    'finding': {
        'findingId': 'string',
        'taskId': 'string',
        'checkName': 'string',
        'taskStartTime': datetime(2015, 1, 1),
        'findingTime': datetime(2015, 1, 1),
        'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW',
        'nonCompliantResource': {
            'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
            'resourceIdentifier': {
                'deviceCertificateId': 'string',
                'caCertificateId': 'string',
                'cognitoIdentityPoolId': 'string',
                'clientId': 'string',
                'policyVersionIdentifier': {
                    'policyName': 'string',
                    'policyVersionId': 'string'
                },
                'account': 'string',
                'iamRoleArn': 'string',
                'roleAliasArn': 'string'
            },
            'additionalInfo': {
                'string': 'string'
            }
        },
        'relatedResources': [
            {
                'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
                'resourceIdentifier': {
                    'deviceCertificateId': 'string',
                    'caCertificateId': 'string',
                    'cognitoIdentityPoolId': 'string',
                    'clientId': 'string',
                    'policyVersionIdentifier': {
                        'policyName': 'string',
                        'policyVersionId': 'string'
                    },
                    'account': 'string',
                    'iamRoleArn': 'string',
                    'roleAliasArn': 'string'
                },
                'additionalInfo': {
                    'string': 'string'
                }
            },
        ],
        'reasonForNonCompliance': 'string',
        'reasonForNonComplianceCode': 'string'
    }
}

Response Structure

  • (dict) --
    • finding (dict) --

      The findings (results) of the audit.

      • findingId (string) --

        A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

      • taskId (string) --

        The ID of the audit that generated this result (finding).

      • checkName (string) --

        The audit check that generated this result.

      • taskStartTime (datetime) --

        The time the audit started.

      • findingTime (datetime) --

        The time the result (finding) was discovered.

      • severity (string) --

        The severity of the result (finding).

      • nonCompliantResource (dict) --

        The resource that was found to be noncompliant with the audit check.

        • resourceType (string) --

          The type of the noncompliant resource.

        • resourceIdentifier (dict) --

          Information that identifies the noncompliant resource.

          • deviceCertificateId (string) --

            The ID of the certificate attached to the resource.

          • caCertificateId (string) --

            The ID of the CA certificate used to authorize the certificate.

          • cognitoIdentityPoolId (string) --

            The ID of the Amazon Cognito identity pool.

          • clientId (string) --

            The client ID.

          • policyVersionIdentifier (dict) --

            The version of the policy associated with the resource.

            • policyName (string) --

              The name of the policy.

            • policyVersionId (string) --

              The ID of the version of the policy associated with the resource.

          • account (string) --

            The account with which the resource is associated.

          • iamRoleArn (string) --

            The ARN of the IAM role that has overly permissive actions.

          • roleAliasArn (string) --

            The ARN of the role alias that has overly permissive actions.

        • additionalInfo (dict) --

          Other information about the noncompliant resource.

          • (string) --
            • (string) --
      • relatedResources (list) --

        The list of related resources.

        • (dict) --

          Information about a related resource.

          • resourceType (string) --

            The type of resource.

          • resourceIdentifier (dict) --

            Information that identifies the resource.

            • deviceCertificateId (string) --

              The ID of the certificate attached to the resource.

            • caCertificateId (string) --

              The ID of the CA certificate used to authorize the certificate.

            • cognitoIdentityPoolId (string) --

              The ID of the Amazon Cognito identity pool.

            • clientId (string) --

              The client ID.

            • policyVersionIdentifier (dict) --

              The version of the policy associated with the resource.

              • policyName (string) --

                The name of the policy.

              • policyVersionId (string) --

                The ID of the version of the policy associated with the resource.

            • account (string) --

              The account with which the resource is associated.

            • iamRoleArn (string) --

              The ARN of the IAM role that has overly permissive actions.

            • roleAliasArn (string) --

              The ARN of the role alias that has overly permissive actions.

          • additionalInfo (dict) --

            Other information about the resource.

            • (string) --
              • (string) --
      • reasonForNonCompliance (string) --

        The reason the resource was noncompliant.

      • reasonForNonComplianceCode (string) --

        A code that indicates the reason that the resource was noncompliant.

describe_audit_mitigation_actions_task(**kwargs)

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The unique identifier for the audit mitigation task.

Return type
dict
Returns
Response Syntax
{
    'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    'startTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'taskStatistics': {
        'string': {
            'totalFindingsCount': 123,
            'failedFindingsCount': 123,
            'succeededFindingsCount': 123,
            'skippedFindingsCount': 123,
            'canceledFindingsCount': 123
        }
    },
    'target': {
        'auditTaskId': 'string',
        'findingIds': [
            'string',
        ],
        'auditCheckToReasonCodeFilter': {
            'string': [
                'string',
            ]
        }
    },
    'auditCheckToActionsMapping': {
        'string': [
            'string',
        ]
    },
    'actionsDefinition': [
        {
            'name': 'string',
            'id': 'string',
            'roleArn': 'string',
            'actionParams': {
                'updateDeviceCertificateParams': {
                    'action': 'DEACTIVATE'
                },
                'updateCACertificateParams': {
                    'action': 'DEACTIVATE'
                },
                'addThingsToThingGroupParams': {
                    'thingGroupNames': [
                        'string',
                    ],
                    'overrideDynamicGroups': True|False
                },
                'replaceDefaultPolicyVersionParams': {
                    'templateName': 'BLANK_POLICY'
                },
                'enableIoTLoggingParams': {
                    'roleArnForLogging': 'string',
                    'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
                },
                'publishFindingToSnsParams': {
                    'topicArn': 'string'
                }
            }
        },
    ]
}

Response Structure

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

      The current status of the task.

    • startTime (datetime) --

      The date and time when the task was started.

    • endTime (datetime) --

      The date and time when the task was completed or canceled.

    • taskStatistics (dict) --

      Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

        • (dict) --

          Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

          • totalFindingsCount (integer) --

            The total number of findings to which a task is being applied.

          • failedFindingsCount (integer) --

            The number of findings for which at least one of the actions failed when applied.

          • succeededFindingsCount (integer) --

            The number of findings for which all mitigation actions succeeded when applied.

          • skippedFindingsCount (integer) --

            The number of findings skipped because of filter conditions provided in the parameters to the command.

          • canceledFindingsCount (integer) --

            The number of findings to which the mitigation action task was canceled when applied.

    • target (dict) --

      Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

      • auditTaskId (string) --

        If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

      • findingIds (list) --

        If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

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

        Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

        • (string) --

          An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

          • (list) --
            • (string) --
    • auditCheckToActionsMapping (dict) --

      Specifies the mitigation actions that should be applied to specific audit checks.

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

        • (list) --
          • (string) --
    • actionsDefinition (list) --

      Specifies the mitigation actions and their parameters that are applied as part of this task.

      • (dict) --

        Describes which changes should be applied as part of a mitigation action.

        • name (string) --

          A user-friendly name for the mitigation action.

        • id (string) --

          A unique identifier for the mitigation action.

        • roleArn (string) --

          The IAM role ARN used to apply this mitigation action.

        • actionParams (dict) --

          The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

          • updateDeviceCertificateParams (dict) --

            Parameters to define a mitigation action that changes the state of the device certificate to inactive.

            • action (string) --

              The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE .

          • updateCACertificateParams (dict) --

            Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

            • action (string) --

              The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE .

          • addThingsToThingGroupParams (dict) --

            Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

            • thingGroupNames (list) --

              The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.

              • (string) --
            • overrideDynamicGroups (boolean) --

              Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.

          • replaceDefaultPolicyVersionParams (dict) --

            Parameters to define a mitigation action that adds a blank policy to restrict permissions.

            • templateName (string) --

              The name of the template to be applied. The only supported value is BLANK_POLICY .

          • enableIoTLoggingParams (dict) --

            Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

            • roleArnForLogging (string) --

              The ARN of the IAM role used for logging.

            • logLevel (string) --

              Specifies the types of information to be logged.

          • publishFindingToSnsParams (dict) --

            Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

            • topicArn (string) --

              The ARN of the topic to which you want to publish the findings.

describe_audit_task(**kwargs)

Gets information about a Device Defender audit.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The ID of the audit whose information you want to get.

Return type
dict
Returns
Response Syntax
{
    'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
    'taskStartTime': datetime(2015, 1, 1),
    'taskStatistics': {
        'totalChecks': 123,
        'inProgressChecks': 123,
        'waitingForDataCollectionChecks': 123,
        'compliantChecks': 123,
        'nonCompliantChecks': 123,
        'failedChecks': 123,
        'canceledChecks': 123
    },
    'scheduledAuditName': 'string',
    'auditDetails': {
        'string': {
            'checkRunStatus': 'IN_PROGRESS'|'WAITING_FOR_DATA_COLLECTION'|'CANCELED'|'COMPLETED_COMPLIANT'|'COMPLETED_NON_COMPLIANT'|'FAILED',
            'checkCompliant': True|False,
            'totalResourcesCount': 123,
            'nonCompliantResourcesCount': 123,
            'errorCode': 'string',
            'message': 'string'
        }
    }
}

Response Structure

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

      The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

    • taskType (string) --

      The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

    • taskStartTime (datetime) --

      The time the audit started.

    • taskStatistics (dict) --

      Statistical information about the audit.

      • totalChecks (integer) --

        The number of checks in this audit.

      • inProgressChecks (integer) --

        The number of checks in progress.

      • waitingForDataCollectionChecks (integer) --

        The number of checks waiting for data collection.

      • compliantChecks (integer) --

        The number of checks that found compliant resources.

      • nonCompliantChecks (integer) --

        The number of checks that found noncompliant resources.

      • failedChecks (integer) --

        The number of checks.

      • canceledChecks (integer) --

        The number of checks that did not run because the audit was canceled.

    • scheduledAuditName (string) --

      The name of the scheduled audit (only if the audit was a scheduled audit).

    • auditDetails (dict) --

      Detailed information about each check performed during this audit.

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

        • (dict) --

          Information about the audit check.

          • checkRunStatus (string) --

            The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

          • checkCompliant (boolean) --

            True if the check is complete and found all resources compliant.

          • totalResourcesCount (integer) --

            The number of resources on which the check was performed.

          • nonCompliantResourcesCount (integer) --

            The number of resources that were found noncompliant during the check.

          • errorCode (string) --

            The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

          • message (string) --

            The message associated with any error encountered when this check is performed during this audit.

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),
        'signingDisabled': True|False
    }
}

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.

      • signingDisabled (boolean) --

        Specifies whether AWS IoT validates the token signature in an authorization request.

describe_billing_group(**kwargs)

Returns information about a billing group.

See also: AWS API Documentation

Request Syntax

response = client.describe_billing_group(
    billingGroupName='string'
)
Parameters
billingGroupName (string) --

[REQUIRED]

The name of the billing group.

Return type
dict
Returns
Response Syntax
{
    'billingGroupName': 'string',
    'billingGroupId': 'string',
    'billingGroupArn': 'string',
    'version': 123,
    'billingGroupProperties': {
        'billingGroupDescription': 'string'
    },
    'billingGroupMetadata': {
        'creationDate': datetime(2015, 1, 1)
    }
}

Response Structure

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

      The name of the billing group.

    • billingGroupId (string) --

      The ID of the billing group.

    • billingGroupArn (string) --

      The ARN of the billing group.

    • version (integer) --

      The version of the billing group.

    • billingGroupProperties (dict) --

      The properties of the billing group.

      • billingGroupDescription (string) --

        The description of the billing group.

    • billingGroupMetadata (dict) --

      Additional information about the billing group.

      • creationDate (datetime) --

        The date the billing group was created.

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',
        'lastModifiedDate': datetime(2015, 1, 1),
        'customerVersion': 123,
        'generationId': 'string',
        'validity': {
            'notBefore': datetime(2015, 1, 1),
            'notAfter': datetime(2015, 1, 1)
        }
    },
    'registrationConfig': {
        'templateBody': 'string',
        'roleArn': 'string'
    }
}

Response Structure

  • (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"

      • lastModifiedDate (datetime) --

        The date the CA certificate was last modified.

      • customerVersion (integer) --

        The customer version of the CA certificate.

      • generationId (string) --

        The generation ID of the CA certificate.

      • validity (dict) --

        When the CA certificate is valid.

        • notBefore (datetime) --

          The certificate is not valid before this date.

        • notAfter (datetime) --

          The certificate is not valid after this date.

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

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

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),
        'customerVersion': 123,
        'transferData': {
            'transferMessage': 'string',
            'rejectReason': 'string',
            'transferDate': datetime(2015, 1, 1),
            'acceptDate': datetime(2015, 1, 1),
            'rejectDate': datetime(2015, 1, 1)
        },
        'generationId': 'string',
        'validity': {
            'notBefore': datetime(2015, 1, 1),
            'notAfter': datetime(2015, 1, 1)
        }
    }
}

Response Structure

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

      • customerVersion (integer) --

        The customer version of the certificate.

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

      • generationId (string) --

        The generation ID of the certificate.

      • validity (dict) --

        When the certificate is valid.

        • notBefore (datetime) --

          The certificate is not valid before this date.

        • notAfter (datetime) --

          The certificate is not valid after this date.

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),
        'signingDisabled': True|False
    }
}

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.

      • signingDisabled (boolean) --

        Specifies whether AWS IoT validates the token signature in an authorization request.

describe_dimension(**kwargs)

Provides details about a dimension that is defined in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.describe_dimension(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The unique identifier for the dimension.

Return type
dict
Returns
Response Syntax
{
    'name': 'string',
    'arn': 'string',
    'type': 'TOPIC_FILTER',
    'stringValues': [
        'string',
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

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

      The unique identifier for the dimension.

    • arn (string) --

      The ARN (Amazon resource name) for the dimension.

    • type (string) --

      The type of the dimension.

    • stringValues (list) --

      The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

      • (string) --
    • creationDate (datetime) --

      The date the dimension was created.

    • lastModifiedDate (datetime) --

      The date the dimension was last modified.

describe_domain_configuration(**kwargs)

Gets summary information about a domain configuration.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_configuration(
    domainConfigurationName='string'
)
Parameters
domainConfigurationName (string) --

[REQUIRED]

The name of the domain configuration.

Return type
dict
Returns
Response Syntax
{
    'domainConfigurationName': 'string',
    'domainConfigurationArn': 'string',
    'domainName': 'string',
    'serverCertificates': [
        {
            'serverCertificateArn': 'string',
            'serverCertificateStatus': 'INVALID'|'VALID',
            'serverCertificateStatusDetail': 'string'
        },
    ],
    'authorizerConfig': {
        'defaultAuthorizerName': 'string',
        'allowAuthorizerOverride': True|False
    },
    'domainConfigurationStatus': 'ENABLED'|'DISABLED',
    'serviceType': 'DATA'|'CREDENTIAL_PROVIDER'|'JOBS',
    'domainType': 'ENDPOINT'|'AWS_MANAGED'|'CUSTOMER_MANAGED'
}

Response Structure

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

      The name of the domain configuration.

    • domainConfigurationArn (string) --

      The ARN of the domain configuration.

    • domainName (string) --

      The name of the domain.

    • serverCertificates (list) --

      A list containing summary information about the server certificate included in the domain configuration.

      • (dict) --

        An object that contains information about a server certificate.

        • serverCertificateArn (string) --

          The ARN of the server certificate.

        • serverCertificateStatus (string) --

          The status of the server certificate.

        • serverCertificateStatusDetail (string) --

          Details that explain the status of the server certificate.

    • authorizerConfig (dict) --

      An object that specifies the authorization service for a domain.

      • defaultAuthorizerName (string) --

        The name of the authorization service for a domain configuration.

      • allowAuthorizerOverride (boolean) --

        A Boolean that specifies whether the domain configuration's authorization service can be overridden.

    • domainConfigurationStatus (string) --

      A Boolean value that specifies the current state of the domain configuration.

    • serviceType (string) --

      The type of service delivered by the endpoint.

    • domainType (string) --

      The type of the domain.

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. Valid endpoint types include:

  • iot:Data - Returns a VeriSign signed data endpoint.
  • iot:Data-ATS - Returns an ATS signed data endpoint.
  • iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint.
  • iot:Jobs - Returns an AWS IoT device management Jobs API endpoint.

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

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 contains only registry data.
      • REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
      • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
      • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
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'|'DELETION_IN_PROGRESS',
        'forceCanceled': True|False,
        'reasonCode': 'string',
        'comment': 'string',
        'targets': [
            'string',
        ],
        'description': 'string',
        'presignedUrlConfig': {
            'roleArn': 'string',
            'expiresInSec': 123
        },
        'jobExecutionsRolloutConfig': {
            'maximumPerMinute': 123,
            'exponentialRate': {
                'baseRatePerMinute': 123,
                'incrementFactor': 123.0,
                'rateIncreaseCriteria': {
                    'numberOfNotifiedThings': 123,
                    'numberOfSucceededThings': 123
                }
            }
        },
        'abortConfig': {
            'criteriaList': [
                {
                    'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
                    'action': 'CANCEL',
                    'thresholdPercentage': 123.0,
                    'minNumberOfExecutedThings': 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,
            'numberOfTimedOutThings': 123
        },
        'timeoutConfig': {
            'inProgressTimeoutInMinutes': 123
        }
    }
}

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 , DELETION_IN_PROGRESS or COMPLETED .

      • forceCanceled (boolean) --

        Will be true if the job was canceled with the optional force parameter set to true .

      • reasonCode (string) --

        If the job was updated, provides the reason code for the update.

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

        • exponentialRate (dict) --

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

          • baseRatePerMinute (integer) --

            The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

          • incrementFactor (float) --

            The exponential factor to increase the rate of rollout for a job.

          • rateIncreaseCriteria (dict) --

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

            AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

            • numberOfNotifiedThings (integer) --

              The threshold for number of notified things that will initiate the increase in rate of rollout.

            • numberOfSucceededThings (integer) --

              The threshold for number of succeeded things that will initiate the increase in rate of rollout.

      • abortConfig (dict) --

        Configuration for criteria to abort the job.

        • criteriaList (list) --

          The list of abort criteria to define rules to abort the job.

          • (dict) --

            Details of abort criteria to define rules to abort the job.

            • failureType (string) --

              The type of job execution failure to define a rule to initiate a job abort.

            • action (string) --

              The type of abort action to initiate a job abort.

            • thresholdPercentage (float) --

              The threshold as a percentage of the total number of executed things that will initiate a job abort.

              AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

            • minNumberOfExecutedThings (integer) --

              Minimum number of executed things before evaluating an abort rule.

      • createdAt (datetime) --

        The time, in seconds since the epoch, when the job was created.

      • lastUpdatedAt (datetime) --

        The time, in seconds since the epoch, when the job was last updated.

      • completedAt (datetime) --

        The time, in seconds since the epoch, when the job was completed.

      • jobProcessDetails (dict) --

        Details about the job process.

        • processingTargets (list) --

          The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

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

        • numberOfTimedOutThings (integer) --

          The number of things whose job execution status is TIMED_OUT .

      • timeoutConfig (dict) --

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

        • inProgressTimeoutInMinutes (integer) --

          Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

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'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
        'forceCanceled': True|False,
        'statusDetails': {
            'detailsMap': {
                'string': 'string'
            }
        },
        'thingArn': 'string',
        'queuedAt': datetime(2015, 1, 1),
        'startedAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'executionNumber': 123,
        'versionNumber': 123,
        'approximateSecondsBeforeTimedOut': 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, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

      • forceCanceled (boolean) --

        Will be true if the job execution was canceled with the optional force parameter set to true .

      • statusDetails (dict) --

        A collection of name/value pairs that describe the status of the job execution.

        • detailsMap (dict) --

          The job execution status.

          • (string) --
            • (string) --
      • thingArn (string) --

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

      • queuedAt (datetime) --

        The time, in seconds since the epoch, when the job execution was queued.

      • startedAt (datetime) --

        The time, in seconds since the epoch, when the job execution started.

      • lastUpdatedAt (datetime) --

        The time, in seconds since the epoch, when the job execution was last updated.

      • executionNumber (integer) --

        A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

      • versionNumber (integer) --

        The version of the job execution. Job execution versions are incremented each time they are updated by a device.

      • approximateSecondsBeforeTimedOut (integer) --

        The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT . The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

describe_mitigation_action(**kwargs)

Gets information about a mitigation action.

See also: AWS API Documentation

Request Syntax

response = client.describe_mitigation_action(
    actionName='string'
)
Parameters
actionName (string) --

[REQUIRED]

The friendly name that uniquely identifies the mitigation action.

Return type
dict
Returns
Response Syntax
{
    'actionName': 'string',
    'actionType': 'UPDATE_DEVICE_CERTIFICATE'|'UPDATE_CA_CERTIFICATE'|'ADD_THINGS_TO_THING_GROUP'|'REPLACE_DEFAULT_POLICY_VERSION'|'ENABLE_IOT_LOGGING'|'PUBLISH_FINDING_TO_SNS',
    'actionArn': 'string',
    'actionId': 'string',
    'roleArn': 'string',
    'actionParams': {
        'updateDeviceCertificateParams': {
            'action': 'DEACTIVATE'
        },
        'updateCACertificateParams': {
            'action': 'DEACTIVATE'
        },
        'addThingsToThingGroupParams': {
            'thingGroupNames': [
                'string',
            ],
            'overrideDynamicGroups': True|False
        },
        'replaceDefaultPolicyVersionParams': {
            'templateName': 'BLANK_POLICY'
        },
        'enableIoTLoggingParams': {
            'roleArnForLogging': 'string',
            'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
        },
        'publishFindingToSnsParams': {
            'topicArn': 'string'
        }
    },
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

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

      The friendly name that uniquely identifies the mitigation action.

    • actionType (string) --

      The type of mitigation action.

    • actionArn (string) --

      The ARN that identifies this migration action.

    • actionId (string) --

      A unique identifier for this action.

    • roleArn (string) --

      The ARN of the IAM role used to apply this action.

    • actionParams (dict) --

      Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

      • updateDeviceCertificateParams (dict) --

        Parameters to define a mitigation action that changes the state of the device certificate to inactive.

        • action (string) --

          The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE .

      • updateCACertificateParams (dict) --

        Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

        • action (string) --

          The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE .

      • addThingsToThingGroupParams (dict) --

        Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

        • thingGroupNames (list) --

          The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.

          • (string) --
        • overrideDynamicGroups (boolean) --

          Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.

      • replaceDefaultPolicyVersionParams (dict) --

        Parameters to define a mitigation action that adds a blank policy to restrict permissions.

        • templateName (string) --

          The name of the template to be applied. The only supported value is BLANK_POLICY .

      • enableIoTLoggingParams (dict) --

        Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

        • roleArnForLogging (string) --

          The ARN of the IAM role used for logging.

        • logLevel (string) --

          Specifies the types of information to be logged.

      • publishFindingToSnsParams (dict) --

        Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

        • topicArn (string) --

          The ARN of the topic to which you want to publish the findings.

    • creationDate (datetime) --

      The date and time when the mitigation action was added to your AWS account.

    • lastModifiedDate (datetime) --

      The date and time when the mitigation action was last changed.

describe_provisioning_template(**kwargs)

Returns information about a fleet provisioning template.

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioning_template(
    templateName='string'
)
Parameters
templateName (string) --

[REQUIRED]

The name of the fleet provisioning template.

Return type
dict
Returns
Response Syntax
{
    'templateArn': 'string',
    'templateName': 'string',
    'description': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'defaultVersionId': 123,
    'templateBody': 'string',
    'enabled': True|False,
    'provisioningRoleArn': 'string'
}

Response Structure

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

      The ARN of the fleet provisioning template.

    • templateName (string) --

      The name of the fleet provisioning template.

    • description (string) --

      The description of the fleet provisioning template.

    • creationDate (datetime) --

      The date when the fleet provisioning template was created.

    • lastModifiedDate (datetime) --

      The date when the fleet provisioning template was last modified.

    • defaultVersionId (integer) --

      The default fleet template version ID.

    • templateBody (string) --

      The JSON formatted contents of the fleet provisioning template.

    • enabled (boolean) --

      True if the fleet provisioning template is enabled, otherwise false.

    • provisioningRoleArn (string) --

      The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

describe_provisioning_template_version(**kwargs)

Returns information about a fleet provisioning template version.

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioning_template_version(
    templateName='string',
    versionId=123
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The template name.

  • versionId (integer) --

    [REQUIRED]

    The fleet provisioning template version ID.

Return type

dict

Returns

Response Syntax

{
    'versionId': 123,
    'creationDate': datetime(2015, 1, 1),
    'templateBody': 'string',
    'isDefaultVersion': True|False
}

Response Structure

  • (dict) --

    • versionId (integer) --

      The fleet provisioning template version ID.

    • creationDate (datetime) --

      The date when the fleet provisioning template version was created.

    • templateBody (string) --

      The JSON formatted contents of the fleet provisioning template version.

    • isDefaultVersion (boolean) --

      True if the fleet provisioning template version is the default version.

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',
        'roleAliasArn': '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.

      • roleAliasArn (string) --

        The ARN of 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_scheduled_audit(**kwargs)

Gets information about a scheduled audit.

See also: AWS API Documentation

Request Syntax

response = client.describe_scheduled_audit(
    scheduledAuditName='string'
)
Parameters
scheduledAuditName (string) --

[REQUIRED]

The name of the scheduled audit whose information you want to get.

Return type
dict
Returns
Response Syntax
{
    'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
    'dayOfMonth': 'string',
    'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
    'targetCheckNames': [
        'string',
    ],
    'scheduledAuditName': 'string',
    'scheduledAuditArn': 'string'
}

Response Structure

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

      How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.

    • dayOfMonth (string) --

      The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

    • dayOfWeek (string) --

      The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT".

    • targetCheckNames (list) --

      Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    • scheduledAuditName (string) --

      The name of the scheduled audit.

    • scheduledAuditArn (string) --

      The ARN of the scheduled audit.

describe_security_profile(**kwargs)

Gets information about a Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.describe_security_profile(
    securityProfileName='string'
)
Parameters
securityProfileName (string) --

[REQUIRED]

The name of the security profile whose information you want to get.

Return type
dict
Returns
Response Syntax
{
    'securityProfileName': 'string',
    'securityProfileArn': 'string',
    'securityProfileDescription': 'string',
    'behaviors': [
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                }
            }
        },
    ],
    'alertTargets': {
        'string': {
            'alertTargetArn': 'string',
            'roleArn': 'string'
        }
    },
    'additionalMetricsToRetain': [
        'string',
    ],
    'additionalMetricsToRetainV2': [
        {
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            }
        },
    ],
    'version': 123,
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

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

      The name of the security profile.

    • securityProfileArn (string) --

      The ARN of the security profile.

    • securityProfileDescription (string) --

      A description of the security profile (associated with the security profile when it was created or updated).

    • behaviors (list) --

      Specifies the behaviors that, when violated by a device (thing), cause an alert.

      • (dict) --

        A Device Defender security profile behavior.

        • name (string) --

          The name you have given to the behavior.

        • metric (string) --

          What is measured by the behavior.

        • metricDimension (dict) --

          The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

          • dimensionName (string) --

            A unique identifier for the dimension.

          • operator (string) --

            Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

        • criteria (dict) --

          The criteria that determine if a device is behaving normally in regard to the metric .

          • comparisonOperator (string) --

            The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

          • value (dict) --

            The value to be compared with the metric .

            • count (integer) --

              If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

            • cidrs (list) --

              If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

              • (string) --
            • ports (list) --

              If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

              • (integer) --
          • durationSeconds (integer) --

            Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

          • consecutiveDatapointsToAlarm (integer) --

            If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

          • consecutiveDatapointsToClear (integer) --

            If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

          • statisticalThreshold (dict) --

            A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

            • statistic (string) --

              The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

    • alertTargets (dict) --

      Where the alerts are sent. (Alerts are always sent to the console.)

      • (string) --

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

        • (dict) --

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

          • alertTargetArn (string) --

            The ARN of the notification target to which alerts are sent.

          • roleArn (string) --

            The ARN of the role that grants permission to send alerts to the notification target.

    • additionalMetricsToRetain (list) --

      A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors , but it is also retained for any metric specified here.

      Note: This API field is deprecated. Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
      • (string) --
    • additionalMetricsToRetainV2 (list) --

      A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

      • (dict) --

        The metric you want to retain. Dimensions are optional.

        • metric (string) --

          What is measured by the behavior.

        • metricDimension (dict) --

          The dimension of a metric.

          • dimensionName (string) --

            A unique identifier for the dimension.

          • operator (string) --

            Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

    • version (integer) --

      The version of the security profile. A new version is generated whenever the security profile is updated.

    • creationDate (datetime) --

      The time the security profile was created.

    • lastModifiedDate (datetime) --

      The time the security profile was last modified.

describe_stream(**kwargs)

Gets information about a stream.

See also: AWS API Documentation

Request Syntax

response = client.describe_stream(
    streamId='string'
)
Parameters
streamId (string) --

[REQUIRED]

The stream ID.

Return type
dict
Returns
Response Syntax
{
    'streamInfo': {
        'streamId': 'string',
        'streamArn': 'string',
        'streamVersion': 123,
        'description': 'string',
        'files': [
            {
                'fileId': 123,
                's3Location': {
                    'bucket': 'string',
                    'key': 'string',
                    'version': 'string'
                }
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'roleArn': 'string'
    }
}

Response Structure

  • (dict) --
    • streamInfo (dict) --

      Information about the stream.

      • streamId (string) --

        The stream ID.

      • streamArn (string) --

        The stream ARN.

      • streamVersion (integer) --

        The stream version.

      • description (string) --

        The description of the stream.

      • files (list) --

        The files to stream.

        • (dict) --

          Represents a file to stream.

          • fileId (integer) --

            The file ID.

          • s3Location (dict) --

            The location of the file in S3.

            • bucket (string) --

              The S3 bucket.

            • key (string) --

              The S3 key.

            • version (string) --

              The S3 bucket version.

      • createdAt (datetime) --

        The date when the stream was created.

      • lastUpdatedAt (datetime) --

        The date when the stream was last updated.

      • roleArn (string) --

        An IAM role AWS IoT assumes to access your S3 files.

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,
    'billingGroupName': 'string'
}

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.

    • billingGroupName (string) --

      The name of the billing group the thing belongs to.

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)
    },
    'indexName': 'string',
    'queryString': 'string',
    'queryVersion': 'string',
    'status': 'ACTIVE'|'BUILDING'|'REBUILDING'
}

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

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

    • indexName (string) --

      The dynamic thing group index name.

    • queryString (string) --

      The dynamic thing group search query string.

    • queryVersion (string) --

      The dynamic thing group query version.

    • status (string) --

      The dynamic thing group status.

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

Disassociates a Device Defender security profile from a thing group or from this account.

See also: AWS API Documentation

Request Syntax

response = client.detach_security_profile(
    securityProfileName='string',
    securityProfileTargetArn='string'
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The security profile that is detached.

  • securityProfileTargetArn (string) --

    [REQUIRED]

    The ARN of the thing group from which the security profile is detached.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

detach_thing_principal(**kwargs)

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Note

This call is asynchronous. It might take several seconds for the detachment to propagate.

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

Returns the approximate count of unique values that match the query.

See also: AWS API Documentation

Request Syntax

response = client.get_cardinality(
    indexName='string',
    queryString='string',
    aggregationField='string',
    queryVersion='string'
)
Parameters
  • indexName (string) -- The name of the index to search.
  • queryString (string) --

    [REQUIRED]

    The search query.

  • aggregationField (string) -- The field to aggregate.
  • queryVersion (string) -- The query version.
Return type

dict

Returns

Response Syntax

{
    'cardinality': 123
}

Response Structure

  • (dict) --

    • cardinality (integer) --

      The approximate count of unique values that match the query.

get_effective_policies(**kwargs)

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_effective_policies(
    principal='string',
    cognitoIdentityPoolId='string',
    thingName='string'
)
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 indexing 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',
        'thingConnectivityIndexingMode': 'OFF'|'STATUS',
        'managedFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ],
        'customFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ]
    },
    'thingGroupIndexingConfiguration': {
        'thingGroupIndexingMode': 'OFF'|'ON',
        'managedFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ],
        'customFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • thingIndexingConfiguration (dict) --

      Thing indexing configuration.

      • thingIndexingMode (string) --

        Thing indexing mode. Valid values are:

        • REGISTRY – Your thing index contains registry data only.
        • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
        • OFF - Thing indexing is disabled.
      • thingConnectivityIndexingMode (string) --

        Thing connectivity indexing mode. Valid values are:

        • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
        • OFF - Thing connectivity status indexing is disabled.
      • managedFields (list) --

        Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

        • (dict) --

          Describes the name and data type at a field.

          • name (string) --

            The name of the field.

          • type (string) --

            The datatype of the field.

      • customFields (list) --

        Contains custom field names and their data type.

        • (dict) --

          Describes the name and data type at a field.

          • name (string) --

            The name of the field.

          • type (string) --

            The datatype of the field.

    • thingGroupIndexingConfiguration (dict) --

      The index configuration.

      • thingGroupIndexingMode (string) --

        Thing group indexing mode.

      • managedFields (list) --

        Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

        • (dict) --

          Describes the name and data type at a field.

          • name (string) --

            The name of the field.

          • type (string) --

            The datatype of the field.

      • customFields (list) --

        A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

        Contains custom field names and their data type.

        • (dict) --

          Describes the name and data type at a field.

          • name (string) --

            The name of the field.

          • type (string) --

            The datatype of the field.

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.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

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

Gets an OTA update.

See also: AWS API Documentation

Request Syntax

response = client.get_ota_update(
    otaUpdateId='string'
)
Parameters
otaUpdateId (string) --

[REQUIRED]

The OTA update ID.

Return type
dict
Returns
Response Syntax
{
    'otaUpdateInfo': {
        'otaUpdateId': 'string',
        'otaUpdateArn': 'string',
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1),
        'description': 'string',
        'targets': [
            'string',
        ],
        'protocols': [
            'MQTT'|'HTTP',
        ],
        'awsJobExecutionsRolloutConfig': {
            'maximumPerMinute': 123
        },
        'awsJobPresignedUrlConfig': {
            'expiresInSec': 123
        },
        'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
        'otaUpdateFiles': [
            {
                'fileName': 'string',
                'fileVersion': 'string',
                'fileLocation': {
                    'stream': {
                        'streamId': 'string',
                        'fileId': 123
                    },
                    's3Location': {
                        'bucket': 'string',
                        'key': 'string',
                        'version': 'string'
                    }
                },
                'codeSigning': {
                    'awsSignerJobId': 'string',
                    'startSigningJobParameter': {
                        'signingProfileParameter': {
                            'certificateArn': 'string',
                            'platform': 'string',
                            'certificatePathOnDevice': 'string'
                        },
                        'signingProfileName': 'string',
                        'destination': {
                            's3Destination': {
                                'bucket': 'string',
                                'prefix': 'string'
                            }
                        }
                    },
                    'customCodeSigning': {
                        'signature': {
                            'inlineDocument': b'bytes'
                        },
                        'certificateChain': {
                            'certificateName': 'string',
                            'inlineDocument': 'string'
                        },
                        'hashAlgorithm': 'string',
                        'signatureAlgorithm': 'string'
                    }
                },
                'attributes': {
                    'string': 'string'
                }
            },
        ],
        'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED',
        'awsIotJobId': 'string',
        'awsIotJobArn': 'string',
        'errorInfo': {
            'code': 'string',
            'message': 'string'
        },
        'additionalParameters': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • otaUpdateInfo (dict) --

      The OTA update info.

      • otaUpdateId (string) --

        The OTA update ID.

      • otaUpdateArn (string) --

        The OTA update ARN.

      • creationDate (datetime) --

        The date when the OTA update was created.

      • lastModifiedDate (datetime) --

        The date when the OTA update was last updated.

      • description (string) --

        A description of the OTA update.

      • targets (list) --

        The targets of the OTA update.

        • (string) --
      • protocols (list) --

        The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

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

        Configuration for the rollout of OTA updates.

        • maximumPerMinute (integer) --

          The maximum number of OTA update job executions started per minute.

      • awsJobPresignedUrlConfig (dict) --

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

        • expiresInSec (integer) --

          How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

      • targetSelection (string) --

        Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

      • otaUpdateFiles (list) --

        A list of files associated with the OTA update.

        • (dict) --

          Describes a file to be associated with an OTA update.

          • fileName (string) --

            The name of the file.

          • fileVersion (string) --

            The file version.

          • fileLocation (dict) --

            The location of the updated firmware.

            • stream (dict) --

              The stream that contains the OTA update.

              • streamId (string) --

                The stream ID.

              • fileId (integer) --

                The ID of a file associated with a stream.

            • s3Location (dict) --

              The location of the updated firmware in S3.

              • bucket (string) --

                The S3 bucket.

              • key (string) --

                The S3 key.

              • version (string) --

                The S3 bucket version.

          • codeSigning (dict) --

            The code signing method of the file.

            • awsSignerJobId (string) --

              The ID of the AWSSignerJob which was created to sign the file.

            • startSigningJobParameter (dict) --

              Describes the code-signing job.

              • signingProfileParameter (dict) --

                Describes the code-signing profile.

                • certificateArn (string) --

                  Certificate ARN.

                • platform (string) --

                  The hardware platform of your device.

                • certificatePathOnDevice (string) --

                  The location of the code-signing certificate on your device.

              • signingProfileName (string) --

                The code-signing profile name.

              • destination (dict) --

                The location to write the code-signed file.

                • s3Destination (dict) --

                  Describes the location in S3 of the updated firmware.

                  • bucket (string) --

                    The S3 bucket that contains the updated firmware.

                  • prefix (string) --

                    The S3 prefix.

            • customCodeSigning (dict) --

              A custom method for code signing a file.

              • signature (dict) --

                The signature for the file.

                • inlineDocument (bytes) --

                  A base64 encoded binary representation of the code signing signature.

              • certificateChain (dict) --

                The certificate chain.

                • certificateName (string) --

                  The name of the certificate.

                • inlineDocument (string) --

                  A base64 encoded binary representation of the code signing certificate chain.

              • hashAlgorithm (string) --

                The hash algorithm used to code sign the file.

              • signatureAlgorithm (string) --

                The signature algorithm used to code sign the file.

          • attributes (dict) --

            A list of name/attribute pairs.

            • (string) --
              • (string) --
      • otaUpdateStatus (string) --

        The status of the OTA update.

      • awsIotJobId (string) --

        The AWS IoT job ID associated with the OTA update.

      • awsIotJobArn (string) --

        The AWS IoT job ARN associated with the OTA update.

      • errorInfo (dict) --

        Error information associated with the OTA update.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

      • additionalParameters (dict) --

        A collection of name/value pairs

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

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles . This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

See also: AWS API Documentation

Request Syntax

response = client.get_percentiles(
    indexName='string',
    queryString='string',
    aggregationField='string',
    queryVersion='string',
    percents=[
        123.0,
    ]
)
Parameters
  • indexName (string) -- The name of the index to search.
  • queryString (string) --

    [REQUIRED]

    The query string.

  • aggregationField (string) -- The field to aggregate.
  • queryVersion (string) -- The query version.
  • percents (list) --

    The percentile groups returned.

    • (float) --
Return type

dict

Returns

Response Syntax

{
    'percentiles': [
        {
            'percent': 123.0,
            'value': 123.0
        },
    ]
}

Response Structure

  • (dict) --

    • percentiles (list) --

      The percentile values of the aggregated fields.

      • (dict) --

        Describes the percentile and percentile value.

        • percent (float) --

          The percentile.

        • value (float) --

          The value of the percentile.

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',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'generationId': '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.

    • creationDate (datetime) --

      The date the policy was created.

    • lastModifiedDate (datetime) --

      The date the policy was last modified.

    • generationId (string) --

      The generation ID of the policy.

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,
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'generationId': 'string'
}

Response Structure

  • (dict) --

    The output from the GetPolicyVersion operation.

    • policyArn (string) --

      The policy ARN.

    • policyName (string) --

      The policy name.

    • policyDocument (string) --

      The JSON document that describes the policy.

    • policyVersionId (string) --

      The policy version ID.

    • isDefaultVersion (boolean) --

      Specifies whether the policy version is the default.

    • creationDate (datetime) --

      The date the policy was created.

    • lastModifiedDate (datetime) --

      The date the policy was last modified.

    • generationId (string) --

      The generation ID of the policy version.

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

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String , only the count statistic is returned.

See also: AWS API Documentation

Request Syntax

response = client.get_statistics(
    indexName='string',
    queryString='string',
    aggregationField='string',
    queryVersion='string'
)
Parameters
  • indexName (string) -- The name of the index to search. The default value is AWS_Things .
  • queryString (string) --

    [REQUIRED]

    The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.

  • aggregationField (string) -- The aggregation field name.
  • queryVersion (string) -- The version of the query used to search.
Return type

dict

Returns

Response Syntax

{
    'statistics': {
        'count': 123,
        'average': 123.0,
        'sum': 123.0,
        'minimum': 123.0,
        'maximum': 123.0,
        'sumOfSquares': 123.0,
        'variance': 123.0,
        'stdDeviation': 123.0
    }
}

Response Structure

  • (dict) --

    • statistics (dict) --

      The statistics returned by the Fleet Indexing service based on the query and aggregation field.

      • count (integer) --

        The count of things that match the query.

      • average (float) --

        The average of the aggregated field values.

      • sum (float) --

        The sum of the aggregated field values.

      • minimum (float) --

        The minimum aggregated field value.

      • maximum (float) --

        The maximum aggregated field value.

      • sumOfSquares (float) --

        The sum of the squares of the aggregated field values.

      • variance (float) --

        The variance of the aggregated field values.

      • stdDeviation (float) --

        The standard deviation of the aggregated field values.

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',
                    'qos': 123
                },
                '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'
                },
                'cloudwatchLogs': {
                    'roleArn': 'string',
                    'logGroupName': 'string'
                },
                'elasticsearch': {
                    'roleArn': 'string',
                    'endpoint': 'string',
                    'index': 'string',
                    'type': 'string',
                    'id': 'string'
                },
                'salesforce': {
                    'token': 'string',
                    'url': 'string'
                },
                'iotAnalytics': {
                    'channelArn': 'string',
                    'channelName': 'string',
                    'roleArn': 'string'
                },
                'iotEvents': {
                    'inputName': 'string',
                    'messageId': 'string',
                    'roleArn': 'string'
                },
                'iotSiteWise': {
                    'putAssetPropertyValueEntries': [
                        {
                            'entryId': 'string',
                            'assetId': 'string',
                            'propertyId': 'string',
                            'propertyAlias': 'string',
                            'propertyValues': [
                                {
                                    'value': {
                                        'stringValue': 'string',
                                        'integerValue': 'string',
                                        'doubleValue': 'string',
                                        'booleanValue': 'string'
                                    },
                                    'timestamp': {
                                        'timeInSeconds': 'string',
                                        'offsetInNanos': 'string'
                                    },
                                    'quality': 'string'
                                },
                            ]
                        },
                    ],
                    'roleArn': 'string'
                },
                'stepFunctions': {
                    'executionNamePrefix': 'string',
                    'stateMachineName': 'string',
                    'roleArn': 'string'
                },
                'http': {
                    'url': 'string',
                    'confirmationUrl': 'string',
                    'headers': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'auth': {
                        'sigv4': {
                            'signingRegion': 'string',
                            'serviceName': 'string',
                            'roleArn': 'string'
                        }
                    }
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string',
        'errorAction': {
            'dynamoDB': {
                'tableName': 'string',
                'roleArn': 'string',
                'operation': 'string',
                'hashKeyField': 'string',
                'hashKeyValue': 'string',
                'hashKeyType': 'STRING'|'NUMBER',
                'rangeKeyField': 'string',
                'rangeKeyValue': 'string',
                'rangeKeyType': 'STRING'|'NUMBER',
                'payloadField': 'string'
            },
            'dynamoDBv2': {
                'roleArn': 'string',
                'putItem': {
                    'tableName': 'string'
                }
            },
            'lambda': {
                'functionArn': 'string'
            },
            'sns': {
                'targetArn': 'string',
                'roleArn': 'string',
                'messageFormat': 'RAW'|'JSON'
            },
            'sqs': {
                'roleArn': 'string',
                'queueUrl': 'string',
                'useBase64': True|False
            },
            'kinesis': {
                'roleArn': 'string',
                'streamName': 'string',
                'partitionKey': 'string'
            },
            'republish': {
                'roleArn': 'string',
                'topic': 'string',
                'qos': 123
            },
            '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'
            },
            'cloudwatchLogs': {
                'roleArn': 'string',
                'logGroupName': 'string'
            },
            'elasticsearch': {
                'roleArn': 'string',
                'endpoint': 'string',
                'index': 'string',
                'type': 'string',
                'id': 'string'
            },
            'salesforce': {
                'token': 'string',
                'url': 'string'
            },
            'iotAnalytics': {
                'channelArn': 'string',
                'channelName': 'string',
                'roleArn': 'string'
            },
            'iotEvents': {
                'inputName': 'string',
                'messageId': 'string',
                'roleArn': 'string'
            },
            'iotSiteWise': {
                'putAssetPropertyValueEntries': [
                    {
                        'entryId': 'string',
                        'assetId': 'string',
                        'propertyId': 'string',
                        'propertyAlias': 'string',
                        'propertyValues': [
                            {
                                'value': {
                                    'stringValue': 'string',
                                    'integerValue': 'string',
                                    'doubleValue': 'string',
                                    'booleanValue': 'string'
                                },
                                'timestamp': {
                                    'timeInSeconds': 'string',
                                    'offsetInNanos': 'string'
                                },
                                'quality': 'string'
                            },
                        ]
                    },
                ],
                'roleArn': 'string'
            },
            'stepFunctions': {
                'executionNamePrefix': 'string',
                'stateMachineName': 'string',
                'roleArn': 'string'
            },
            'http': {
                'url': 'string',
                'confirmationUrl': 'string',
                'headers': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'auth': {
                    'sigv4': {
                        'signingRegion': 'string',
                        'serviceName': 'string',
                        'roleArn': '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) --

              (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

            • qos (integer) --

              The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

          • cloudwatchLogs (dict) --

            Send data to CloudWatch Logs.

            • roleArn (string) --

              The IAM role that allows access to the CloudWatch log.

            • logGroupName (string) --

              The CloudWatch log group to which the action sends 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.

          • iotAnalytics (dict) --

            Sends message data to an AWS IoT Analytics channel.

            • channelArn (string) --

              (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

            • channelName (string) --

              The name of the IoT Analytics channel to which message data will be sent.

            • roleArn (string) --

              The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

          • iotEvents (dict) --

            Sends an input to an AWS IoT Events detector.

            • inputName (string) --

              The name of the AWS IoT Events input.

            • messageId (string) --

              [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

            • roleArn (string) --

              The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

          • iotSiteWise (dict) --

            Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

            • putAssetPropertyValueEntries (list) --

              A list of asset property value entries.

              • (dict) --

                An asset property value entry containing the following information.

                • entryId (string) --

                  Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

                • assetId (string) --

                  The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

                • propertyId (string) --

                  The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

                • propertyAlias (string) --

                  The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

                • propertyValues (list) --

                  A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

                  • (dict) --

                    An asset property value entry containing the following information.

                    • value (dict) --

                      The value of the asset property.

                      • stringValue (string) --

                        Optional. The string value of the value entry. Accepts substitution templates.

                      • integerValue (string) --

                        Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                      • doubleValue (string) --

                        Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                      • booleanValue (string) --

                        Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                    • timestamp (dict) --

                      The asset property value timestamp.

                      • timeInSeconds (string) --

                        A string that contains the time in seconds since epoch. Accepts substitution templates.

                      • offsetInNanos (string) --

                        Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                    • quality (string) --

                      Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

            • roleArn (string) --

              The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

          • stepFunctions (dict) --

            Starts execution of a Step Functions state machine.

            • executionNamePrefix (string) --

              (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

            • stateMachineName (string) --

              The name of the Step Functions state machine whose execution will be started.

            • roleArn (string) --

              The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

          • http (dict) --

            Send data to an HTTPS endpoint.

            • url (string) --

              The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

            • confirmationUrl (string) --

              The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

            • headers (list) --

              The HTTP headers to send with the message data.

              • (dict) --

                The HTTP action header.

                • key (string) --

                  The HTTP header key.

                • value (string) --

                  The HTTP header value. Substitution templates are supported.

            • auth (dict) --

              The authentication method to use when sending data to an HTTPS endpoint.

              • sigv4 (dict) --

                Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

                • signingRegion (string) --

                  The signing region.

                • serviceName (string) --

                  The service name to use while signing with Sig V4.

                • roleArn (string) --

                  The ARN of the signing role.

      • ruleDisabled (boolean) --

        Specifies whether the rule is disabled.

      • awsIotSqlVersion (string) --

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

      • errorAction (dict) --

        The action to perform when an error occurs.

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

            (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

          • qos (integer) --

            The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

        • cloudwatchLogs (dict) --

          Send data to CloudWatch Logs.

          • roleArn (string) --

            The IAM role that allows access to the CloudWatch log.

          • logGroupName (string) --

            The CloudWatch log group to which the action sends 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.

        • iotAnalytics (dict) --

          Sends message data to an AWS IoT Analytics channel.

          • channelArn (string) --

            (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

          • channelName (string) --

            The name of the IoT Analytics channel to which message data will be sent.

          • roleArn (string) --

            The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

        • iotEvents (dict) --

          Sends an input to an AWS IoT Events detector.

          • inputName (string) --

            The name of the AWS IoT Events input.

          • messageId (string) --

            [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

          • roleArn (string) --

            The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

        • iotSiteWise (dict) --

          Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

          • putAssetPropertyValueEntries (list) --

            A list of asset property value entries.

            • (dict) --

              An asset property value entry containing the following information.

              • entryId (string) --

                Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

              • assetId (string) --

                The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyId (string) --

                The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyAlias (string) --

                The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyValues (list) --

                A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

                • (dict) --

                  An asset property value entry containing the following information.

                  • value (dict) --

                    The value of the asset property.

                    • stringValue (string) --

                      Optional. The string value of the value entry. Accepts substitution templates.

                    • integerValue (string) --

                      Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                    • doubleValue (string) --

                      Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                    • booleanValue (string) --

                      Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                  • timestamp (dict) --

                    The asset property value timestamp.

                    • timeInSeconds (string) --

                      A string that contains the time in seconds since epoch. Accepts substitution templates.

                    • offsetInNanos (string) --

                      Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                  • quality (string) --

                    Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

          • roleArn (string) --

            The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

        • stepFunctions (dict) --

          Starts execution of a Step Functions state machine.

          • executionNamePrefix (string) --

            (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

          • stateMachineName (string) --

            The name of the Step Functions state machine whose execution will be started.

          • roleArn (string) --

            The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

        • http (dict) --

          Send data to an HTTPS endpoint.

          • url (string) --

            The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

          • confirmationUrl (string) --

            The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

          • headers (list) --

            The HTTP headers to send with the message data.

            • (dict) --

              The HTTP action header.

              • key (string) --

                The HTTP header key.

              • value (string) --

                The HTTP header value. Substitution templates are supported.

          • auth (dict) --

            The authentication method to use when sending data to an HTTPS endpoint.

            • sigv4 (dict) --

              Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

              • signingRegion (string) --

                The signing region.

              • serviceName (string) --

                The service name to use while signing with Sig V4.

              • roleArn (string) --

                The ARN of the signing role.

get_topic_rule_destination(**kwargs)

Gets information about a topic rule destination.

See also: AWS API Documentation

Request Syntax

response = client.get_topic_rule_destination(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

The ARN of the topic rule destination.

Return type
dict
Returns
Response Syntax
{
    'topicRuleDestination': {
        'arn': 'string',
        'status': 'ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR',
        'statusReason': 'string',
        'httpUrlProperties': {
            'confirmationUrl': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • topicRuleDestination (dict) --

      The topic rule destination.

      • arn (string) --

        The topic rule destination URL.

      • status (string) --

        The status of the topic rule destination. Valid values are:

        IN_PROGRESS

        A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

        ENABLED

        Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination .

        DISABLED

        Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .

        ERROR

        Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      • statusReason (string) --

        Additional details or reason why the topic rule destination is in the current status.

      • httpUrlProperties (dict) --

        Properties of the HTTP URL.

        • confirmationUrl (string) --

          The URL used to confirm the HTTP topic rule destination URL.

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)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_active_violations(**kwargs)

Lists the active violations for a given Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.list_active_violations(
    thingName='string',
    securityProfileName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • thingName (string) -- The name of the thing whose active violations are listed.
  • securityProfileName (string) -- The name of the Device Defender security profile for which violations are listed.
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

Response Syntax

{
    'activeViolations': [
        {
            'violationId': 'string',
            'thingName': 'string',
            'securityProfileName': 'string',
            'behavior': {
                'name': 'string',
                'metric': 'string',
                'metricDimension': {
                    'dimensionName': 'string',
                    'operator': 'IN'|'NOT_IN'
                },
                'criteria': {
                    'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                    'value': {
                        'count': 123,
                        'cidrs': [
                            'string',
                        ],
                        'ports': [
                            123,
                        ]
                    },
                    'durationSeconds': 123,
                    'consecutiveDatapointsToAlarm': 123,
                    'consecutiveDatapointsToClear': 123,
                    'statisticalThreshold': {
                        'statistic': 'string'
                    }
                }
            },
            'lastViolationValue': {
                'count': 123,
                'cidrs': [
                    'string',
                ],
                'ports': [
                    123,
                ]
            },
            'lastViolationTime': datetime(2015, 1, 1),
            'violationStartTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • activeViolations (list) --

      The list of active violations.

      • (dict) --

        Information about an active Device Defender security profile behavior violation.

        • violationId (string) --

          The ID of the active violation.

        • thingName (string) --

          The name of the thing responsible for the active violation.

        • securityProfileName (string) --

          The security profile whose behavior is in violation.

        • behavior (dict) --

          The behavior which is being violated.

          • name (string) --

            The name you have given to the behavior.

          • metric (string) --

            What is measured by the behavior.

          • metricDimension (dict) --

            The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

            • dimensionName (string) --

              A unique identifier for the dimension.

            • operator (string) --

              Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

          • criteria (dict) --

            The criteria that determine if a device is behaving normally in regard to the metric .

            • comparisonOperator (string) --

              The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

            • value (dict) --

              The value to be compared with the metric .

              • count (integer) --

                If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

              • cidrs (list) --

                If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

                • (string) --
              • ports (list) --

                If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

                • (integer) --
            • durationSeconds (integer) --

              Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

            • consecutiveDatapointsToAlarm (integer) --

              If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

            • consecutiveDatapointsToClear (integer) --

              If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

            • statisticalThreshold (dict) --

              A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

              • statistic (string) --

                The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

        • lastViolationValue (dict) --

          The value of the metric (the measurement) which caused the most recent violation.

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • lastViolationTime (datetime) --

          The time the most recent violation occurred.

        • violationStartTime (datetime) --

          The time the violation started.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

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 or principal 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_audit_findings(**kwargs)

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

See also: AWS API Documentation

Request Syntax

response = client.list_audit_findings(
    taskId='string',
    checkName='string',
    resourceIdentifier={
        'deviceCertificateId': 'string',
        'caCertificateId': 'string',
        'cognitoIdentityPoolId': 'string',
        'clientId': 'string',
        'policyVersionIdentifier': {
            'policyName': 'string',
            'policyVersionId': 'string'
        },
        'account': 'string',
        'iamRoleArn': 'string',
        'roleAliasArn': 'string'
    },
    maxResults=123,
    nextToken='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters
  • taskId (string) -- A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
  • checkName (string) -- A filter to limit results to the findings for the specified audit check.
  • resourceIdentifier (dict) --

    Information identifying the noncompliant resource.

    • deviceCertificateId (string) --

      The ID of the certificate attached to the resource.

    • caCertificateId (string) --

      The ID of the CA certificate used to authorize the certificate.

    • cognitoIdentityPoolId (string) --

      The ID of the Amazon Cognito identity pool.

    • clientId (string) --

      The client ID.

    • policyVersionIdentifier (dict) --

      The version of the policy associated with the resource.

      • policyName (string) --

        The name of the policy.

      • policyVersionId (string) --

        The ID of the version of the policy associated with the resource.

    • account (string) --

      The account with which the resource is associated.

    • iamRoleArn (string) --

      The ARN of the IAM role that has overly permissive actions.

    • roleAliasArn (string) --

      The ARN of the role alias that has overly permissive actions.

  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
  • nextToken (string) -- The token for the next set of results.
  • startTime (datetime) -- A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
  • endTime (datetime) -- A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
Return type

dict

Returns

Response Syntax

{
    'findings': [
        {
            'findingId': 'string',
            'taskId': 'string',
            'checkName': 'string',
            'taskStartTime': datetime(2015, 1, 1),
            'findingTime': datetime(2015, 1, 1),
            'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW',
            'nonCompliantResource': {
                'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
                'resourceIdentifier': {
                    'deviceCertificateId': 'string',
                    'caCertificateId': 'string',
                    'cognitoIdentityPoolId': 'string',
                    'clientId': 'string',
                    'policyVersionIdentifier': {
                        'policyName': 'string',
                        'policyVersionId': 'string'
                    },
                    'account': 'string',
                    'iamRoleArn': 'string',
                    'roleAliasArn': 'string'
                },
                'additionalInfo': {
                    'string': 'string'
                }
            },
            'relatedResources': [
                {
                    'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
                    'resourceIdentifier': {
                        'deviceCertificateId': 'string',
                        'caCertificateId': 'string',
                        'cognitoIdentityPoolId': 'string',
                        'clientId': 'string',
                        'policyVersionIdentifier': {
                            'policyName': 'string',
                            'policyVersionId': 'string'
                        },
                        'account': 'string',
                        'iamRoleArn': 'string',
                        'roleAliasArn': 'string'
                    },
                    'additionalInfo': {
                        'string': 'string'
                    }
                },
            ],
            'reasonForNonCompliance': 'string',
            'reasonForNonComplianceCode': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • findings (list) --

      The findings (results) of the audit.

      • (dict) --

        The findings (results) of the audit.

        • findingId (string) --

          A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

        • taskId (string) --

          The ID of the audit that generated this result (finding).

        • checkName (string) --

          The audit check that generated this result.

        • taskStartTime (datetime) --

          The time the audit started.

        • findingTime (datetime) --

          The time the result (finding) was discovered.

        • severity (string) --

          The severity of the result (finding).

        • nonCompliantResource (dict) --

          The resource that was found to be noncompliant with the audit check.

          • resourceType (string) --

            The type of the noncompliant resource.

          • resourceIdentifier (dict) --

            Information that identifies the noncompliant resource.

            • deviceCertificateId (string) --

              The ID of the certificate attached to the resource.

            • caCertificateId (string) --

              The ID of the CA certificate used to authorize the certificate.

            • cognitoIdentityPoolId (string) --

              The ID of the Amazon Cognito identity pool.

            • clientId (string) --

              The client ID.

            • policyVersionIdentifier (dict) --

              The version of the policy associated with the resource.

              • policyName (string) --

                The name of the policy.

              • policyVersionId (string) --

                The ID of the version of the policy associated with the resource.

            • account (string) --

              The account with which the resource is associated.

            • iamRoleArn (string) --

              The ARN of the IAM role that has overly permissive actions.

            • roleAliasArn (string) --

              The ARN of the role alias that has overly permissive actions.

          • additionalInfo (dict) --

            Other information about the noncompliant resource.

            • (string) --
              • (string) --
        • relatedResources (list) --

          The list of related resources.

          • (dict) --

            Information about a related resource.

            • resourceType (string) --

              The type of resource.

            • resourceIdentifier (dict) --

              Information that identifies the resource.

              • deviceCertificateId (string) --

                The ID of the certificate attached to the resource.

              • caCertificateId (string) --

                The ID of the CA certificate used to authorize the certificate.

              • cognitoIdentityPoolId (string) --

                The ID of the Amazon Cognito identity pool.

              • clientId (string) --

                The client ID.

              • policyVersionIdentifier (dict) --

                The version of the policy associated with the resource.

                • policyName (string) --

                  The name of the policy.

                • policyVersionId (string) --

                  The ID of the version of the policy associated with the resource.

              • account (string) --

                The account with which the resource is associated.

              • iamRoleArn (string) --

                The ARN of the IAM role that has overly permissive actions.

              • roleAliasArn (string) --

                The ARN of the role alias that has overly permissive actions.

            • additionalInfo (dict) --

              Other information about the resource.

              • (string) --
                • (string) --
        • reasonForNonCompliance (string) --

          The reason the resource was noncompliant.

        • reasonForNonComplianceCode (string) --

          A code that indicates the reason that the resource was noncompliant.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_audit_mitigation_actions_executions(**kwargs)

Gets the status of audit mitigation action tasks that were executed.

See also: AWS API Documentation

Request Syntax

response = client.list_audit_mitigation_actions_executions(
    taskId='string',
    actionStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
    findingId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • taskId (string) --

    [REQUIRED]

    Specify this filter to limit results to actions for a specific audit mitigation actions task.

  • actionStatus (string) -- Specify this filter to limit results to those with a specific status.
  • findingId (string) --

    [REQUIRED]

    Specify this filter to limit results to those that were applied to a specific audit finding.

  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
  • nextToken (string) -- The token for the next set of results.
Return type

dict

Returns

Response Syntax

{
    'actionsExecutions': [
        {
            'taskId': 'string',
            'findingId': 'string',
            'actionName': 'string',
            'actionId': 'string',
            'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'errorCode': 'string',
            'message': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • actionsExecutions (list) --

      A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

      • (dict) --

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

        • taskId (string) --

          The unique identifier for the task that applies the mitigation action.

        • findingId (string) --

          The unique identifier for the findings to which the task and associated mitigation action are applied.

        • actionName (string) --

          The friendly name of the mitigation action being applied by the task.

        • actionId (string) --

          The unique identifier for the mitigation action being applied by the task.

        • status (string) --

          The current status of the task being executed.

        • startTime (datetime) --

          The date and time when the task was started.

        • endTime (datetime) --

          The date and time when the task was completed or canceled. Blank if the task is still running.

        • errorCode (string) --

          If an error occurred, the code that indicates which type of error occurred.

        • message (string) --

          If an error occurred, a message that describes the error.

    • nextToken (string) --

      The token for the next set of results.

list_audit_mitigation_actions_tasks(**kwargs)

Gets a list of audit mitigation action tasks that match the specified filters.

See also: AWS API Documentation

Request Syntax

response = client.list_audit_mitigation_actions_tasks(
    auditTaskId='string',
    findingId='string',
    taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    maxResults=123,
    nextToken='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters
  • auditTaskId (string) -- Specify this filter to limit results to tasks that were applied to results for a specific audit.
  • findingId (string) -- Specify this filter to limit results to tasks that were applied to a specific audit finding.
  • taskStatus (string) -- Specify this filter to limit results to tasks that are in a specific state.
  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
  • nextToken (string) -- The token for the next set of results.
  • startTime (datetime) --

    [REQUIRED]

    Specify this filter to limit results to tasks that began on or after a specific date and time.

  • endTime (datetime) --

    [REQUIRED]

    Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

Return type

dict

Returns

Response Syntax

{
    'tasks': [
        {
            'taskId': 'string',
            'startTime': datetime(2015, 1, 1),
            'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • tasks (list) --

      The collection of audit mitigation tasks that matched the filter criteria.

      • (dict) --

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

        • taskId (string) --

          The unique identifier for the task.

        • startTime (datetime) --

          The time at which the audit mitigation actions task was started.

        • taskStatus (string) --

          The current state of the audit mitigation actions task.

    • nextToken (string) --

      The token for the next set of results.

list_audit_tasks(**kwargs)

Lists the Device Defender audits that have been performed during a given time period.

See also: AWS API Documentation

Request Syntax

response = client.list_audit_tasks(
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    taskType='ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
    taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    nextToken='string',
    maxResults=123
)
Parameters
  • startTime (datetime) --

    [REQUIRED]

    The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

  • endTime (datetime) --

    [REQUIRED]

    The end of the time period.

  • taskType (string) -- A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
  • taskStatus (string) -- A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
Return type

dict

Returns

Response Syntax

{
    'tasks': [
        {
            'taskId': 'string',
            'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
            'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • tasks (list) --

      The audits that were performed during the specified time period.

      • (dict) --

        The audits that were performed.

        • taskId (string) --

          The ID of this audit.

        • taskStatus (string) --

          The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

        • taskType (string) --

          The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

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

Lists the billing groups you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_billing_groups(
    nextToken='string',
    maxResults=123,
    namePrefixFilter='string'
)
Parameters
  • nextToken (string) -- The token to retrieve the next set of results.
  • maxResults (integer) -- The maximum number of results to return per request.
  • namePrefixFilter (string) -- Limit the results to billing groups whose names have the given prefix.
Return type

dict

Returns

Response Syntax

{
    'billingGroups': [
        {
            'groupName': 'string',
            'groupArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • billingGroups (list) --

      The list of billing 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_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. (The last part of the certificate ARN contains the certificate ID.)

        • status (string) --

          The status of the certificate.

          The status value REGISTER_INACTIVE is deprecated and should not be used.

        • creationDate (datetime) --

          The date and time the certificate was created.

    • nextMarker (string) --

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

list_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. (The last part of the certificate ARN contains the certificate ID.)

        • status (string) --

          The status of the certificate.

          The status value REGISTER_INACTIVE is deprecated and should not be used.

        • creationDate (datetime) --

          The date and time the certificate was created.

    • nextMarker (string) --

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

list_dimensions(**kwargs)

List the set of dimensions that are defined for your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_dimensions(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to retrieve at one time.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • dimensionNames (list) --

      A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

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

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_domain_configurations(**kwargs)

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_configurations(
    marker='string',
    pageSize=123,
    serviceType='DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
)
Parameters
  • marker (string) -- The marker for the next set of results.
  • pageSize (integer) -- The result page size.
  • serviceType (string) -- The type of service delivered by the endpoint.
Return type

dict

Returns

Response Syntax

{
    'domainConfigurations': [
        {
            'domainConfigurationName': 'string',
            'domainConfigurationArn': 'string',
            'serviceType': 'DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
        },
    ],
    'nextMarker': 'string'
}

Response Structure

  • (dict) --

    • domainConfigurations (list) --

      A list of objects that contain summary information about the user's domain configurations.

      • (dict) --

        The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an AWS-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

        • Data
        • Jobs
        • CredentialProvider

        Note

        The domain configuration feature is in public preview and is subject to change.

        • domainConfigurationName (string) --

          The name of the domain configuration. This value must be unique to a region.

        • domainConfigurationArn (string) --

          The ARN of the domain configuration.

        • serviceType (string) --

          The type of service delivered by the endpoint.

    • nextMarker (string) --

      The marker for the next set of 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'|'TIMED_OUT'|'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'|'TIMED_OUT'|'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 seconds since the epoch, when the job execution was queued.

          • startedAt (datetime) --

            The time, in seconds since the epoch, when the job execution started.

          • lastUpdatedAt (datetime) --

            The time, in seconds 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'|'TIMED_OUT'|'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'|'TIMED_OUT'|'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 seconds since the epoch, when the job execution was queued.

          • startedAt (datetime) --

            The time, in seconds since the epoch, when the job execution started.

          • lastUpdatedAt (datetime) --

            The time, in seconds 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'|'DELETION_IN_PROGRESS',
    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'|'DELETION_IN_PROGRESS',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • jobs (list) --

      A list of jobs.

      • (dict) --

        The job summary.

        • jobArn (string) --

          The job ARN.

        • jobId (string) --

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

        • thingGroupId (string) --

          The ID of the thing group.

        • targetSelection (string) --

          Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        • status (string) --

          The job summary status.

        • createdAt (datetime) --

          The time, in seconds since the epoch, when the job was created.

        • lastUpdatedAt (datetime) --

          The time, in seconds since the epoch, when the job was last updated.

        • completedAt (datetime) --

          The time, in seconds 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_mitigation_actions(**kwargs)

Gets a list of all mitigation actions that match the specified filter criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_mitigation_actions(
    actionType='UPDATE_DEVICE_CERTIFICATE'|'UPDATE_CA_CERTIFICATE'|'ADD_THINGS_TO_THING_GROUP'|'REPLACE_DEFAULT_POLICY_VERSION'|'ENABLE_IOT_LOGGING'|'PUBLISH_FINDING_TO_SNS',
    maxResults=123,
    nextToken='string'
)
Parameters
  • actionType (string) -- Specify a value to limit the result to mitigation actions with a specific action type.
  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
  • nextToken (string) -- The token for the next set of results.
Return type

dict

Returns

Response Syntax

{
    'actionIdentifiers': [
        {
            'actionName': 'string',
            'actionArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • actionIdentifiers (list) --

      A set of actions that matched the specified filter criteria.

      • (dict) --

        Information that identifies a mitigation action. This information is returned by ListMitigationActions.

        • actionName (string) --

          The friendly name of the mitigation action.

        • actionArn (string) --

          The IAM role ARN used to apply this mitigation action.

        • creationDate (datetime) --

          The date when this mitigation action was created.

    • nextToken (string) --

      The token for the next set of results.

list_ota_updates(**kwargs)

Lists OTA updates.

See also: AWS API Documentation

Request Syntax

response = client.list_ota_updates(
    maxResults=123,
    nextToken='string',
    otaUpdateStatus='CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
)
Parameters
  • maxResults (integer) -- The maximum number of results to return at one time.
  • nextToken (string) -- A token used to retrieve the next set of results.
  • otaUpdateStatus (string) -- The OTA update job status.
Return type

dict

Returns

Response Syntax

{
    'otaUpdates': [
        {
            'otaUpdateId': 'string',
            'otaUpdateArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • otaUpdates (list) --

      A list of OTA update jobs.

      • (dict) --

        An OTA update summary.

        • otaUpdateId (string) --

          The OTA update ID.

        • otaUpdateArn (string) --

          The OTA update ARN.

        • creationDate (datetime) --

          The date when the OTA update was created.

    • nextToken (string) --

      A token to use to get the next set of results.

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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

See also: AWS API Documentation

Request Syntax

response = client.list_principal_things(
    nextToken='string',
    maxResults=123,
    principal='string'
)
Parameters
  • nextToken (string) -- The token to retrieve the next set of 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_provisioning_template_versions(**kwargs)

A list of fleet provisioning template versions.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioning_template_versions(
    templateName='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The name of the fleet provisioning template.

  • maxResults (integer) -- The maximum number of results to return at one time.
  • nextToken (string) -- A token to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'versions': [
        {
            'versionId': 123,
            'creationDate': datetime(2015, 1, 1),
            'isDefaultVersion': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • versions (list) --

      The list of fleet provisioning template versions.

      • (dict) --

        A summary of information about a fleet provision template version.

        • versionId (integer) --

          The ID of the fleet privisioning template version.

        • creationDate (datetime) --

          The date when the fleet provisioning template version was created

        • isDefaultVersion (boolean) --

          True if the fleet provisioning template version is the default version, otherwise false.

    • nextToken (string) --

      A token to retrieve the next set of results.

list_provisioning_templates(**kwargs)

Lists the fleet provisioning templates in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioning_templates(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to return at one time.
  • nextToken (string) -- A token to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'templates': [
        {
            'templateArn': 'string',
            'templateName': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastModifiedDate': datetime(2015, 1, 1),
            'enabled': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • templates (list) --

      A list of fleet provisioning templates

      • (dict) --

        A summary of information about a fleet provisioning template.

        • templateArn (string) --

          The ARN of the fleet provisioning template.

        • templateName (string) --

          The name of the fleet provisioning template.

        • description (string) --

          The description of the fleet provisioning template.

        • creationDate (datetime) --

          The date when the fleet provisioning template summary was created.

        • lastModifiedDate (datetime) --

          The date when the fleet provisioning template summary was last modified.

        • enabled (boolean) --

          True if the fleet provision template is enabled, otherwise false.

    • nextToken (string) --

      A token to retrieve the next set of 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_scheduled_audits(**kwargs)

Lists all of your scheduled audits.

See also: AWS API Documentation

Request Syntax

response = client.list_scheduled_audits(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time. The default is 25.
Return type

dict

Returns

Response Syntax

{
    'scheduledAudits': [
        {
            'scheduledAuditName': 'string',
            'scheduledAuditArn': 'string',
            'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
            'dayOfMonth': 'string',
            'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • scheduledAudits (list) --

      The list of scheduled audits.

      • (dict) --

        Information about the scheduled audit.

        • scheduledAuditName (string) --

          The name of the scheduled audit.

        • scheduledAuditArn (string) --

          The ARN of the scheduled audit.

        • frequency (string) --

          How often the scheduled audit occurs.

        • dayOfMonth (string) --

          The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

        • dayOfWeek (string) --

          The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_security_profiles(**kwargs)

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_security_profiles(
    nextToken='string',
    maxResults=123,
    dimensionName='string'
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
  • dimensionName (string) -- A filter to limit results to the security profiles that use the defined dimension.
Return type

dict

Returns

Response Syntax

{
    'securityProfileIdentifiers': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileIdentifiers (list) --

      A list of security profile identifiers (names and ARNs).

      • (dict) --

        Identifying information for a Device Defender security profile.

        • name (string) --

          The name you have given to the security profile.

        • arn (string) --

          The ARN of the security profile.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_security_profiles_for_target(**kwargs)

Lists the Device Defender security profiles attached to a target (thing group).

See also: AWS API Documentation

Request Syntax

response = client.list_security_profiles_for_target(
    nextToken='string',
    maxResults=123,
    recursive=True|False,
    securityProfileTargetArn='string'
)
Parameters
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
  • recursive (boolean) -- If true, return child groups too.
  • securityProfileTargetArn (string) --

    [REQUIRED]

    The ARN of the target (thing group) whose attached security profiles you want to get.

Return type

dict

Returns

Response Syntax

{
    'securityProfileTargetMappings': [
        {
            'securityProfileIdentifier': {
                'name': 'string',
                'arn': 'string'
            },
            'target': {
                'arn': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileTargetMappings (list) --

      A list of security profiles and their associated targets.

      • (dict) --

        Information about a security profile and the target associated with it.

        • securityProfileIdentifier (dict) --

          Information that identifies the security profile.

          • name (string) --

            The name you have given to the security profile.

          • arn (string) --

            The ARN of the security profile.

        • target (dict) --

          Information about the target (thing group) associated with the security profile.

          • arn (string) --

            The ARN of the security profile.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_streams(**kwargs)

Lists all of the streams in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_streams(
    maxResults=123,
    nextToken='string',
    ascendingOrder=True|False
)
Parameters
  • maxResults (integer) -- The maximum number of results to return at a time.
  • nextToken (string) -- A token used to get the next set of results.
  • ascendingOrder (boolean) -- Set to true to return the list of streams in ascending order.
Return type

dict

Returns

Response Syntax

{
    'streams': [
        {
            'streamId': 'string',
            'streamArn': 'string',
            'streamVersion': 123,
            'description': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • streams (list) --

      A list of streams.

      • (dict) --

        A summary of a stream.

        • streamId (string) --

          The stream ID.

        • streamArn (string) --

          The stream ARN.

        • streamVersion (integer) --

          The stream version.

        • description (string) --

          A description of the stream.

    • nextToken (string) --

      A token used to get the next set of results.

list_tags_for_resource(**kwargs)

Lists the tags (metadata) you have assigned to the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string',
    nextToken='string'
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • nextToken (string) -- The token to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • tags (list) --

      The list of tags assigned to the resource.

      • (dict) --

        A set of key/value pairs that are used to manage the resource.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.

    • nextToken (string) --

      The token used to get the next set of results, or null if there are no additional 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_targets_for_security_profile(**kwargs)

Lists the targets (thing groups) associated with a given Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.list_targets_for_security_profile(
    securityProfileName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The security profile.

  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

Response Syntax

{
    'securityProfileTargets': [
        {
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileTargets (list) --

      The thing groups to which the security profile is attached.

      • (dict) --

        A target to which an alert is sent when a security profile behavior is violated.

        • arn (string) --

          The ARN of the security profile.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

list_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 to retrieve the next set of 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 to retrieve the next set of 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. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

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 used to get the next set of results, or null if there are no additional 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 to retrieve the next set of 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 to retrieve the next set of 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 to retrieve the next set of 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_billing_group(**kwargs)

Lists the things you have added to the given billing group.

See also: AWS API Documentation

Request Syntax

response = client.list_things_in_billing_group(
    billingGroupName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • billingGroupName (string) --

    [REQUIRED]

    The name of the billing group.

  • 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

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

Response Structure

  • (dict) --

    • things (list) --

      A list of things in the billing group.

      • (string) --
    • 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 to retrieve the next set of 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_rule_destinations(**kwargs)

Lists all the topic rule destinations in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_topic_rule_destinations(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to return at one time.
  • nextToken (string) -- The token to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'destinationSummaries': [
        {
            'arn': 'string',
            'status': 'ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR',
            'statusReason': 'string',
            'httpUrlSummary': {
                'confirmationUrl': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • destinationSummaries (list) --

      Information about a topic rule destination.

      • (dict) --

        Information about the topic rule destination.

        • arn (string) --

          The topic rule destination ARN.

        • status (string) --

          The status of the topic rule destination. Valid values are:

          IN_PROGRESS

          A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

          ENABLED

          Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination .

          DISABLED

          Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .

          ERROR

          Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

        • statusReason (string) --

          The reason the topic rule destination is in the current status.

        • httpUrlSummary (dict) --

          Information about the HTTP URL.

          • confirmationUrl (string) --

            The URL used to confirm ownership of or access to the HTTP topic rule destination URL.

    • nextToken (string) --

      The token to retrieve the next set of 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.

list_violation_events(**kwargs)

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

See also: AWS API Documentation

Request Syntax

response = client.list_violation_events(
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    thingName='string',
    securityProfileName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • startTime (datetime) --

    [REQUIRED]

    The start time for the alerts to be listed.

  • endTime (datetime) --

    [REQUIRED]

    The end time for the alerts to be listed.

  • thingName (string) -- A filter to limit results to those alerts caused by the specified thing.
  • securityProfileName (string) -- A filter to limit results to those alerts generated by the specified security profile.
  • nextToken (string) -- The token for the next set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

Response Syntax

{
    'violationEvents': [
        {
            'violationId': 'string',
            'thingName': 'string',
            'securityProfileName': 'string',
            'behavior': {
                'name': 'string',
                'metric': 'string',
                'metricDimension': {
                    'dimensionName': 'string',
                    'operator': 'IN'|'NOT_IN'
                },
                'criteria': {
                    'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                    'value': {
                        'count': 123,
                        'cidrs': [
                            'string',
                        ],
                        'ports': [
                            123,
                        ]
                    },
                    'durationSeconds': 123,
                    'consecutiveDatapointsToAlarm': 123,
                    'consecutiveDatapointsToClear': 123,
                    'statisticalThreshold': {
                        'statistic': 'string'
                    }
                }
            },
            'metricValue': {
                'count': 123,
                'cidrs': [
                    'string',
                ],
                'ports': [
                    123,
                ]
            },
            'violationEventType': 'in-alarm'|'alarm-cleared'|'alarm-invalidated',
            'violationEventTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • violationEvents (list) --

      The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

      • (dict) --

        Information about a Device Defender security profile behavior violation.

        • violationId (string) --

          The ID of the violation event.

        • thingName (string) --

          The name of the thing responsible for the violation event.

        • securityProfileName (string) --

          The name of the security profile whose behavior was violated.

        • behavior (dict) --

          The behavior which was violated.

          • name (string) --

            The name you have given to the behavior.

          • metric (string) --

            What is measured by the behavior.

          • metricDimension (dict) --

            The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

            • dimensionName (string) --

              A unique identifier for the dimension.

            • operator (string) --

              Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

          • criteria (dict) --

            The criteria that determine if a device is behaving normally in regard to the metric .

            • comparisonOperator (string) --

              The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

            • value (dict) --

              The value to be compared with the metric .

              • count (integer) --

                If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

              • cidrs (list) --

                If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

                • (string) --
              • ports (list) --

                If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

                • (integer) --
            • durationSeconds (integer) --

              Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

            • consecutiveDatapointsToAlarm (integer) --

              If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

            • consecutiveDatapointsToClear (integer) --

              If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

            • statisticalThreshold (dict) --

              A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

              • statistic (string) --

                The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

        • metricValue (dict) --

          The value of the metric (the measurement).

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • violationEventType (string) --

          The type of violation event.

        • violationEventTime (datetime) --

          The time the violation event occurred.

    • nextToken (string) --

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

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 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 in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.

See also: AWS API Documentation

Request Syntax

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

dict

Returns

Response Syntax

{
    'certificatePem': 'string',
    'resourceArns': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • certificatePem (string) --

      .

    • 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. (The last part of the certificate ARN contains the certificate ID.)

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

None

remove_thing_from_billing_group(**kwargs)

Removes the given thing from the billing group.

See also: AWS API Documentation

Request Syntax

response = client.remove_thing_from_billing_group(
    billingGroupName='string',
    billingGroupArn='string',
    thingName='string',
    thingArn='string'
)
Parameters
  • billingGroupName (string) -- The name of the billing group.
  • billingGroupArn (string) -- The ARN of the billing group.
  • thingName (string) -- The name of the thing to be removed from the billing group.
  • thingArn (string) -- The ARN of the thing to be removed from the billing group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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',
                    'qos': 123
                },
                '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'
                },
                'cloudwatchLogs': {
                    'roleArn': 'string',
                    'logGroupName': 'string'
                },
                'elasticsearch': {
                    'roleArn': 'string',
                    'endpoint': 'string',
                    'index': 'string',
                    'type': 'string',
                    'id': 'string'
                },
                'salesforce': {
                    'token': 'string',
                    'url': 'string'
                },
                'iotAnalytics': {
                    'channelArn': 'string',
                    'channelName': 'string',
                    'roleArn': 'string'
                },
                'iotEvents': {
                    'inputName': 'string',
                    'messageId': 'string',
                    'roleArn': 'string'
                },
                'iotSiteWise': {
                    'putAssetPropertyValueEntries': [
                        {
                            'entryId': 'string',
                            'assetId': 'string',
                            'propertyId': 'string',
                            'propertyAlias': 'string',
                            'propertyValues': [
                                {
                                    'value': {
                                        'stringValue': 'string',
                                        'integerValue': 'string',
                                        'doubleValue': 'string',
                                        'booleanValue': 'string'
                                    },
                                    'timestamp': {
                                        'timeInSeconds': 'string',
                                        'offsetInNanos': 'string'
                                    },
                                    'quality': 'string'
                                },
                            ]
                        },
                    ],
                    'roleArn': 'string'
                },
                'stepFunctions': {
                    'executionNamePrefix': 'string',
                    'stateMachineName': 'string',
                    'roleArn': 'string'
                },
                'http': {
                    'url': 'string',
                    'confirmationUrl': 'string',
                    'headers': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'auth': {
                        'sigv4': {
                            'signingRegion': 'string',
                            'serviceName': 'string',
                            'roleArn': 'string'
                        }
                    }
                }
            },
        ],
        'ruleDisabled': True|False,
        'awsIotSqlVersion': 'string',
        'errorAction': {
            'dynamoDB': {
                'tableName': 'string',
                'roleArn': 'string',
                'operation': 'string',
                'hashKeyField': 'string',
                'hashKeyValue': 'string',
                'hashKeyType': 'STRING'|'NUMBER',
                'rangeKeyField': 'string',
                'rangeKeyValue': 'string',
                'rangeKeyType': 'STRING'|'NUMBER',
                'payloadField': 'string'
            },
            'dynamoDBv2': {
                'roleArn': 'string',
                'putItem': {
                    'tableName': 'string'
                }
            },
            'lambda': {
                'functionArn': 'string'
            },
            'sns': {
                'targetArn': 'string',
                'roleArn': 'string',
                'messageFormat': 'RAW'|'JSON'
            },
            'sqs': {
                'roleArn': 'string',
                'queueUrl': 'string',
                'useBase64': True|False
            },
            'kinesis': {
                'roleArn': 'string',
                'streamName': 'string',
                'partitionKey': 'string'
            },
            'republish': {
                'roleArn': 'string',
                'topic': 'string',
                'qos': 123
            },
            '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'
            },
            'cloudwatchLogs': {
                'roleArn': 'string',
                'logGroupName': 'string'
            },
            'elasticsearch': {
                'roleArn': 'string',
                'endpoint': 'string',
                'index': 'string',
                'type': 'string',
                'id': 'string'
            },
            'salesforce': {
                'token': 'string',
                'url': 'string'
            },
            'iotAnalytics': {
                'channelArn': 'string',
                'channelName': 'string',
                'roleArn': 'string'
            },
            'iotEvents': {
                'inputName': 'string',
                'messageId': 'string',
                'roleArn': 'string'
            },
            'iotSiteWise': {
                'putAssetPropertyValueEntries': [
                    {
                        'entryId': 'string',
                        'assetId': 'string',
                        'propertyId': 'string',
                        'propertyAlias': 'string',
                        'propertyValues': [
                            {
                                'value': {
                                    'stringValue': 'string',
                                    'integerValue': 'string',
                                    'doubleValue': 'string',
                                    'booleanValue': 'string'
                                },
                                'timestamp': {
                                    'timeInSeconds': 'string',
                                    'offsetInNanos': 'string'
                                },
                                'quality': 'string'
                            },
                        ]
                    },
                ],
                'roleArn': 'string'
            },
            'stepFunctions': {
                'executionNamePrefix': 'string',
                'stateMachineName': 'string',
                'roleArn': 'string'
            },
            'http': {
                'url': 'string',
                'confirmationUrl': 'string',
                'headers': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'auth': {
                    'sigv4': {
                        'signingRegion': 'string',
                        'serviceName': 'string',
                        'roleArn': '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) -- [REQUIRED]

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

          • putItem (dict) -- [REQUIRED]

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

            (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

          • qos (integer) --

            The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

        • cloudwatchLogs (dict) --

          Send data to CloudWatch Logs.

          • roleArn (string) -- [REQUIRED]

            The IAM role that allows access to the CloudWatch log.

          • logGroupName (string) -- [REQUIRED]

            The CloudWatch log group to which the action sends 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.

        • iotAnalytics (dict) --

          Sends message data to an AWS IoT Analytics channel.

          • channelArn (string) --

            (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

          • channelName (string) --

            The name of the IoT Analytics channel to which message data will be sent.

          • roleArn (string) --

            The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

        • iotEvents (dict) --

          Sends an input to an AWS IoT Events detector.

          • inputName (string) -- [REQUIRED]

            The name of the AWS IoT Events input.

          • messageId (string) --

            [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

        • iotSiteWise (dict) --

          Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

          • putAssetPropertyValueEntries (list) -- [REQUIRED]

            A list of asset property value entries.

            • (dict) --

              An asset property value entry containing the following information.

              • entryId (string) --

                Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

              • assetId (string) --

                The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyId (string) --

                The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyAlias (string) --

                The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

              • propertyValues (list) -- [REQUIRED]

                A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

                • (dict) --

                  An asset property value entry containing the following information.

                  • value (dict) -- [REQUIRED]

                    The value of the asset property.

                    • stringValue (string) --

                      Optional. The string value of the value entry. Accepts substitution templates.

                    • integerValue (string) --

                      Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                    • doubleValue (string) --

                      Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                    • booleanValue (string) --

                      Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                  • timestamp (dict) -- [REQUIRED]

                    The asset property value timestamp.

                    • timeInSeconds (string) -- [REQUIRED]

                      A string that contains the time in seconds since epoch. Accepts substitution templates.

                    • offsetInNanos (string) --

                      Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                  • quality (string) --

                    Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

        • stepFunctions (dict) --

          Starts execution of a Step Functions state machine.

          • executionNamePrefix (string) --

            (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

          • stateMachineName (string) -- [REQUIRED]

            The name of the Step Functions state machine whose execution will be started.

          • roleArn (string) -- [REQUIRED]

            The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

        • http (dict) --

          Send data to an HTTPS endpoint.

          • url (string) -- [REQUIRED]

            The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

          • confirmationUrl (string) --

            The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

          • headers (list) --

            The HTTP headers to send with the message data.

            • (dict) --

              The HTTP action header.

              • key (string) -- [REQUIRED]

                The HTTP header key.

              • value (string) -- [REQUIRED]

                The HTTP header value. Substitution templates are supported.

          • auth (dict) --

            The authentication method to use when sending data to an HTTPS endpoint.

            • sigv4 (dict) --

              Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

              • signingRegion (string) -- [REQUIRED]

                The signing region.

              • serviceName (string) -- [REQUIRED]

                The service name to use while signing with Sig V4.

              • roleArn (string) -- [REQUIRED]

                The ARN of the signing role.

    • ruleDisabled (boolean) --

      Specifies whether the rule is disabled.

    • awsIotSqlVersion (string) --

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

    • errorAction (dict) --

      The action to take when an error occurs.

      • 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) -- [REQUIRED]

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

        • putItem (dict) -- [REQUIRED]

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

          (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html 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.

        • qos (integer) --

          The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

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

      • cloudwatchLogs (dict) --

        Send data to CloudWatch Logs.

        • roleArn (string) -- [REQUIRED]

          The IAM role that allows access to the CloudWatch log.

        • logGroupName (string) -- [REQUIRED]

          The CloudWatch log group to which the action sends 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.

      • iotAnalytics (dict) --

        Sends message data to an AWS IoT Analytics channel.

        • channelArn (string) --

          (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

        • channelName (string) --

          The name of the IoT Analytics channel to which message data will be sent.

        • roleArn (string) --

          The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

      • iotEvents (dict) --

        Sends an input to an AWS IoT Events detector.

        • inputName (string) -- [REQUIRED]

          The name of the AWS IoT Events input.

        • messageId (string) --

          [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

      • iotSiteWise (dict) --

        Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

        • putAssetPropertyValueEntries (list) -- [REQUIRED]

          A list of asset property value entries.

          • (dict) --

            An asset property value entry containing the following information.

            • entryId (string) --

              Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

            • assetId (string) --

              The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyId (string) --

              The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyAlias (string) --

              The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

            • propertyValues (list) -- [REQUIRED]

              A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

              • (dict) --

                An asset property value entry containing the following information.

                • value (dict) -- [REQUIRED]

                  The value of the asset property.

                  • stringValue (string) --

                    Optional. The string value of the value entry. Accepts substitution templates.

                  • integerValue (string) --

                    Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

                  • doubleValue (string) --

                    Optional. A string that contains the double value of the value entry. Accepts substitution templates.

                  • booleanValue (string) --

                    Optional. A string that contains the boolean value (true or false ) of the value entry. Accepts substitution templates.

                • timestamp (dict) -- [REQUIRED]

                  The asset property value timestamp.

                  • timeInSeconds (string) -- [REQUIRED]

                    A string that contains the time in seconds since epoch. Accepts substitution templates.

                  • offsetInNanos (string) --

                    Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

                • quality (string) --

                  Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

      • stepFunctions (dict) --

        Starts execution of a Step Functions state machine.

        • executionNamePrefix (string) --

          (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

        • stateMachineName (string) -- [REQUIRED]

          The name of the Step Functions state machine whose execution will be started.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

      • http (dict) --

        Send data to an HTTPS endpoint.

        • url (string) -- [REQUIRED]

          The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a new TopicRuleDestination is created if possible.

        • confirmationUrl (string) --

          The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

        • headers (list) --

          The HTTP headers to send with the message data.

          • (dict) --

            The HTTP action header.

            • key (string) -- [REQUIRED]

              The HTTP header key.

            • value (string) -- [REQUIRED]

              The HTTP header value. Substitution templates are supported.

        • auth (dict) --

          The authentication method to use when sending data to an HTTPS endpoint.

          • sigv4 (dict) --

            Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .

            • signingRegion (string) -- [REQUIRED]

              The signing region.

            • serviceName (string) -- [REQUIRED]

              The service name to use while signing with Sig V4.

            • roleArn (string) -- [REQUIRED]

              The ARN of the signing role.

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',
            'connectivity': {
                'connected': True|False,
                'timestamp': 123
            }
        },
    ],
    'thingGroups': [
        {
            'thingGroupName': 'string',
            'thingGroupId': 'string',
            'thingGroupDescription': 'string',
            'attributes': {
                'string': 'string'
            },
            'parentGroupNames': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

    • things (list) --

      The things that match the search query.

      • (dict) --

        The thing search index document.

        • thingName (string) --

          The thing name.

        • thingId (string) --

          The thing ID.

        • thingTypeName (string) --

          The thing type name.

        • thingGroupNames (list) --

          Thing group names.

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

          The attributes.

          • (string) --
            • (string) --
        • shadow (string) --

          The shadow.

        • connectivity (dict) --

          Indicates whether the thing is connected to the AWS IoT service.

          • connected (boolean) --

            True if the thing is connected to the AWS IoT service; false if it is not connected.

          • timestamp (integer) --

            The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.

    • thingGroups (list) --

      The thing groups that match the search query.

      • (dict) --

        The thing group search index document.

        • thingGroupName (string) --

          The thing group name.

        • thingGroupId (string) --

          The thing group ID.

        • thingGroupDescription (string) --

          The thing group description.

        • attributes (dict) --

          The thing group attributes.

          • (string) --
            • (string) --
        • parentGroupNames (list) --

          Parent group names.

          • (string) --

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.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

See also: AWS API Documentation

Request Syntax

response = client.set_logging_options(
    loggingOptionsPayload={
        'roleArn': 'string',
        'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
    }
)
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 ARN of the role that allows IoT to write to Cloudwatch logs.
  • defaultLogLevel (string) -- The default logging level.
  • disableAllLogs (boolean) -- If true all logs are disabled. The default is false.
Returns

None

start_audit_mitigation_actions_task(**kwargs)

Starts a task that applies a set of mitigation actions to the specified target.

See also: AWS API Documentation

Request Syntax

response = client.start_audit_mitigation_actions_task(
    taskId='string',
    target={
        'auditTaskId': 'string',
        'findingIds': [
            'string',
        ],
        'auditCheckToReasonCodeFilter': {
            'string': [
                'string',
            ]
        }
    },
    auditCheckToActionsMapping={
        'string': [
            'string',
        ]
    },
    clientRequestToken='string'
)
Parameters
  • taskId (string) --

    [REQUIRED]

    A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

  • target (dict) --

    [REQUIRED]

    Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.

    • auditTaskId (string) --

      If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

    • findingIds (list) --

      If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

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

      Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

      • (string) --

        An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

        • (list) --
          • (string) --
  • auditCheckToActionsMapping (dict) --

    [REQUIRED]

    For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

    • (string) --

      An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

      • (list) --
        • (string) --
  • clientRequestToken (string) --

    [REQUIRED]

    Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'taskId': 'string'
}

Response Structure

  • (dict) --

    • taskId (string) --

      The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

start_on_demand_audit_task(**kwargs)

Starts an on-demand Device Defender audit.

See also: AWS API Documentation

Request Syntax

response = client.start_on_demand_audit_task(
    targetCheckNames=[
        'string',
    ]
)
Parameters
targetCheckNames (list) --

[REQUIRED]

Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

  • (string) --

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

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

Response Structure

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

      The ID of the on-demand audit you started.

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

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • tags (list) --

    [REQUIRED]

    The new or modified tags for the resource.

    • (dict) --

      A set of key/value pairs that are used to manage the resource.

      • Key (string) --

        The tag's key.

      • Value (string) --

        The tag's value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

test_authorization(**kwargs)

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

See also: AWS API Documentation

Request Syntax

response = client.test_authorization(
    principal='string',
    cognitoIdentityPoolId='string',
    authInfos=[
        {
            'actionType': 'PUBLISH'|'SUBSCRIBE'|'RECEIVE'|'CONNECT',
            'resources': [
                'string',
            ]
        },
    ],
    clientId='string',
    policyNamesToAdd=[
        'string',
    ],
    policyNamesToSkip=[
        'string',
    ]
)
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)

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

See also: AWS API Documentation

Request Syntax

response = client.test_invoke_authorizer(
    authorizerName='string',
    token='string',
    tokenSignature='string',
    httpContext={
        'headers': {
            'string': 'string'
        },
        'queryString': 'string'
    },
    mqttContext={
        'username': 'string',
        'password': b'bytes',
        'clientId': 'string'
    },
    tlsContext={
        'serverName': 'string'
    }
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The custom authorizer name.

  • token (string) -- The token returned by your custom authentication service.
  • tokenSignature (string) -- The signature made with the token and your custom authentication service's private key.
  • httpContext (dict) --

    Specifies a test HTTP authorization request.

    • headers (dict) --

      The header keys and values in an HTTP authorization request.

      • (string) --
        • (string) --
    • queryString (string) --

      The query string keys and values in an HTTP authorization request.

  • mqttContext (dict) --

    Specifies a test MQTT authorization request.

    • username (string) --

      The value of the username key in an MQTT authorization request.

    • password (bytes) --

      The value of the password key in an MQTT authorization request.

    • clientId (string) --

      The value of the clientId key in an MQTT authorization request.

  • tlsContext (dict) --

    Specifies a test TLS authorization request.

    • serverName (string) --

      The value of the serverName key in a TLS authorization request.

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. (The last part of the certificate ARN contains the certificate ID.)

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

untag_resource(**kwargs)

Removes the given tags (metadata) from the resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • tagKeys (list) --

    [REQUIRED]

    A list of the keys of the tags to be removed from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_account_audit_configuration(**kwargs)

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

See also: AWS API Documentation

Request Syntax

response = client.update_account_audit_configuration(
    roleArn='string',
    auditNotificationTargetConfigurations={
        'string': {
            'targetArn': 'string',
            'roleArn': 'string',
            'enabled': True|False
        }
    },
    auditCheckConfigurations={
        'string': {
            'enabled': True|False
        }
    }
)
Parameters
  • roleArn (string) -- The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
  • auditNotificationTargetConfigurations (dict) --

    Information about the targets to which audit notifications are sent.

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

        Information about the targets to which audit notifications are sent.

        • targetArn (string) --

          The ARN of the target (SNS topic) to which audit notifications are sent.

        • roleArn (string) --

          The ARN of the role that grants permission to send notifications to the target.

        • enabled (boolean) --

          True if notifications to the target are enabled.

  • auditCheckConfigurations (dict) --

    Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

    Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

    You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

    On the first call to UpdateAccountAuditConfiguration , this parameter is required and must specify at least one enabled check.

    • (string) --

      An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

      • (dict) --

        Which audit checks are enabled and disabled for this account.

        • enabled (boolean) --

          True if this audit check is enabled for this account.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

Updates information about the billing group.

See also: AWS API Documentation

Request Syntax

response = client.update_billing_group(
    billingGroupName='string',
    billingGroupProperties={
        'billingGroupDescription': 'string'
    },
    expectedVersion=123
)
Parameters
  • billingGroupName (string) --

    [REQUIRED]

    The name of the billing group.

  • billingGroupProperties (dict) --

    [REQUIRED]

    The properties of the billing group.

    • billingGroupDescription (string) --

      The description of the billing group.

  • expectedVersion (integer) -- The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException .
Return type

dict

Returns

Response Syntax

{
    'version': 123
}

Response Structure

  • (dict) --

    • version (integer) --

      The latest version of the billing group.

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, removes 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. (The last part of the certificate ARN contains the certificate ID.)

  • newStatus (string) --

    [REQUIRED]

    The new status.

    Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by AWS IoT. They are not intended for developer use.

    Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Returns

None

update_dimension(**kwargs)

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).

See also: AWS API Documentation

Request Syntax

response = client.update_dimension(
    name='string',
    stringValues=[
        'string',
    ]
)
Parameters
  • name (string) --

    [REQUIRED]

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

  • stringValues (list) --

    [REQUIRED]

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'type': 'TOPIC_FILTER',
    'stringValues': [
        'string',
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • name (string) --

      A unique identifier for the dimension.

    • arn (string) --

      The ARN (Amazon resource name) of the created dimension.

    • type (string) --

      The type of the dimension.

    • stringValues (list) --

      The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

      • (string) --
    • creationDate (datetime) --

      The date and time, in milliseconds since epoch, when the dimension was initially created.

    • lastModifiedDate (datetime) --

      The date and time, in milliseconds since epoch, when the dimension was most recently updated.

update_domain_configuration(**kwargs)

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_configuration(
    domainConfigurationName='string',
    authorizerConfig={
        'defaultAuthorizerName': 'string',
        'allowAuthorizerOverride': True|False
    },
    domainConfigurationStatus='ENABLED'|'DISABLED',
    removeAuthorizerConfig=True|False
)
Parameters
  • domainConfigurationName (string) --

    [REQUIRED]

    The name of the domain configuration to be updated.

  • authorizerConfig (dict) --

    An object that specifies the authorization service for a domain.

    • defaultAuthorizerName (string) --

      The name of the authorization service for a domain configuration.

    • allowAuthorizerOverride (boolean) --

      A Boolean that specifies whether the domain configuration's authorization service can be overridden.

  • domainConfigurationStatus (string) -- The status to which the domain configuration should be updated.
  • removeAuthorizerConfig (boolean) -- Removes the authorization configuration from a domain.
Return type

dict

Returns

Response Syntax

{
    'domainConfigurationName': 'string',
    'domainConfigurationArn': 'string'
}

Response Structure

  • (dict) --

    • domainConfigurationName (string) --

      The name of the domain configuration that was updated.

    • domainConfigurationArn (string) --

      The ARN of the domain configuration that was updated.

update_dynamic_thing_group(**kwargs)

Updates a dynamic thing group.

See also: AWS API Documentation

Request Syntax

response = client.update_dynamic_thing_group(
    thingGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    expectedVersion=123,
    indexName='string',
    queryString='string',
    queryVersion='string'
)
Parameters
  • thingGroupName (string) --

    [REQUIRED]

    The name of the dynamic thing group to update.

  • thingGroupProperties (dict) --

    [REQUIRED]

    The dynamic thing group properties to update.

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

  • expectedVersion (integer) -- The expected version of the dynamic thing group to update.
  • indexName (string) --

    The dynamic thing group index to update.

    Note

    Currently one index is supported: 'AWS_Things'.

  • queryString (string) -- The dynamic thing group search query string to update.
  • queryVersion (string) --

    The dynamic thing group query version to update.

    Note

    Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

Return type

dict

Returns

Response Syntax

{
    'version': 123
}

Response Structure

  • (dict) --

    • version (integer) --

      The dynamic thing group version.

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',
        'thingConnectivityIndexingMode': 'OFF'|'STATUS',
        'managedFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ],
        'customFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ]
    },
    thingGroupIndexingConfiguration={
        'thingGroupIndexingMode': 'OFF'|'ON',
        'managedFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ],
        'customFields': [
            {
                'name': 'string',
                'type': 'Number'|'String'|'Boolean'
            },
        ]
    }
)
Parameters
  • thingIndexingConfiguration (dict) --

    Thing indexing configuration.

    • thingIndexingMode (string) -- [REQUIRED]

      Thing indexing mode. Valid values are:

      • REGISTRY – Your thing index contains registry data only.
      • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
      • OFF - Thing indexing is disabled.
    • thingConnectivityIndexingMode (string) --

      Thing connectivity indexing mode. Valid values are:

      • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
      • OFF - Thing connectivity status indexing is disabled.
    • managedFields (list) --

      Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

      • (dict) --

        Describes the name and data type at a field.

        • name (string) --

          The name of the field.

        • type (string) --

          The datatype of the field.

    • customFields (list) --

      Contains custom field names and their data type.

      • (dict) --

        Describes the name and data type at a field.

        • name (string) --

          The name of the field.

        • type (string) --

          The datatype of the field.

  • thingGroupIndexingConfiguration (dict) --

    Thing group indexing configuration.

    • thingGroupIndexingMode (string) -- [REQUIRED]

      Thing group indexing mode.

    • managedFields (list) --

      Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

      • (dict) --

        Describes the name and data type at a field.

        • name (string) --

          The name of the field.

        • type (string) --

          The datatype of the field.

    • customFields (list) --

      A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

      Contains custom field names and their data type.

      • (dict) --

        Describes the name and data type at a field.

        • name (string) --

          The name of the field.

        • type (string) --

          The datatype of the field.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_job(**kwargs)

Updates supported fields of the specified job.

See also: AWS API Documentation

Request Syntax

response = client.update_job(
    jobId='string',
    description='string',
    presignedUrlConfig={
        'roleArn': 'string',
        'expiresInSec': 123
    },
    jobExecutionsRolloutConfig={
        'maximumPerMinute': 123,
        'exponentialRate': {
            'baseRatePerMinute': 123,
            'incrementFactor': 123.0,
            'rateIncreaseCriteria': {
                'numberOfNotifiedThings': 123,
                'numberOfSucceededThings': 123
            }
        }
    },
    abortConfig={
        'criteriaList': [
            {
                'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
                'action': 'CANCEL',
                'thresholdPercentage': 123.0,
                'minNumberOfExecutedThings': 123
            },
        ]
    },
    timeoutConfig={
        'inProgressTimeoutInMinutes': 123
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The ID of the job to be updated.

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

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

    • exponentialRate (dict) --

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

      • baseRatePerMinute (integer) -- [REQUIRED]

        The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

      • incrementFactor (float) -- [REQUIRED]

        The exponential factor to increase the rate of rollout for a job.

      • rateIncreaseCriteria (dict) -- [REQUIRED]

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

        AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

        • numberOfNotifiedThings (integer) --

          The threshold for number of notified things that will initiate the increase in rate of rollout.

        • numberOfSucceededThings (integer) --

          The threshold for number of succeeded things that will initiate the increase in rate of rollout.

  • abortConfig (dict) --

    Allows you to create criteria to abort a job.

    • criteriaList (list) -- [REQUIRED]

      The list of abort criteria to define rules to abort the job.

      • (dict) --

        Details of abort criteria to define rules to abort the job.

        • failureType (string) -- [REQUIRED]

          The type of job execution failure to define a rule to initiate a job abort.

        • action (string) -- [REQUIRED]

          The type of abort action to initiate a job abort.

        • thresholdPercentage (float) -- [REQUIRED]

          The threshold as a percentage of the total number of executed things that will initiate a job abort.

          AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

        • minNumberOfExecutedThings (integer) -- [REQUIRED]

          Minimum number of executed things before evaluating an abort rule.

  • timeoutConfig (dict) --

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

    • inProgressTimeoutInMinutes (integer) --

      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Returns

None

update_mitigation_action(**kwargs)

Updates the definition for the specified mitigation action.

See also: AWS API Documentation

Request Syntax

response = client.update_mitigation_action(
    actionName='string',
    roleArn='string',
    actionParams={
        'updateDeviceCertificateParams': {
            'action': 'DEACTIVATE'
        },
        'updateCACertificateParams': {
            'action': 'DEACTIVATE'
        },
        'addThingsToThingGroupParams': {
            'thingGroupNames': [
                'string',
            ],
            'overrideDynamicGroups': True|False
        },
        'replaceDefaultPolicyVersionParams': {
            'templateName': 'BLANK_POLICY'
        },
        'enableIoTLoggingParams': {
            'roleArnForLogging': 'string',
            'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
        },
        'publishFindingToSnsParams': {
            'topicArn': 'string'
        }
    }
)
Parameters
  • actionName (string) --

    [REQUIRED]

    The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction . Instead, you must delete and re-create the mitigation action with the new name.

  • roleArn (string) -- The ARN of the IAM role that is used to apply the mitigation action.
  • actionParams (dict) --

    Defines the type of action and the parameters for that action.

    • updateDeviceCertificateParams (dict) --

      Parameters to define a mitigation action that changes the state of the device certificate to inactive.

      • action (string) -- [REQUIRED]

        The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE .

    • updateCACertificateParams (dict) --

      Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

      • action (string) -- [REQUIRED]

        The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE .

    • addThingsToThingGroupParams (dict) --

      Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

      • thingGroupNames (list) -- [REQUIRED]

        The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.

        • (string) --
      • overrideDynamicGroups (boolean) --

        Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.

    • replaceDefaultPolicyVersionParams (dict) --

      Parameters to define a mitigation action that adds a blank policy to restrict permissions.

      • templateName (string) -- [REQUIRED]

        The name of the template to be applied. The only supported value is BLANK_POLICY .

    • enableIoTLoggingParams (dict) --

      Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

      • roleArnForLogging (string) -- [REQUIRED]

        The ARN of the IAM role used for logging.

      • logLevel (string) -- [REQUIRED]

        Specifies the types of information to be logged.

    • publishFindingToSnsParams (dict) --

      Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

      • topicArn (string) -- [REQUIRED]

        The ARN of the topic to which you want to publish the findings.

Return type

dict

Returns

Response Syntax

{
    'actionArn': 'string',
    'actionId': 'string'
}

Response Structure

  • (dict) --

    • actionArn (string) --

      The ARN for the new mitigation action.

    • actionId (string) --

      A unique identifier for the mitigation action.

update_provisioning_template(**kwargs)

Updates a fleet provisioning template.

See also: AWS API Documentation

Request Syntax

response = client.update_provisioning_template(
    templateName='string',
    description='string',
    enabled=True|False,
    defaultVersionId=123,
    provisioningRoleArn='string'
)
Parameters
  • templateName (string) --

    [REQUIRED]

    The name of the fleet provisioning template.

  • description (string) -- The description of the fleet provisioning template.
  • enabled (boolean) -- True to enable the fleet provisioning template, otherwise false.
  • defaultVersionId (integer) -- The ID of the default provisioning template version.
  • provisioningRoleArn (string) -- The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
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_scheduled_audit(**kwargs)

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

See also: AWS API Documentation

Request Syntax

response = client.update_scheduled_audit(
    frequency='DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
    dayOfMonth='string',
    dayOfWeek='SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
    targetCheckNames=[
        'string',
    ],
    scheduledAuditName='string'
)
Parameters
  • frequency (string) -- How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
  • dayOfMonth (string) -- The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
  • dayOfWeek (string) -- The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
  • targetCheckNames (list) --

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    • (string) --

      An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • scheduledAuditName (string) --

    [REQUIRED]

    The name of the scheduled audit. (Max. 128 chars)

Return type

dict

Returns

Response Syntax

{
    'scheduledAuditArn': 'string'
}

Response Structure

  • (dict) --

    • scheduledAuditArn (string) --

      The ARN of the scheduled audit.

update_security_profile(**kwargs)

Updates a Device Defender security profile.

See also: AWS API Documentation

Request Syntax

response = client.update_security_profile(
    securityProfileName='string',
    securityProfileDescription='string',
    behaviors=[
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                }
            }
        },
    ],
    alertTargets={
        'string': {
            'alertTargetArn': 'string',
            'roleArn': 'string'
        }
    },
    additionalMetricsToRetain=[
        'string',
    ],
    additionalMetricsToRetainV2=[
        {
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            }
        },
    ],
    deleteBehaviors=True|False,
    deleteAlertTargets=True|False,
    deleteAdditionalMetricsToRetain=True|False,
    expectedVersion=123
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The name of the security profile you want to update.

  • securityProfileDescription (string) -- A description of the security profile.
  • behaviors (list) --

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

    • (dict) --

      A Device Defender security profile behavior.

      • name (string) -- [REQUIRED]

        The name you have given to the behavior.

      • metric (string) --

        What is measured by the behavior.

      • metricDimension (dict) --

        The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

        • dimensionName (string) -- [REQUIRED]

          A unique identifier for the dimension.

        • operator (string) --

          Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

      • criteria (dict) --

        The criteria that determine if a device is behaving normally in regard to the metric .

        • comparisonOperator (string) --

          The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

        • value (dict) --

          The value to be compared with the metric .

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • durationSeconds (integer) --

          Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

        • consecutiveDatapointsToAlarm (integer) --

          If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

        • consecutiveDatapointsToClear (integer) --

          If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

        • statisticalThreshold (dict) --

          A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

          • statistic (string) --

            The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

  • alertTargets (dict) --

    Where the alerts are sent. (Alerts are always sent to the console.)

    • (string) --

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

      • (dict) --

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

        • alertTargetArn (string) -- [REQUIRED]

          The ARN of the notification target to which alerts are sent.

        • roleArn (string) -- [REQUIRED]

          The ARN of the role that grants permission to send alerts to the notification target.

  • additionalMetricsToRetain (list) --

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors , but it is also retained for any metric specified here.

    Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
    • (string) --
  • additionalMetricsToRetainV2 (list) --

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

    • (dict) --

      The metric you want to retain. Dimensions are optional.

      • metric (string) -- [REQUIRED]

        What is measured by the behavior.

      • metricDimension (dict) --

        The dimension of a metric.

        • dimensionName (string) -- [REQUIRED]

          A unique identifier for the dimension.

        • operator (string) --

          Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

  • deleteBehaviors (boolean) -- If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
  • deleteAlertTargets (boolean) -- If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
  • deleteAdditionalMetricsToRetain (boolean) -- If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
  • expectedVersion (integer) -- The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
Return type

dict

Returns

Response Syntax

{
    'securityProfileName': 'string',
    'securityProfileArn': 'string',
    'securityProfileDescription': 'string',
    'behaviors': [
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                }
            }
        },
    ],
    'alertTargets': {
        'string': {
            'alertTargetArn': 'string',
            'roleArn': 'string'
        }
    },
    'additionalMetricsToRetain': [
        'string',
    ],
    'additionalMetricsToRetainV2': [
        {
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            }
        },
    ],
    'version': 123,
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • securityProfileName (string) --

      The name of the security profile that was updated.

    • securityProfileArn (string) --

      The ARN of the security profile that was updated.

    • securityProfileDescription (string) --

      The description of the security profile.

    • behaviors (list) --

      Specifies the behaviors that, when violated by a device (thing), cause an alert.

      • (dict) --

        A Device Defender security profile behavior.

        • name (string) --

          The name you have given to the behavior.

        • metric (string) --

          What is measured by the behavior.

        • metricDimension (dict) --

          The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

          • dimensionName (string) --

            A unique identifier for the dimension.

          • operator (string) --

            Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

        • criteria (dict) --

          The criteria that determine if a device is behaving normally in regard to the metric .

          • comparisonOperator (string) --

            The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

          • value (dict) --

            The value to be compared with the metric .

            • count (integer) --

              If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

            • cidrs (list) --

              If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

              • (string) --
            • ports (list) --

              If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

              • (integer) --
          • durationSeconds (integer) --

            Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

          • consecutiveDatapointsToAlarm (integer) --

            If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

          • consecutiveDatapointsToClear (integer) --

            If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

          • statisticalThreshold (dict) --

            A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

            • statistic (string) --

              The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

    • alertTargets (dict) --

      Where the alerts are sent. (Alerts are always sent to the console.)

      • (string) --

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

        • (dict) --

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

          • alertTargetArn (string) --

            The ARN of the notification target to which alerts are sent.

          • roleArn (string) --

            The ARN of the role that grants permission to send alerts to the notification target.

    • additionalMetricsToRetain (list) --

      A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors , but it is also retained for any metric specified here.

      Note: This API field is deprecated. Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

      • (string) --
    • additionalMetricsToRetainV2 (list) --

      A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

      • (dict) --

        The metric you want to retain. Dimensions are optional.

        • metric (string) --

          What is measured by the behavior.

        • metricDimension (dict) --

          The dimension of a metric.

          • dimensionName (string) --

            A unique identifier for the dimension.

          • operator (string) --

            Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

    • version (integer) --

      The updated version of the security profile.

    • creationDate (datetime) --

      The time the security profile was created.

    • lastModifiedDate (datetime) --

      The time the security profile was last modified.

update_stream(**kwargs)

Updates an existing stream. The stream version will be incremented by one.

See also: AWS API Documentation

Request Syntax

response = client.update_stream(
    streamId='string',
    description='string',
    files=[
        {
            'fileId': 123,
            's3Location': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
    ],
    roleArn='string'
)
Parameters
  • streamId (string) --

    [REQUIRED]

    The stream ID.

  • description (string) -- The description of the stream.
  • files (list) --

    The files associated with the stream.

    • (dict) --

      Represents a file to stream.

      • fileId (integer) --

        The file ID.

      • s3Location (dict) --

        The location of the file in S3.

        • bucket (string) --

          The S3 bucket.

        • key (string) --

          The S3 key.

        • version (string) --

          The S3 bucket version.

  • roleArn (string) -- An IAM role that allows the IoT service principal assumes to access your S3 files.
Return type

dict

Returns

Response Syntax

{
    'streamId': 'string',
    'streamArn': 'string',
    'description': 'string',
    'streamVersion': 123
}

Response Structure

  • (dict) --

    • streamId (string) --

      The stream ID.

    • streamArn (string) --

      The stream ARN.

    • description (string) --

      A description of the stream.

    • streamVersion (integer) --

      The stream version.

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

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

  • 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',
    ],
    overrideDynamicGroups=True|False
)
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) --
  • overrideDynamicGroups (boolean) -- Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_topic_rule_destination(**kwargs)

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

See also: AWS API Documentation

Request Syntax

response = client.update_topic_rule_destination(
    arn='string',
    status='ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR'
)
Parameters
  • arn (string) --

    [REQUIRED]

    The ARN of the topic rule destination.

  • status (string) --

    [REQUIRED]

    The status of the topic rule destination. Valid values are:

    IN_PROGRESS

    A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

    ENABLED

    Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination .

    DISABLED

    Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .

    ERROR

    Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

validate_security_profile_behaviors(**kwargs)

Validates a Device Defender security profile behaviors specification.

See also: AWS API Documentation

Request Syntax

response = client.validate_security_profile_behaviors(
    behaviors=[
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                }
            }
        },
    ]
)
Parameters
behaviors (list) --

[REQUIRED]

Specifies the behaviors that, when violated by a device (thing), cause an alert.

  • (dict) --

    A Device Defender security profile behavior.

    • name (string) -- [REQUIRED]

      The name you have given to the behavior.

    • metric (string) --

      What is measured by the behavior.

    • metricDimension (dict) --

      The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

      • dimensionName (string) -- [REQUIRED]

        A unique identifier for the dimension.

      • operator (string) --

        Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

    • criteria (dict) --

      The criteria that determine if a device is behaving normally in regard to the metric .

      • comparisonOperator (string) --

        The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

      • value (dict) --

        The value to be compared with the metric .

        • count (integer) --

          If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

        • cidrs (list) --

          If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

          • (string) --
        • ports (list) --

          If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

          • (integer) --
      • durationSeconds (integer) --

        Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

      • consecutiveDatapointsToAlarm (integer) --

        If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

      • consecutiveDatapointsToClear (integer) --

        If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

      • statisticalThreshold (dict) --

        A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

        • statistic (string) --

          The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

Return type
dict
Returns
Response Syntax
{
    'valid': True|False,
    'validationErrors': [
        {
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • valid (boolean) --

      True if the behaviors were valid.

    • validationErrors (list) --

      The list of any errors found in the behaviors.

      • (dict) --

        Information about an error found in a behavior specification.

        • errorMessage (string) --

          The description of an error found in the behaviors.

Paginators

The available paginators are:

class IoT.Paginator.ListActiveViolations
paginator = client.get_paginator('list_active_violations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_active_violations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingName='string',
    securityProfileName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • thingName (string) -- The name of the thing whose active violations are listed.
  • securityProfileName (string) -- The name of the Device Defender security profile for which violations are listed.
  • 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

{
    'activeViolations': [
        {
            'violationId': 'string',
            'thingName': 'string',
            'securityProfileName': 'string',
            'behavior': {
                'name': 'string',
                'metric': 'string',
                'metricDimension': {
                    'dimensionName': 'string',
                    'operator': 'IN'|'NOT_IN'
                },
                'criteria': {
                    'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                    'value': {
                        'count': 123,
                        'cidrs': [
                            'string',
                        ],
                        'ports': [
                            123,
                        ]
                    },
                    'durationSeconds': 123,
                    'consecutiveDatapointsToAlarm': 123,
                    'consecutiveDatapointsToClear': 123,
                    'statisticalThreshold': {
                        'statistic': 'string'
                    }
                }
            },
            'lastViolationValue': {
                'count': 123,
                'cidrs': [
                    'string',
                ],
                'ports': [
                    123,
                ]
            },
            'lastViolationTime': datetime(2015, 1, 1),
            'violationStartTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • activeViolations (list) --

      The list of active violations.

      • (dict) --

        Information about an active Device Defender security profile behavior violation.

        • violationId (string) --

          The ID of the active violation.

        • thingName (string) --

          The name of the thing responsible for the active violation.

        • securityProfileName (string) --

          The security profile whose behavior is in violation.

        • behavior (dict) --

          The behavior which is being violated.

          • name (string) --

            The name you have given to the behavior.

          • metric (string) --

            What is measured by the behavior.

          • metricDimension (dict) --

            The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

            • dimensionName (string) --

              A unique identifier for the dimension.

            • operator (string) --

              Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

          • criteria (dict) --

            The criteria that determine if a device is behaving normally in regard to the metric .

            • comparisonOperator (string) --

              The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

            • value (dict) --

              The value to be compared with the metric .

              • count (integer) --

                If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

              • cidrs (list) --

                If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

                • (string) --
              • ports (list) --

                If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

                • (integer) --
            • durationSeconds (integer) --

              Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

            • consecutiveDatapointsToAlarm (integer) --

              If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

            • consecutiveDatapointsToClear (integer) --

              If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

            • statisticalThreshold (dict) --

              A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

              • statistic (string) --

                The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

        • lastViolationValue (dict) --

          The value of the metric (the measurement) which caused the most recent violation.

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • lastViolationTime (datetime) --

          The time the most recent violation occurred.

        • violationStartTime (datetime) --

          The time the violation started.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListAttachedPolicies
paginator = client.get_paginator('list_attached_policies')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_attached_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    target='string',
    recursive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • target (string) --

    [REQUIRED]

    The group or principal for which the policies will be listed.

  • recursive (boolean) -- When true, recursively list attached policies.
  • 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) --

    • 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.ListAuditFindings
paginator = client.get_paginator('list_audit_findings')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_audit_findings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    taskId='string',
    checkName='string',
    resourceIdentifier={
        'deviceCertificateId': 'string',
        'caCertificateId': 'string',
        'cognitoIdentityPoolId': 'string',
        'clientId': 'string',
        'policyVersionIdentifier': {
            'policyName': 'string',
            'policyVersionId': 'string'
        },
        'account': 'string',
        'iamRoleArn': 'string',
        'roleAliasArn': 'string'
    },
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • taskId (string) -- A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
  • checkName (string) -- A filter to limit results to the findings for the specified audit check.
  • resourceIdentifier (dict) --

    Information identifying the noncompliant resource.

    • deviceCertificateId (string) --

      The ID of the certificate attached to the resource.

    • caCertificateId (string) --

      The ID of the CA certificate used to authorize the certificate.

    • cognitoIdentityPoolId (string) --

      The ID of the Amazon Cognito identity pool.

    • clientId (string) --

      The client ID.

    • policyVersionIdentifier (dict) --

      The version of the policy associated with the resource.

      • policyName (string) --

        The name of the policy.

      • policyVersionId (string) --

        The ID of the version of the policy associated with the resource.

    • account (string) --

      The account with which the resource is associated.

    • iamRoleArn (string) --

      The ARN of the IAM role that has overly permissive actions.

    • roleAliasArn (string) --

      The ARN of the role alias that has overly permissive actions.

  • startTime (datetime) -- A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
  • endTime (datetime) -- A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
  • 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

{
    'findings': [
        {
            'findingId': 'string',
            'taskId': 'string',
            'checkName': 'string',
            'taskStartTime': datetime(2015, 1, 1),
            'findingTime': datetime(2015, 1, 1),
            'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW',
            'nonCompliantResource': {
                'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
                'resourceIdentifier': {
                    'deviceCertificateId': 'string',
                    'caCertificateId': 'string',
                    'cognitoIdentityPoolId': 'string',
                    'clientId': 'string',
                    'policyVersionIdentifier': {
                        'policyName': 'string',
                        'policyVersionId': 'string'
                    },
                    'account': 'string',
                    'iamRoleArn': 'string',
                    'roleAliasArn': 'string'
                },
                'additionalInfo': {
                    'string': 'string'
                }
            },
            'relatedResources': [
                {
                    'resourceType': 'DEVICE_CERTIFICATE'|'CA_CERTIFICATE'|'IOT_POLICY'|'COGNITO_IDENTITY_POOL'|'CLIENT_ID'|'ACCOUNT_SETTINGS'|'ROLE_ALIAS'|'IAM_ROLE',
                    'resourceIdentifier': {
                        'deviceCertificateId': 'string',
                        'caCertificateId': 'string',
                        'cognitoIdentityPoolId': 'string',
                        'clientId': 'string',
                        'policyVersionIdentifier': {
                            'policyName': 'string',
                            'policyVersionId': 'string'
                        },
                        'account': 'string',
                        'iamRoleArn': 'string',
                        'roleAliasArn': 'string'
                    },
                    'additionalInfo': {
                        'string': 'string'
                    }
                },
            ],
            'reasonForNonCompliance': 'string',
            'reasonForNonComplianceCode': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • findings (list) --

      The findings (results) of the audit.

      • (dict) --

        The findings (results) of the audit.

        • findingId (string) --

          A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

        • taskId (string) --

          The ID of the audit that generated this result (finding).

        • checkName (string) --

          The audit check that generated this result.

        • taskStartTime (datetime) --

          The time the audit started.

        • findingTime (datetime) --

          The time the result (finding) was discovered.

        • severity (string) --

          The severity of the result (finding).

        • nonCompliantResource (dict) --

          The resource that was found to be noncompliant with the audit check.

          • resourceType (string) --

            The type of the noncompliant resource.

          • resourceIdentifier (dict) --

            Information that identifies the noncompliant resource.

            • deviceCertificateId (string) --

              The ID of the certificate attached to the resource.

            • caCertificateId (string) --

              The ID of the CA certificate used to authorize the certificate.

            • cognitoIdentityPoolId (string) --

              The ID of the Amazon Cognito identity pool.

            • clientId (string) --

              The client ID.

            • policyVersionIdentifier (dict) --

              The version of the policy associated with the resource.

              • policyName (string) --

                The name of the policy.

              • policyVersionId (string) --

                The ID of the version of the policy associated with the resource.

            • account (string) --

              The account with which the resource is associated.

            • iamRoleArn (string) --

              The ARN of the IAM role that has overly permissive actions.

            • roleAliasArn (string) --

              The ARN of the role alias that has overly permissive actions.

          • additionalInfo (dict) --

            Other information about the noncompliant resource.

            • (string) --
              • (string) --
        • relatedResources (list) --

          The list of related resources.

          • (dict) --

            Information about a related resource.

            • resourceType (string) --

              The type of resource.

            • resourceIdentifier (dict) --

              Information that identifies the resource.

              • deviceCertificateId (string) --

                The ID of the certificate attached to the resource.

              • caCertificateId (string) --

                The ID of the CA certificate used to authorize the certificate.

              • cognitoIdentityPoolId (string) --

                The ID of the Amazon Cognito identity pool.

              • clientId (string) --

                The client ID.

              • policyVersionIdentifier (dict) --

                The version of the policy associated with the resource.

                • policyName (string) --

                  The name of the policy.

                • policyVersionId (string) --

                  The ID of the version of the policy associated with the resource.

              • account (string) --

                The account with which the resource is associated.

              • iamRoleArn (string) --

                The ARN of the IAM role that has overly permissive actions.

              • roleAliasArn (string) --

                The ARN of the role alias that has overly permissive actions.

            • additionalInfo (dict) --

              Other information about the resource.

              • (string) --
                • (string) --
        • reasonForNonCompliance (string) --

          The reason the resource was noncompliant.

        • reasonForNonComplianceCode (string) --

          A code that indicates the reason that the resource was noncompliant.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListAuditTasks
paginator = client.get_paginator('list_audit_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_audit_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    taskType='ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
    taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • startTime (datetime) --

    [REQUIRED]

    The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

  • endTime (datetime) --

    [REQUIRED]

    The end of the time period.

  • taskType (string) -- A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
  • taskStatus (string) -- A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
  • 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

{
    'tasks': [
        {
            'taskId': 'string',
            'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
            'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • tasks (list) --

      The audits that were performed during the specified time period.

      • (dict) --

        The audits that were performed.

        • taskId (string) --

          The ID of this audit.

        • taskStatus (string) --

          The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

        • taskType (string) --

          The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListAuthorizers
paginator = client.get_paginator('list_authorizers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_authorizers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ascendingOrder=True|False,
    status='ACTIVE'|'INACTIVE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ascendingOrder (boolean) -- Return the list of authorizers in ascending alphabetical order.
  • status (string) -- The status of the list authorizers request.
  • 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

{
    'authorizers': [
        {
            'authorizerName': 'string',
            'authorizerArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • authorizers (list) --

      The authorizers.

      • (dict) --

        The authorizer summary.

        • authorizerName (string) --

          The authorizer name.

        • authorizerArn (string) --

          The authorizer ARN.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListBillingGroups
paginator = client.get_paginator('list_billing_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_billing_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    namePrefixFilter='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • namePrefixFilter (string) -- Limit the results to billing groups whose names have the given prefix.
  • 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

{
    'billingGroups': [
        {
            'groupName': 'string',
            'groupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • billingGroups (list) --

      The list of billing groups.

      • (dict) --

        The name and ARN of a group.

        • groupName (string) --

          The group name.

        • groupArn (string) --

          The group ARN.

    • NextToken (string) --

      A token to resume pagination.

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. (The last part of the certificate ARN contains the certificate ID.)

        • status (string) --

          The status of the certificate.

          The status value REGISTER_INACTIVE is deprecated and should not be used.

        • creationDate (datetime) --

          The date and time the certificate was created.

    • NextToken (string) --

      A token to resume pagination.

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. (The last part of the certificate ARN contains the certificate ID.)

        • status (string) --

          The status of the certificate.

          The status value REGISTER_INACTIVE is deprecated and should not be used.

        • creationDate (datetime) --

          The date and time the certificate was created.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListIndices
paginator = client.get_paginator('list_indices')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_indices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'indexNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • indexNames (list) --

      The index names.

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

      A token to resume pagination.

class IoT.Paginator.ListJobExecutionsForJob
paginator = client.get_paginator('list_job_executions_for_job')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_job_executions_for_job().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    jobId='string',
    status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • jobId (string) --

    [REQUIRED]

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

  • status (string) -- The status of the job.
  • 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

{
    'executionSummaries': [
        {
            'thingArn': 'string',
            'jobExecutionSummary': {
                'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'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 seconds since the epoch, when the job execution was queued.

          • startedAt (datetime) --

            The time, in seconds since the epoch, when the job execution started.

          • lastUpdatedAt (datetime) --

            The time, in seconds 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) --

      A token to resume pagination.

class IoT.Paginator.ListJobExecutionsForThing
paginator = client.get_paginator('list_job_executions_for_thing')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_job_executions_for_thing().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingName='string',
    status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The thing name.

  • status (string) -- An optional filter that lets you search for jobs that have the specified status.
  • 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

{
    'executionSummaries': [
        {
            'jobId': 'string',
            'jobExecutionSummary': {
                'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'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 seconds since the epoch, when the job execution was queued.

          • startedAt (datetime) --

            The time, in seconds since the epoch, when the job execution started.

          • lastUpdatedAt (datetime) --

            The time, in seconds 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) --

      A token to resume pagination.

class IoT.Paginator.ListJobs
paginator = client.get_paginator('list_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
    targetSelection='CONTINUOUS'|'SNAPSHOT',
    thingGroupName='string',
    thingGroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.
  • 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.
  • 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

{
    'jobs': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'thingGroupId': 'string',
            'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
            'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • jobs (list) --

      A list of jobs.

      • (dict) --

        The job summary.

        • jobArn (string) --

          The job ARN.

        • jobId (string) --

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

        • thingGroupId (string) --

          The ID of the thing group.

        • targetSelection (string) --

          Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        • status (string) --

          The job summary status.

        • createdAt (datetime) --

          The time, in seconds since the epoch, when the job was created.

        • lastUpdatedAt (datetime) --

          The time, in seconds since the epoch, when the job was last updated.

        • completedAt (datetime) --

          The time, in seconds since the epoch, when the job completed.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListOTAUpdates
paginator = client.get_paginator('list_ota_updates')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_ota_updates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    otaUpdateStatus='CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • otaUpdateStatus (string) -- The OTA update job status.
  • 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

{
    'otaUpdates': [
        {
            'otaUpdateId': 'string',
            'otaUpdateArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • otaUpdates (list) --

      A list of OTA update jobs.

      • (dict) --

        An OTA update summary.

        • otaUpdateId (string) --

          The OTA update ID.

        • otaUpdateArn (string) --

          The OTA update ARN.

        • creationDate (datetime) --

          The date when the OTA update was created.

    • NextToken (string) --

      A token to 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.ListRoleAliases
paginator = client.get_paginator('list_role_aliases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_role_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ascendingOrder=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ascendingOrder (boolean) -- Return the list of role aliases in ascending alphabetical 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

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

Response Structure

  • (dict) --

    • roleAliases (list) --

      The role aliases.

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

      A token to resume pagination.

class IoT.Paginator.ListScheduledAudits
paginator = client.get_paginator('list_scheduled_audits')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_scheduled_audits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'scheduledAudits': [
        {
            'scheduledAuditName': 'string',
            'scheduledAuditArn': 'string',
            'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
            'dayOfMonth': 'string',
            'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • scheduledAudits (list) --

      The list of scheduled audits.

      • (dict) --

        Information about the scheduled audit.

        • scheduledAuditName (string) --

          The name of the scheduled audit.

        • scheduledAuditArn (string) --

          The ARN of the scheduled audit.

        • frequency (string) --

          How often the scheduled audit occurs.

        • dayOfMonth (string) --

          The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

        • dayOfWeek (string) --

          The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListSecurityProfiles
paginator = client.get_paginator('list_security_profiles')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_security_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dimensionName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • dimensionName (string) -- A filter to limit results to the security profiles that use the defined dimension.
  • 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

{
    'securityProfileIdentifiers': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileIdentifiers (list) --

      A list of security profile identifiers (names and ARNs).

      • (dict) --

        Identifying information for a Device Defender security profile.

        • name (string) --

          The name you have given to the security profile.

        • arn (string) --

          The ARN of the security profile.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListSecurityProfilesForTarget
paginator = client.get_paginator('list_security_profiles_for_target')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_security_profiles_for_target().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    recursive=True|False,
    securityProfileTargetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • recursive (boolean) -- If true, return child groups too.
  • securityProfileTargetArn (string) --

    [REQUIRED]

    The ARN of the target (thing group) whose attached security profiles you want to get.

  • 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

{
    'securityProfileTargetMappings': [
        {
            'securityProfileIdentifier': {
                'name': 'string',
                'arn': 'string'
            },
            'target': {
                'arn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileTargetMappings (list) --

      A list of security profiles and their associated targets.

      • (dict) --

        Information about a security profile and the target associated with it.

        • securityProfileIdentifier (dict) --

          Information that identifies the security profile.

          • name (string) --

            The name you have given to the security profile.

          • arn (string) --

            The ARN of the security profile.

        • target (dict) --

          Information about the target (thing group) associated with the security profile.

          • arn (string) --

            The ARN of the security profile.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListStreams
paginator = client.get_paginator('list_streams')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_streams().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ascendingOrder=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ascendingOrder (boolean) -- Set to true to return the list of streams in ascending 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

{
    'streams': [
        {
            'streamId': 'string',
            'streamArn': 'string',
            'streamVersion': 123,
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • streams (list) --

      A list of streams.

      • (dict) --

        A summary of a stream.

        • streamId (string) --

          The stream ID.

        • streamArn (string) --

          The stream ARN.

        • streamVersion (integer) --

          The stream version.

        • description (string) --

          A description of the stream.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListTagsForResource
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

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

    • StartingToken (string) --

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

Return type

dict

Returns

Response Syntax

{
    'tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • tags (list) --

      The list of tags assigned to the resource.

      • (dict) --

        A set of key/value pairs that are used to manage the resource.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListTargetsForPolicy
paginator = client.get_paginator('list_targets_for_policy')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_targets_for_policy().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    policyName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • policyName (string) --

    [REQUIRED]

    The policy name.

  • 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

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

Response Structure

  • (dict) --

    • targets (list) --

      The policy targets.

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

      A token to resume pagination.

class IoT.Paginator.ListTargetsForSecurityProfile
paginator = client.get_paginator('list_targets_for_security_profile')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_targets_for_security_profile().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    securityProfileName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • securityProfileName (string) --

    [REQUIRED]

    The security profile.

  • 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

{
    'securityProfileTargets': [
        {
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • securityProfileTargets (list) --

      The thing groups to which the security profile is attached.

      • (dict) --

        A target to which an alert is sent when a security profile behavior is violated.

        • arn (string) --

          The ARN of the security profile.

    • NextToken (string) --

      A token to resume pagination.

class IoT.Paginator.ListThingGroups
paginator = client.get_paginator('list_thing_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_thing_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    parentGroup='string',
    namePrefixFilter='string',
    recursive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • 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

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

      A token to resume pagination.

class IoT.Paginator.ListThingGroupsForThing
paginator = client.get_paginator('list_thing_groups_for_thing')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_thing_groups_for_thing().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The thing name.

  • 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

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

      A token to resume pagination.

class IoT.Paginator.ListThingRegistrationTasks
paginator = client.get_paginator('list_thing_registration_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_thing_registration_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='InProgress'|'Completed'|'Failed'|'Cancelled'|'Cancelling',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • status (string) -- The status of the bulk thing provisioning task.
  • 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

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

Response Structure

  • (dict) --

    • taskIds (list) --

      A list of bulk thing provisioning task IDs.

      • (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.ListThingsInBillingGroup
paginator = client.get_paginator('list_things_in_billing_group')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_things_in_billing_group().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    billingGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • billingGroupName (string) --

    [REQUIRED]

    The name of the billing group.

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

    • things (list) --

      A list of things in the billing group.

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

      A token to resume pagination.

class IoT.Paginator.ListThingsInThingGroup
paginator = client.get_paginator('list_things_in_thing_group')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_things_in_thing_group().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingGroupName='string',
    recursive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.
  • 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) --

    • things (list) --

      The things in the specified thing group.

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

class IoT.Paginator.ListV2LoggingLevels
paginator = client.get_paginator('list_v2_logging_levels')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_v2_logging_levels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    targetType='DEFAULT'|'THING_GROUP',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • targetType (string) -- The type of resource for which you are configuring logging. Must be THING_Group .
  • 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

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

      A token to resume pagination.

class IoT.Paginator.ListViolationEvents
paginator = client.get_paginator('list_violation_events')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_violation_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    thingName='string',
    securityProfileName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • startTime (datetime) --

    [REQUIRED]

    The start time for the alerts to be listed.

  • endTime (datetime) --

    [REQUIRED]

    The end time for the alerts to be listed.

  • thingName (string) -- A filter to limit results to those alerts caused by the specified thing.
  • securityProfileName (string) -- A filter to limit results to those alerts generated by the specified security profile.
  • 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

{
    'violationEvents': [
        {
            'violationId': 'string',
            'thingName': 'string',
            'securityProfileName': 'string',
            'behavior': {
                'name': 'string',
                'metric': 'string',
                'metricDimension': {
                    'dimensionName': 'string',
                    'operator': 'IN'|'NOT_IN'
                },
                'criteria': {
                    'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set',
                    'value': {
                        'count': 123,
                        'cidrs': [
                            'string',
                        ],
                        'ports': [
                            123,
                        ]
                    },
                    'durationSeconds': 123,
                    'consecutiveDatapointsToAlarm': 123,
                    'consecutiveDatapointsToClear': 123,
                    'statisticalThreshold': {
                        'statistic': 'string'
                    }
                }
            },
            'metricValue': {
                'count': 123,
                'cidrs': [
                    'string',
                ],
                'ports': [
                    123,
                ]
            },
            'violationEventType': 'in-alarm'|'alarm-cleared'|'alarm-invalidated',
            'violationEventTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • violationEvents (list) --

      The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

      • (dict) --

        Information about a Device Defender security profile behavior violation.

        • violationId (string) --

          The ID of the violation event.

        • thingName (string) --

          The name of the thing responsible for the violation event.

        • securityProfileName (string) --

          The name of the security profile whose behavior was violated.

        • behavior (dict) --

          The behavior which was violated.

          • name (string) --

            The name you have given to the behavior.

          • metric (string) --

            What is measured by the behavior.

          • metricDimension (dict) --

            The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

            • dimensionName (string) --

              A unique identifier for the dimension.

            • operator (string) --

              Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null ), it will be interpreted as IN .

          • criteria (dict) --

            The criteria that determine if a device is behaving normally in regard to the metric .

            • comparisonOperator (string) --

              The operator that relates the thing measured (metric ) to the criteria (containing a value or statisticalThreshold ).

            • value (dict) --

              The value to be compared with the metric .

              • count (integer) --

                If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

              • cidrs (list) --

                If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

                • (string) --
              • ports (list) --

                If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

                • (integer) --
            • durationSeconds (integer) --

              Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

            • consecutiveDatapointsToAlarm (integer) --

              If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

            • consecutiveDatapointsToClear (integer) --

              If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

            • statisticalThreshold (dict) --

              A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

              • statistic (string) --

                The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

        • metricValue (dict) --

          The value of the metric (the measurement).

          • count (integer) --

            If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

          • cidrs (list) --

            If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

            • (string) --
          • ports (list) --

            If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

            • (integer) --
        • violationEventType (string) --

          The type of violation event.

        • violationEventTime (datetime) --

          The time the violation event occurred.

    • NextToken (string) --

      A token to resume pagination.