File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/boto_iot.cpython-310.pyc
o
�N�g�h � @ s� d Z ddlZddlZddlZddlZddlZe�e�Z z!ddl
Z
ddl Z ddl m
Z ddlmZ e�d��ej� dZW n eyG dZY nw dd � Zd
d � Zd>d d
�Zd>dd�Z d>dd�Z d?dd�Zd>dd�Zd>dd�Z d>dd�Z d>dd�Z d>d d �Z d>d d �Z d?d d!�Z! d>d"d#�Z" d>d$d%�Z#d>d&d'�Z$d>d(d)�Z% d>d*d+�Z&d>d,d-�Z' d>d.d/�Z( d>d0d1�Z)d>d2d3�Z* d?d4d5�Z+ d?d6d7�Z,d>d8d9�Z-d>d:d;�Z. d@d<d=�Z/dS )Aa,
Connection module for Amazon IoT
.. versionadded:: 2016.3.0
:depends:
- boto
- boto3
The dependencies listed above can be installed via package or pip.
:configuration: This module accepts explicit Lambda 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:
.. code-block:: text
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 a pillar or
in the minion's config file:
.. code-block:: yaml
iot.keyid: GKTADJGHEIQSXMKKRBJ08H
iot.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
A region may also be specified in the configuration:
.. code-block:: yaml
iot.region: us-east-1
If a region is not specified, the default is 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:
.. code-block:: yaml
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
� N)� __version__)� ClientError�boto3TFc C s t jjjddd�S )zg
Only load if boto libraries exist and if boto libraries are greater than
a given version.
z1.2.1z1.4.41)Z boto3_verZ botocore_ver)�salt�utilsZversionsZcheck_boto_reqs� r r �I/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/boto_iot.py� __virtual__P s r c C s t r td td� d S d S )Nzboto3.assign_funcsZiot)�HAS_BOTO� __utils__�__name__)�optsr r r �__init__[ s �r c
C s� z t ||||d�}|j| d�}|�d�rddiW S ddiW S tyO } z&td |�}|j�di ��d �d
krAddiW Y d }~S d |iW Y d }~S d }~ww )
aI
Given a thing type name, check to see if the given thing type exists
Returns True if the given thing type exists and returns False if the
given thing type does not exist.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion boto_iot.thing_type_exists mythingtype
��region�key�keyid�profile��
thingTypeNamer �existsTF�boto3.get_error�Error�Code�ResourceNotFoundExceptionN�error)� _get_conn�describe_thing_type�getr r �response) r r r r r �conn�res�e�errr r r �thing_type_exists` s
��r$ c
C s� z>t ||||d�}|j| d�}|r:|�dd� |�d�}|r5dD ]}|�|�} | r4t| tj�r4| � ||< q d|iW S ddiW S typ }
z&td |
�} |
j �d i ��d
�d krbddiW Y d}
~
S d | iW Y d}
~
S d}
~
ww )
z�
Given a thing type name describe its properties.
Returns a dictionary of interesting properties.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion boto_iot.describe_thing_type mythingtype
r r ZResponseMetadataN�thingTypeMetadata)Z creationDateZdeprecationDateZ
thing_typer r r r r )
r r �popr �
isinstance�datetime�dater r r ) r r r r r r r! r% ZdtypeZdvalr" r# r r r r s*
�
��r c
C s� z1t ||||d�}t||d�}|j| |d�} | r(t�d| d � d| d d�W S t�d� d d
iW S tyL }
zd
td |
�d �W Y d
}
~
S d
}
~
ww )a�
Given a valid config, create a thing type.
Returns {created: true} if the thing type was created and returns
{created: False} if the thing type was not created.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion boto_iot.create_thing_type mythingtype \
thingtype_description_string '["searchable_attr_1", "searchable_attr_2"]'
r )�thingTypeDescriptionZsearchableAttributes)r �thingTypePropertiesz&The newly created thing type ARN is %s� thingTypeArnT)�createdr, zthing type was not createdr- Fr �r- r N)r �dict�create_thing_type�log�info�warningr r ) r r* ZsearchableAttributesListr r r r r r+ Z thingtyper" r r r r0 � s( ���
��r0 c
C sp z t ||||d�}|j| |d� |du rdnd}d|iW S ty7 } zdtd |�d�W Y d}~S d}~ww ) a�
Given a thing type name, deprecate it when undoDeprecate is False
and undeprecate it when undoDeprecate is True.
Returns {deprecated: true} if the thing type was deprecated and returns
{deprecated: false} if the thing type was not deprecated.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion boto_iot.deprecate_thing_type mythingtype
r )r �
undoDeprecateFT�
deprecatedr )r5 r N)r �deprecate_thing_typer r ) r r4 r r r r r r5 r" r r r r6 � s �
��r6 c
C s� zt ||||d�}|j| d� ddiW S tyF } z'td |�}|j�di ��d�dkr7ddiW Y d }~S d
|d �W Y d }~S d }~ww ) a8
Given a thing type name, delete it.
Returns {deleted: true} if the thing type was deleted and returns
{deleted: false} if the thing type was not deleted.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion boto_iot.delete_thing_type mythingtype
r r �deletedTr r r r NF�r7 r )r �delete_thing_typer r r r )r r r r r r r" r# r r r r9 � s
��r9 c
C s� zt ||||d�}|j| d� ddiW S tyE } z&td |�}|j�di ��d�dkr7dd iW Y d
}~S d |iW Y d
}~S d
}~ww ) a
Given a policy name, check to see if the given policy exists.
Returns True if the given policy exists and returns False if the given
policy does not exist.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.policy_exists mypolicy
r ��
policyNamer Tr r r r FNr �r Z
get_policyr r r r )r; r r r r r r" r# r r r �
policy_exists s
��r= c
C s� z7t ||||d�}t|t�stjj�|�}|j| |d�}|r.t� d|d � d|d d�W S t�
d� dd iW S t yR } zd t d
|�d �W Y d }~S d }~ww )
a�
Given a valid config, create a policy.
Returns {created: true} if the policy was created and returns
{created: False} if the policy was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.create_policy my_policy \
'{"Version":"2015-12-12",\
"Statement":[{"Effect":"Allow",\
"Action":["iot:Publish"],\
"Resource":["arn:::::topic/foo/bar"]}]}'
r )r; �policyDocument�&The newly created policy version is %s�policyVersionIdT)r- Z versionIdzPolicy was not createdr- Fr r. N)
r r' �strr r �json�dumps�
create_policyr1 r2 r3 r r ) r; r> r r r r r �policyr" r r r rD ) s$
��
��rD c
C �^ zt ||||d�}|j| d� ddiW S ty. } zdtd |�d�W Y d}~S d}~ww ) a
Given a policy name, delete it.
Returns {deleted: true} if the policy was deleted and returns
{deleted: false} if the policy was not deleted.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.delete_policy mypolicy
r r: r7 TFr r8 N)r �
delete_policyr r )r; r r r r r r" r r r rG R �
��rG c
s� z#t ||||d�}|j| d�� � r d}d� fdd�|D �iW S ddiW S tyY } z*td |�}|j�d i ��d
�d krGddiW Y d}~S d td |�iW Y d}~S d}~ww )
z�
Given a policy name describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.describe_policy mypolicy
r r: )r; � policyArnr> ZdefaultVersionIdrE c � i | ]}|� � |��qS r �r ��.0�k�rE r r �
<dictcomp>| � z#describe_policy.<locals>.<dictcomp>Nr r r r r r< ) r; r r r r r �keysr" r# r rO r �describe_policyi s
��rS c
C s� zt ||||d�}|j| |d�}dt|�iW S tyL } z*td |�} |j�di ��d�dkr:ddiW Y d }~S d
td |�iW Y d }~S d }~ww ) aK
Given a policy name and version ID, check to see if the given policy version exists.
Returns True if the given policy version exists and returns False if the given
policy version does not exist.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.policy_version_exists mypolicy versionid
r )r; ZpolicyversionIdr r r r r FNr )r �get_policy_version�boolr r r r )
r; r@ r r r r r rE r" r# r r r �policy_version_exists� s � ��rV c
C s� z8t ||||d�}t|t�stjj�|�}|j| ||d�}|r/t� d|d � d|d d�W S t�
d� dd iW S t yS } zd t d
| �d �W Y d } ~ S d } ~ ww )
a�
Given a valid config, create a new version of a policy.
Returns {created: true} if the policy version was created and returns
{created: False} if the policy version was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.create_policy_version my_policy \
'{"Statement":[{"Effect":"Allow","Action":["iot:Publish"],"Resource":["arn:::::topic/foo/bar"]}]}'
r )r; r> � setAsDefaultr? r@ T)r- �namez Policy version was not createdr- Fr r. N)
r r' rA r r rB rC �create_policy_versionr1 r2 r3 r r )
r; r> rW r r r r r rE r" r r r rY � s(
��
��rY c
C �` zt ||||d�}|j| |d� ddiW S ty/ } zdtd |�d�W Y d}~S d}~ww ) a0
Given a policy name and version, delete it.
Returns {deleted: true} if the policy version was deleted and returns
{deleted: false} if the policy version was not deleted.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.delete_policy_version mypolicy version
r �r; r@ r7 TFr r8 N)r �delete_policy_versionr r �r; r@ r r r r r r" r r r r\ � s �
��r\ c
s� z$t ||||d�}|j| |d�� � r d}d� fdd�|D �iW S ddiW S tyZ } z*td |�} |j�d i ��d
�d krHddiW Y d}~S d td |�iW Y d}~S d}~ww )
z�
Given a policy name and version describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.describe_policy_version mypolicy version
r r[ )r; rI r> r@ ZisDefaultVersionrE c rJ r rK rL rO r r rP
rQ z+describe_policy_version.<locals>.<dictcomp>Nr r r r r )r rT r r r r )
r; r@ r r r r r rR r" r# r rO r �describe_policy_version� s �
��r^ c
C s� z,t | |||d�}g }td |jddd�D ] }|�|d � qt|�s(t�d� d|iW S tyF } zdtd |�iW Y d
}~S d
}~ww ) z�
List all policies
Returns list of policies
CLI Example:
.. code-block:: bash
salt myminion boto_iot.list_policies
Example Return:
.. code-block:: yaml
policies:
- {...}
- {...}
r �boto3.paged_call�
nextMarker�marker�� marker_flag�
marker_arg�policies�No policies foundr r N)r r �
list_policies�extendrU r1 r3 r )r r r r r re �retr" r r r rg s
�
��rg c
C s� z-t ||||d�}g }td |jdd| d�D ] }|�|d � qt|�s)t�d� d|iW S tyG } zdtd |�iW Y d
}~S d
}~ww ) a
List the versions available for the given policy.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.list_policy_versions mypolicy
Example Return:
.. code-block:: yaml
policyVersions:
- {...}
- {...}
r r_ r` ra )rc rd r; ZpolicyVersionszNo versions foundr r N)r r �list_policy_versionsrh rU r1 r3 r ) r; r r r r r �versri r" r r r rj 7 �"
�
��rj c
C sd zt ||||d�}|j| t|�d� ddiW S ty1 } zdtd |�d�W Y d}~S d}~ww ) a�
Sets the specified version of the specified policy as the policy's default
(operative) version. This action affects all certificates that the policy is
attached to.
Returns {changed: true} if the policy version was set
{changed: False} if the policy version was not set.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.set_default_policy_version mypolicy versionid
r r[ �changedTFr )rm r N)r �set_default_policy_versionrA r r r] r r r rn [ s �
��rn c
C s� z-t ||||d�}g }td |j| ddd�D ] }|�|d � qt|�s)t�d� d|iW S tyG } zdtd |�iW Y d
}~S d
}~ww ) a
List the policies attached to the given principal.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.list_principal_policies myprincipal
Example Return:
.. code-block:: yaml
policies:
- {...}
- {...}
r r_ r` ra )� principalrc rd re rf r r N)r r �list_principal_policiesrh rU r1 r3 r ) ro r r r r r rk ri r" r r r rp w rl rp c
C rZ ) aP
Attach the specified policy to the specified principal (certificate or other
credential.)
Returns {attached: true} if the policy was attached
{attached: False} if the policy was not attached.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.attach_principal_policy mypolicy mycognitoID
r �r; ro �attachedTFr )rr r N)r �attach_principal_policyr r �r; ro r r r r r r" r r r rs � �
��rs c
C rZ ) aR
Detach the specified policy from the specified principal (certificate or other
credential.)
Returns {detached: true} if the policy was detached
{detached: False} if the policy was not detached.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.detach_principal_policy mypolicy mycognitoID
r rq �detachedTFr )rv r N)r �detach_principal_policyr r rt r r r rw � ru rw c
C s� zt ||||d�}|j| d�}ddiW S tyI } z*td |�}|j�di ��d�dkr7dd iW Y d
}~S d td |�iW Y d
}~S d
}~ww ) a
Given a rule name, check to see if the given rule exists.
Returns True if the given rule exists and returns False if the given
rule does not exist.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.topic_rule_exists myrule
r ��ruleNamer Tr r r ZUnauthorizedExceptionFNr )r �get_topic_ruler r r r ) ry r r r r r �ruler" r# r r r �topic_rule_exists� s
��r| c
C �j zt ||||d�} | j| ||||d�d� ddiW S ty4 }
zdtd |
�d�W Y d }
~
S d }
~
ww )
a�
Given a valid config, create a topic rule.
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.create_topic_rule my_rule "SELECT * FROM 'some/thing'" \
'[{"lambda":{"functionArn":"arn:::::something"}},{"sns":{\
"targetArn":"arn:::::something","roleArn":"arn:::::something"}}]'
r ��sql� description�actions� ruleDisabled�ry ZtopicRulePayloadr- TFr r. N)r �create_topic_ruler r � ry r r� r� r� r r r r r r" r r r r� � � ��
��r� c
C r} )
a�
Given a valid config, replace a topic rule with the new values.
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.replace_topic_rule my_rule 'SELECT * FROM some.thing' \
'[{"lambda":{"functionArn":"arn:::::something"}},{"sns":{\
"targetArn":"arn:::::something","roleArn":"arn:::::something"}}]'
r r~ r� �replacedTFr )r� r N)r �replace_topic_ruler r r� r r r r� r� r� c
C rF ) z�
Given a rule name, delete it.
Returns {deleted: true} if the rule was deleted and returns
{deleted: false} if the rule was not deleted.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.delete_rule myrule
r rx r7 TFr r8 N)r �delete_topic_ruler r )ry r r r r r r" r r r r� B rH r� c
s� z+t ||||d�}|j| d�� � r'd� v r'� d � d}d� fdd�|D �iW S ddiW S tyE } zdtd |�iW Y d}~S d}~ww )
z�
Given a topic rule name describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_iot.describe_topic_rule myrule
r rx r{ )ry r r� r� r� c rJ r rK rL �r{ r r rP m rQ z'describe_topic_rule.<locals>.<dictcomp>Nr r )r rz r r )ry r r r r r rR r" r r� r �describe_topic_ruleY s
��r� c
C s� zBt ||||d�}i }| dur| |d< |dur||d< g }td |jfddd�|��D ] } |�| d � q+t|�s>t�d � d|iW S ty\ }
zd
td |
�iW Y d}
~
S d}
~
ww ) a
List all rules (for a given topic, if specified)
Returns list of rules
CLI Example:
.. code-block:: bash
salt myminion boto_iot.list_topic_rules
Example Return:
.. code-block:: yaml
rules:
- {...}
- {...}
r N�topicr� r_ Z nextTokenrb �ruleszNo rules foundr r )r r �list_topic_rulesrh rU r1 r3 r ) r� r� r r r r r �kwargsr� ri r" r r r r� t s0 ��
�
��r� )NNNN)FNNNN)NNNNNN)0�__doc__r( �loggingZsalt.utils.compatr Zsalt.utils.jsonZsalt.utils.versions� getLoggerr r1 Zbotor Zbotocorer Zfound_botocore_versionZbotocore.exceptionsr �setLevel�CRITICALr
� ImportErrorr r r$ r r0 r6 r9 r= rD rG rS rV rY r\ r^ rg rj rn rp rs rw r| r� r� r� r� r� r r r r �<module> s� 4
�
(
�2
�
�
)
�!
�/
�
�
'
#%
�
%
�
�
$
�0
�
+
�