boto3_iot

Connection module for Amazon IoT using boto3.

Renamed from boto_iot to boto3_iot and rewritten to use the boto3 iot client APIs directly via saltext.boto3.utils.boto3mod. The legacy boto2 code path (object-style access, retry loops) has been removed.

depends:

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

configuration:

This module accepts explicit IoT credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at:

http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

If IAM roles are not used you need to specify them either in the minion’s config file or as a profile. For example, to specify them in the minion’s config file:

iot.keyid: GKTADJGHEIQSXMKKRBJ08H
iot.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

A region may also be specified in the configuration:

iot.region: us-east-1

It’s also possible to specify key, keyid and region via a profile, either as a passed in dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us-east-1

Added in version 1.0.0.

saltext.boto3.modules.boto3_iot.__virtual__()[source]

Only load if boto3 is available.

saltext.boto3.modules.boto3_iot.thing_type_exists(thingTypeName, region=None, key=None, keyid=None, profile=None)[source]

Check to see if the given thing type exists.

Returns {'exists': True} / {'exists': False}.

CLI Example:

salt-call boto3_iot.thing_type_exists
saltext.boto3.modules.boto3_iot.describe_thing_type(thingTypeName, region=None, key=None, keyid=None, profile=None)[source]

Describe the given thing type.

CLI Example:

salt-call boto3_iot.describe_thing_type
saltext.boto3.modules.boto3_iot.create_thing_type(thingTypeName, thingTypeDescription, searchableAttributesList, region=None, key=None, keyid=None, profile=None)[source]

Create a thing type.

CLI Example:

salt-call boto3_iot.create_thing_type
saltext.boto3.modules.boto3_iot.deprecate_thing_type(thingTypeName, undoDeprecate=False, region=None, key=None, keyid=None, profile=None)[source]

Deprecate or undeprecate the given thing type.

CLI Example:

salt-call boto3_iot.deprecate_thing_type
saltext.boto3.modules.boto3_iot.delete_thing_type(thingTypeName, region=None, key=None, keyid=None, profile=None)[source]

Delete the given thing type.

CLI Example:

salt-call boto3_iot.delete_thing_type
saltext.boto3.modules.boto3_iot.policy_exists(policyName, region=None, key=None, keyid=None, profile=None)[source]

Check to see if the given policy exists.

CLI Example:

salt-call boto3_iot.policy_exists
saltext.boto3.modules.boto3_iot.create_policy(policyName, policyDocument, region=None, key=None, keyid=None, profile=None)[source]

Create a policy.

CLI Example:

salt-call boto3_iot.create_policy
saltext.boto3.modules.boto3_iot.delete_policy(policyName, region=None, key=None, keyid=None, profile=None)[source]

Delete the given policy.

CLI Example:

salt-call boto3_iot.delete_policy
saltext.boto3.modules.boto3_iot.describe_policy(policyName, region=None, key=None, keyid=None, profile=None)[source]

Describe the given policy.

CLI Example:

salt-call boto3_iot.describe_policy
saltext.boto3.modules.boto3_iot.policy_version_exists(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)[source]

Check to see if the given policy version exists.

CLI Example:

salt-call boto3_iot.policy_version_exists
saltext.boto3.modules.boto3_iot.create_policy_version(policyName, policyDocument, setAsDefault=False, region=None, key=None, keyid=None, profile=None)[source]

Create a new version of a policy.

CLI Example:

salt-call boto3_iot.create_policy_version
saltext.boto3.modules.boto3_iot.delete_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)[source]

Delete the given policy version.

CLI Example:

salt-call boto3_iot.delete_policy_version
saltext.boto3.modules.boto3_iot.describe_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)[source]

Describe the given policy version.

CLI Example:

salt-call boto3_iot.describe_policy_version
saltext.boto3.modules.boto3_iot.list_policies(region=None, key=None, keyid=None, profile=None)[source]

List all policies.

CLI Example:

salt-call boto3_iot.list_policies
saltext.boto3.modules.boto3_iot.list_policy_versions(policyName, region=None, key=None, keyid=None, profile=None)[source]

List the versions available for the given policy.

CLI Example:

salt-call boto3_iot.list_policy_versions
saltext.boto3.modules.boto3_iot.set_default_policy_version(policyName, policyVersionId, region=None, key=None, keyid=None, profile=None)[source]

Set the given version as the default for the policy.

CLI Example:

salt-call boto3_iot.set_default_policy_version
saltext.boto3.modules.boto3_iot.list_principal_policies(principal, region=None, key=None, keyid=None, profile=None)[source]

List the policies attached to the given principal.

CLI Example:

salt-call boto3_iot.list_principal_policies
saltext.boto3.modules.boto3_iot.attach_principal_policy(policyName, principal, region=None, key=None, keyid=None, profile=None)[source]

Attach the specified policy to the specified principal.

CLI Example:

salt-call boto3_iot.attach_principal_policy
saltext.boto3.modules.boto3_iot.detach_principal_policy(policyName, principal, region=None, key=None, keyid=None, profile=None)[source]

Detach the specified policy from the specified principal.

CLI Example:

salt-call boto3_iot.detach_principal_policy
saltext.boto3.modules.boto3_iot.topic_rule_exists(ruleName, region=None, key=None, keyid=None, profile=None)[source]

Check to see if the given rule exists.

CLI Example:

salt-call boto3_iot.topic_rule_exists
saltext.boto3.modules.boto3_iot.create_topic_rule(ruleName, sql, actions, description, ruleDisabled=False, region=None, key=None, keyid=None, profile=None)[source]

Create a topic rule.

CLI Example:

salt-call boto3_iot.create_topic_rule
saltext.boto3.modules.boto3_iot.replace_topic_rule(ruleName, sql, actions, description, ruleDisabled=False, region=None, key=None, keyid=None, profile=None)[source]

Replace a topic rule with the new values.

CLI Example:

salt-call boto3_iot.replace_topic_rule
saltext.boto3.modules.boto3_iot.delete_topic_rule(ruleName, region=None, key=None, keyid=None, profile=None)[source]

Delete the given topic rule.

CLI Example:

salt-call boto3_iot.delete_topic_rule
saltext.boto3.modules.boto3_iot.describe_topic_rule(ruleName, region=None, key=None, keyid=None, profile=None)[source]

Describe the given topic rule.

CLI Example:

salt-call boto3_iot.describe_topic_rule
saltext.boto3.modules.boto3_iot.list_topic_rules(topic=None, ruleDisabled=None, region=None, key=None, keyid=None, profile=None)[source]

List all rules (for a given topic, if specified).

CLI Example:

salt-call boto3_iot.list_topic_rules