Current File : //usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyc
�
���^c
@@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z d d l Z
d d l Z
d d l Z
e j
e � Z yt d d l Z d d l Z d d l m Z d d l m Z e j
d � j e j � e j
d � j e j � e Z Wn e k
r
e Z n Xd � Z d
� Z d � Z d � Z d
� Z! d � Z" d d d d d d � Z$ d d d d d d d � Z% d d d d d d � Z& d d d d d d � Z' d d d d d d � Z( d d d d d � Z) d d d d d � Z* d d d d d � Z+ d d d d d � Z, d d d d d � Z- d d d d d � Z. d d d d d � Z/ e d d d d d d � Z0 d d d d d � Z1 d � Z2 d � Z3 d � Z4 d � Z5 d d d d d! � Z6 d d d d d" � Z7 d d d d d# � Z8 d d d d d$ � Z9 d d d d d% � Z: d d d d d& � Z; d d d d d' � Z< d d d d d( � Z= d) d) e d* d d d d d d+ � Z> d d d d d, � Z? d d d d d- � Z@ d d d d d. � ZA d d d d d/ � ZB d) e d* d d d d d d0 � ZC d d d d d1 � ZD d d d d d2 � ZE e d d d d d d d3 � ZF d d d d d4 � ZG d d d d d5 � ZH d d d d d d d6 � ZI d d d d d7 � ZJ d d d d d8 � ZK d d d d d9 � ZL e d d d d d: � ZM d d d d d; � ZN d< � ZO d d d d d= � ZP d d d d d> � ZQ d? d d d d d@ � ZR d d d d dA � ZS d d d d dB � ZT d d d d dC � ZU d d d d dD � ZV d d d d dE � ZW d d d d d d dF � ZX d d d d d d dG � ZY dH � ZZ d d d d d d dI � Z[ dJ � Z\ dK � Z] d d d d d d d dL � Z^ d d d d d d dM � Z_ d d d d dN � Z` d d d d dO � Za d d d d dP � Zb d d d d dQ � Zc d S(R u
Connection module for Amazon APIGateway
.. versionadded:: 2016.11.0
:depends:
- boto >= 2.8.0
- boto3 >= 1.2.1
- botocore >= 1.4.49
:configuration: This module accepts explicit Lambda credentials but can also
utilize IAM roles assigned to the instance trough 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
apigateway.keyid: GKTADJGHEIQSXMKKRBJ08H
apigateway.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
A region may also be specified in the configuration:
.. code-block:: yaml
apigateway.region: us-west-2
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-west-2
.. versionchanged:: 2015.8.0
All methods now return a dictionary. Create and delete methods return:
.. code-block:: yaml
created: true
or
.. code-block:: yaml
created: false
error:
message: error message
Request methods (e.g., ``describe_apigateway``) return:
.. code-block:: yaml
apigateway:
- {...}
- {...}
or
.. code-block:: yaml
error:
message: error message
i ( t absolute_importt print_functiont unicode_literalsN( t six( t ClientError( t __version__u botou boto3c C@ s" t j j j d d d d d d � S( ug
Only load if boto libraries exist and if boto libraries are greater than
a given version.
t boto_veru 2.8.0t boto3_veru 1.2.1t botocore_veru 1.4.49( t saltt utilst versionst check_boto_reqs( ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt __virtual__p s c C@ s1 t j j j t � t r- t d t d � n d S( Nu boto3.assign_funcsu
apigateway( R R
t compatt pack_dundert __name__t HAS_BOTOt __utils__( t opts( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt __init__ s c C@ sc | r_ t g t j | � D]? \ } } t | t j � rL | d j | � f n | | f ^ q � Sd S( uQ
modify any key-value pair where value is a datetime object to a string.
u {0}N( t dictR t iteritemst
isinstancet datetimet datet formatt None( t responset kt v( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _convert_datetime_str� s Yc C@ s' g | D] } | d | k r | ^ q S( u;
Return list of api items matching the given name.
u name( ( t namet apist api( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _filter_apis� s c C@ s' g | D] } | d | k r | ^ q S( uB
Return list of api items matching the given description.
u description( ( t descR! R" ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _filter_apis_desc� s c O@ sq | | | � } | j d � } xC | rc | d | | | � } | | j | | � | j d � } q! W| j | � S( u�
Retrieve full list of values for the contentkey from a boto3 ApiGateway
client function that may be paged via 'position'
u positiont position( t gett extend( t functiont
contentkeyt argst kwargst retR& t more( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _multi_call� s c
C@ s� y� t d | d | d | d | � } t | j d � } | rN t | | � } n | d k rl t | | � } n i g | D] } t | � ^ qv d 6SWn% t k
r� } i t d | � d 6SXd S(
u�
get and return list of matching rest api information by the given name and desc.
If rest api name evaluates to False, return all apis w/o filtering the name.
t regiont keyt keyidt profileu itemsu restapiu boto3.get_erroru errorN( t _get_connR/ t
get_rest_apisR# R R% R R R (
R t descriptionR0 R1 R2 R3 t connR! R" t e( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _find_apis_by_name� s ! (c C@ sZ | r. t | d | d | d | d | d | �St d d | d | d | d | d | �Sd S( u�
Returns all rest apis in the defined region. If optional parameter name is included,
returns all rest apis matching the name in the defined region.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_apis
salt myminion boto_apigateway.describe_apis name='api name'
salt myminion boto_apigateway.describe_apis name='api name' description='desc str'
R6 R0 R1 R2 R3 u N( R9 ( R R6 R0 R1 R2 R3 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
describe_apis� s
c C@ sD t | d | d | d | d | d | �} i t | j d � � d 6S( u�
Check to see if the given Rest API Name and optionally description exists.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.exists myapi_name
R6 R0 R1 R2 R3 u restapiu exists( R9 t boolR' ( R R6 R0 R1 R2 R3 R! ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
api_exists� s c
C@ s� y� t d | d | d | d | � } | rK | j d | d | d | � } n | j d | d | � } t | � } | r� i t d 6| d 6Si t d 6SWn, t k
r� } i t d 6t d
| � d 6SXd S(
u0
Create a new REST API Service with the given name
Returns {created: True} if the rest api was created and returns
{created: False} if the rest api was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api myapi_name api_description
R0 R1 R2 R3 R R6 t cloneFromu createdu restapiu boto3.get_erroru errorN( R4 t create_rest_apiR t Truet FalseR R (
R R6 R= R0 R1 R2 R3 R7 R" R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
create_api� s !! 'c C@ s� y� t d | d | d | d | � } t | d | | �} | j d � } | r� t | � } x" | D] }
| j d |
d � qa Wi t d 6t | � d
6Si t d 6SWn, t k
r� } i t d 6t d | � d 6SXd
S( u�
Delete all REST API Service with the given name and an optional API description
Returns {deleted: True, count: deleted_count} if apis were deleted, and
returns {deleted: False} if error or not found.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api myapi_name
salt myminion boto_apigateway.delete_api myapi_name description='api description'
R0 R1 R2 R3 R6 u restapit restApiIdu idu deletedu countu boto3.get_erroru errorN(
R R9 R' R4 t delete_rest_apiR? t lenR@ R R ( R R6 R0 R1 R2 R3 t conn_paramst rR! R7 R" R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
delete_api s !
c C@ s� yW t d | d | d | d | � } t t | j d d | �d d � �} i | d 6SWn% t k
r~ } i t d | � d
6SXd S( u�
Given rest api id, return all resources for this api.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_resources myapi_id
R0 R1 R2 R3 u itemsRB c S@ s | d S( Nu path( ( R ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt <lambda>. s u resourcesu boto3.get_erroru errorN( R4 t sortedR/ t
get_resourcesR R ( RB R0 R1 R2 R3 R7 t resourcesR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_resources s ! c
C@ sz t | d | d | d | d | �} | j d � } | d k rC | Sx) | D]! } | d | k rJ i | d 6SqJ Wi d d 6S( u�
Given rest api id, and an absolute resource path, returns the resource id for
the given path.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_resource myapi_id resource_path
R0 R1 R2 R3 u resourcesu pathu resourceN( RL R' R ( RB t pathR0 R1 R2 R3 RF RK t resource( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_resource5 s
$
c C@ sZ | j d � } g } d } y t d | d | d | d | � } x� | D]� }
| d k rm d j | |
� } n d j | |
� } t | | d | d | d | d | �} | j d � } | s� | j d
| d | d d
d |
� } n | j | � qF W| ri t d 6| d 6| d 6Si t d 6d d 6SWn, t k
rU}
i t d 6t
d |
� d 6SXd S( u
Given rest api id, and an absolute resource path, create all the resources and
return all resources in the resourcepath, returns False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_resources myapi_id resource_path
u /u R0 R1 R2 R3 u {0}{1}u {0}/{1}u resourceRB t parentIdi����u idt pathPartu createdu restApiIdu resourcesu unexpected error.u erroru boto3.get_errorN( t splitR4 R RO R' t create_resourcet appendR? R@ R R ( RB RM R0 R1 R2 R3 t
path_partst createdt current_pathR7 t path_partRF RN R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_resourcesL s(
!
)c
C@ s� | d k r i t d 6d d 6Sy� t d | d | d | d | � } t | | d | d | d | d | �} | j d � } | r� | j d
| d | d � i t d 6Si t d 6d
j | � d 6SWn, t k
r� } i t d 6t d | � d 6SXd S( ud
Given restApiId and an absolute resource path, delete the resources starting
from the absolute resource path. If resourcepath is the root resource '/',
the function will return False. Returns False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_resources myapi_id, resource_path
u /u deletedu* use delete_api to remove the root resourceu errorR0 R1 R2 R3 u resourceRB t
resourceIdu idu no resource found by {0}u createdu boto3.get_errorN( R@ R4 RO R' t delete_resourceR? R R R (
RB RM R0 R1 R2 R3 R7 RF RN R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_resourcesr s !' c C@ s� t | | d | d | d | d | �} | j d � } | sG i d d 6SyR t d | d | d | d | � } | j d | d | d
d | � }
i |
d 6SWn% t k
r� } i t d
| � d 6SXd S( uu
Given rest api id, resource path, and http method (must be one of DELETE,
GET, HEAD, OPTIONS, PATCH, POST, PUT), return the method for the
api/resource path if defined. Return False if method is not defined.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_resource_method myapi_id resource_path httpmethod
R0 R1 R2 R3 u resourceu no such resourceu errorRB RZ u idt
httpMethodu methodu boto3.get_errorN( RO R' R4 t
get_methodR R ( RB t resourcePathR] R0 R1 R2 R3 RF RN R7 t methodR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_resource_method� s !"c C@ st yH t d | d | d | d | � } | j d | � } i t | � d 6SWn% t k
ro } i t d | � d 6SXd S(
u�
Gets info about the given api key
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_key apigw_api_key
R0 R1 R2 R3 t apiKeyu apiKeyu boto3.get_erroru errorN( R4 t get_api_keyR R R ( Rb R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_key� s !c C@ s� y[ t d | d | d | d | � } t | j d � } i g | D] } t | � ^ q@ d 6SWn% t k
r� } i t d | � d 6SXd S(
u�
Gets information about the defined API Keys. Return list of apiKeys.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_keys
R0 R1 R2 R3 u itemsu apiKeysu boto3.get_erroru errorN( R4 R/ t get_api_keysR R R ( R0 R1 R2 R3 R7 t apikeyst apikeyR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_keys� s !(c C@ s� y� | d
k r t � n | } t d | d | d | d | � } | j d | d | d | d | � } | st i t d 6Si t d 6t | � d
6SWn, t k
r� }
i t d 6t d |
� d 6SXd
S( u�
Create an API key given name and description.
An optional enabled argument can be provided. If provided, the
valid values are True|False. This argument defaults to True.
An optional stageKeys argument can be provided in the form of
list of dictionary with 'restApiId' and 'stageName' as keys.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_key name description
salt myminion boto_apigateway.create_api_key name description enabled=False
salt myminion boto_apigateway.create_api_key name description \
stageKeys='[{"restApiId": "id", "stageName": "stagename"}]'
R0 R1 R2 R3 R R6 t enabledt stageKeysu createdu apiKeyu boto3.get_erroru errorN( R t listR4 t create_api_keyR@ R? R R R ( R R6 Ri Rj R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyRl � s ! c C@ ss y@ t d | d | d | d | � } | j d | � i t d 6SWn, t k
rn } i t d 6t d | � d 6SXd S(
u�
Deletes a given apiKey
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_key apikeystring
R0 R1 R2 R3 Rb u deletedu boto3.get_erroru errorN( R4 t delete_api_keyR? R R@ R ( Rb R0 R1 R2 R3 R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyRm � s !c C@ s4 | j d | d i d d 6| d 6| d 6g � } | S( u;
the replace patch operation on an ApiKey resource
Rb t patchOperationsu replaceu opu pathu value( t update_api_key( R7 Rb RM t valueR ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _api_key_patch_replace s !c C@ s2 g | D]' \ } } i | d 6| d 6| d 6^ q S( u:
helper function to return patchOperations object
u opu pathu value( ( t opt pvlistt pR ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _api_key_patchops s c C@ s% | j d | d t d | � � } | S( ud
the add patch operation for a list of (path, value) tuples on an ApiKey resource list path
Rb Rn u add( Ro Ru ( R7 Rb Rs R ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _api_key_patch_add s c C@ s% | j d | d t d | � � } | S( ug
the remove patch operation for a list of (path, value) tuples on an ApiKey resource list path
Rb Rn u remove( Ro Ru ( R7 Rb Rs R ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _api_key_patch_remove$ s c C@ s� yR t d | d | d | d | � } t | | d | � } i t d 6t | � d 6SWn, t k
r� } i t d 6t d | � d 6SXd
S( u�
update the given apiKey with the given description.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.update_api_key_description api_key description
R0 R1 R2 R3 u /descriptionu updatedu apiKeyu boto3.get_erroru errorN( R4 Rq R? R R R@ R ( Rb R6 R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt update_api_key_description- s ! c C@ sw yK t d | d | d | d | � } t | | d d � } i t | � d 6SWn% t k
rr } i t d | � d 6SXd
S( u�
enable the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
R0 R1 R2 R3 u /enabledu Trueu apiKeyu boto3.get_erroru errorN( R4 Rq R R R ( Rb R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt enable_api_key@ s !c C@ sw yK t d | d | d | d | � } t | | d d � } i t | � d 6SWn% t k
rr } i t d | � d 6SXd
S( u�
disable the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
R0 R1 R2 R3 u /enabledu Falseu apiKeyu boto3.get_erroru errorN( R4 Rq R R R ( Rb R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt disable_api_keyS s !c C@ s� yn t d | d | d | d | � } g | D] } d | f ^ q+ } t | | | � } i t d 6t | � d 6SWn, t k
r� }
i t d 6t d |
� d 6SXd
S( u�
associate the given stagekeyslist to the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.associate_stagekeys_api_key \
api_key '["restapi id/stage name", ...]'
R0 R1 R2 R3 u /stagesu
associatedu apiKeyu boto3.get_erroru errorN( R4 Rv R? R R R@ R ( Rb t
stagekeyslistR0 R1 R2 R3 R7 t stagekeyRs R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt associate_api_key_stagekeysf s ! c C@ s� ya t d | d | d | d | � } g | D] } d | f ^ q+ } t | | | � } i t d 6SWn, t k
r� }
i t d 6t d |
� d 6SXd S(
u�
disassociate the given stagekeyslist to the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.disassociate_stagekeys_api_key \
api_key '["restapi id/stage name", ...]'
R0 R1 R2 R3 u /stagesu
disassociatedu boto3.get_erroru errorN( R4 Rw R? R R@ R ( Rb R{ R0 R1 R2 R3 R7 R| Rs R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt disassociate_api_key_stagekeys{ s ! c
C@ s� y� t d | d | d | d | � } g } | j d | � } xM t r� | r? | | d } d | k ri Pn | j d | d | d � } q? q? Wi g | D] } t | � ^ q� d 6SWn% t k
r� } i t d
| � d 6SXd S(
u�
Gets information about the defined API Deployments. Return list of api deployments.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_deployments restApiId
R0 R1 R2 R3 RB u itemsu positionR& u deploymentsu boto3.get_erroru errorN( R4 t get_deploymentsR? R R R (
RB R0 R1 R2 R3 R7 t deploymentst _deploymentst
deploymentR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_deployments� s ! #(c C@ sz yN t d | d | d | d | � } | j d | d | � } i t | � d 6SWn% t k
ru } i t d | � d 6SXd
S( u�
Get API deployment for a given restApiId and deploymentId.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_deployent restApiId deploymentId
R0 R1 R2 R3 RB t deploymentIdu
deploymentu boto3.get_erroru errorN( R4 t get_deploymentR R R ( RB R� R0 R1 R2 R3 R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_deployment� s !c
C@ s� ys t d | d | d | d | � } | j d | d | d i d d 6d
d 6| d 6g � } i t d
6t | � d 6SWn, t k
r� } i t d
6t d | � d 6SXd S( u�
Activates previously deployed deployment for a given stage
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.activate_api_deployent restApiId stagename deploymentId
R0 R1 R2 R3 RB t stageNameRn u replaceu opu
/deploymentIdu pathu valueu setu responseu boto3.get_erroru errorN( R4 t update_stageR? R R R@ R (
RB R� R� R0 R1 R2 R3 R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt activate_api_deployment� s !
u u 0.5c C@ s� y� | d k r t � n | } t d | d | d | d |
� } | j d | d | d | d | d | d
| d | � } i t d 6t | � d
6SWn, t k
r� }
i t d 6t d |
� d 6SXd S( u#
Creates a new API deployment.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_deployent restApiId stagename stageDescription='' \
description='' cacheClusterEnabled=True|False cacheClusterSize=0.5 variables='{"name": "value"}'
R0 R1 R2 R3 RB R� t stageDescriptionR6 t cacheClusterEnabledt cacheClusterSizet variablesu createdu
deploymentu boto3.get_erroru errorN( R R R4 t create_deploymentR? R R R@ R ( RB R� R� R6 R� R� R� R0 R1 R2 R3 R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_deployment� s ! c C@ sy yF t d | d | d | d | � } | j d | d | � i t d 6SWn, t k
rt } i t d 6t d | � d 6SXd
S( u�
Deletes API deployment for a given restApiId and deploymentID
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_deployent restApiId deploymentId
R0 R1 R2 R3 RB R� u deletedu boto3.get_erroru errorN( R4 t delete_deploymentR? R R@ R ( RB R� R0 R1 R2 R3 R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_deployment� s !c C@ s� y�t | | d | d | d | d | �} | j d � rT i t d 6| j d � d 6St d | d | d | d | � } | j d � } | j d i � }
g } xH |
D]@ } | | k r� | j t d d
d d j | � d
d � � q� q� Wxg t j | � D]V \ }
} |
|
k s |
|
| k r� | j t d d d d j |
� d
| � � q� q� W| rx| j d | d | d | � } n i t
d 6t | � d 6SWn, t k
r�} i t d 6t
d | � d 6SXd S( u
Overwrite the stage variables for the given restApiId and stage name with the given variables,
variables must be in the form of a dictionary. Overwrite will always remove all the existing
stage variables associated with the given restApiId and stage name, follow by the adding of all the
variables specified in the variables dictionary
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.overwrite_api_stage_variables restApiId stageName variables='{"name": "value"}'
R0 R1 R2 R3 u erroru overwriteu stageu variablesRr u removeRM u /variables/{0}Rp u u replaceRB R� Rn u boto3.get_errorN( t describe_api_stageR' R@ R4 RT R R R R R� R? R R R ( RB R� R� R0 R1 R2 R3 t resR7 t staget old_varst patch_opst old_vart vart valR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt overwrite_api_stage_variables s0 '!
c C@ sz yN t d | d | d | d | � } | j d | d | � } i t | � d 6SWn% t k
ru } i t d | � d 6SXd
S( u�
Get API stage for a given apiID and stage name
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_stage restApiId stageName
R0 R1 R2 R3 RB R� u stageu boto3.get_erroru errorN( R4 t get_stageR R R ( RB R� R0 R1 R2 R3 R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyR� 2 s !c
C@ s� ye t d | d | d | d | � } | j d | d | � } i g | d D] } t | � ^ qJ d 6SWn% t k
r� } i t d | � d
6SXd S( u�
Get all API stages for a given apiID and deploymentID
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_stages restApiId deploymentId
R0 R1 R2 R3 RB R� u itemu stagesu boto3.get_erroru errorN( R4 t
get_stagesR R R (
RB R� R0 R1 R2 R3 R7 t stagesR� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_stagesE s !,c C@ s� y� | d k r t � n | } t d | d | d | d |
� } | j d | d | d | d | d | d
| d | � } i t d 6t | � d
6SWn, t k
r� }
i t d 6t d |
� d 6SXd S( u@
Creates a new API stage for a given restApiId and deploymentId.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_stage restApiId stagename deploymentId \
description='' cacheClusterEnabled=True|False cacheClusterSize='0.5' variables='{"name": "value"}'
R0 R1 R2 R3 RB R� R� R6 R� R� R� u createdu stageu boto3.get_erroru errorN( R R R4 t create_stageR? R R R@ R ( RB R� R� R6 R� R� R� R0 R1 R2 R3 R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_stageX s ! c C@ sy yF t d | d | d | d | � } | j d | d | � i t d 6SWn, t k
rt } i t d 6t d | � d 6SXd
S( u�
Deletes stage identified by stageName from API identified by restApiId
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_stage restApiId stageName
R0 R1 R2 R3 RB R� u deletedu boto3.get_erroru errorN( R4 t delete_stageR? R R@ R ( RB R� R0 R1 R2 R3 R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_stager s !c C@ sy yF t d | d | d | d | � } | j d | d | � i t d 6SWn, t k
rt } i t d 6t d | � d 6SXd
S( u�
Flushes cache for the stage identified by stageName from API identified by restApiId
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.flush_api_stage_cache restApiId stageName
R0 R1 R2 R3 RB R� u flushedu boto3.get_erroru errorN( R4 t flush_stage_cacheR? R R@ R ( RB R� R0 R1 R2 R3 R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt flush_api_stage_cache� s !c C@ s( y� t | | d | d | d | d |
�j d � } | r� | d k rN t � n | } | d k ri t � n | } t d | d | d | d |
� } | j d | d | d d | d
t | � d | d | d
| � }
i t d 6|
d 6Si t d 6d d 6SWn, t k
r#} i t d 6t
d | � d 6SXd S( uN
Creates API method for a resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_method restApiId resourcePath, httpMethod, authorizationType, \
apiKeyRequired=False, requestParameters='{"name", "value"}', requestModels='{"content-type", "value"}'
R0 R1 R2 R3 u resourceRB RZ u idR] t authorizationTypet apiKeyRequiredt requestParameterst
requestModelsu createdu methodu Failed to create methodu erroru boto3.get_errorN( RO R' R R R4 t
put_methodt strR? R@ R R ( RB R_ R] R� R� R� R� R0 R1 R2 R3 RN R7 R` R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_method� s ! c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | � } i t | � d
6Si d d 6SWn% t k
r� }
i t d
|
� d 6SXd S( u�
Get API method for a resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_method restApiId resourcePath httpMethod
R0 R1 R2 R3 u resourceRB RZ u idR] u methodu' get API method failed: no such resourceu erroru boto3.get_errorN( RO R' R4 R^ R R R ( RB R_ R] R0 R1 R2 R3 RN R7 R` R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_method� s !"c
C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | � i t d
6Si t d
6d d 6SWn, t k
r� } i t d
6t d
| � d 6SXd S( u�
Delete API method for a resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_method restApiId resourcePath httpMethod
R0 R1 R2 R3 u resourceRB RZ u idR] u deletedu' get API method failed: no such resourceu erroru boto3.get_errorN( RO R' R4 t
delete_methodR? R@ R R (
RB R_ R] R0 R1 R2 R3 RN R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_method� s ! c
C@ s" y� t | | d | d | d | d | �j d � }
|
r� | d k rN t � n | } | d k ri t � n | } t d | d | d | d | � } | j d | d |
d d | d
t | � d | d | � } i t d
6| d 6Si t d
6d d 6SWn, t k
r }
i t d
6t
d |
� d 6SXd S( uZ
Create API method response for a method on a given resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_method_response restApiId resourcePath httpMethod \
statusCode responseParameters='{"name", "True|False"}' responseModels='{"content-type", "model"}'
R0 R1 R2 R3 u resourceRB RZ u idR] t
statusCodet responseParameterst responseModelsu createdu responseu no such resourceu erroru boto3.get_errorN( RO R' R R R4 t put_method_responseR� R? R@ R R ( RB R_ R] R� R� R� R0 R1 R2 R3 RN R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_method_response� s
!c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | d
t | � � i t d 6Si t d 6d d
6SWn, t k
r� }
i t d 6t d |
� d
6SXd S( u�
Delete API method response for a resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_method_response restApiId resourcePath httpMethod statusCode
R0 R1 R2 R3 u resourceRB RZ u idR] R� u deletedu no such resourceu erroru boto3.get_errorN( RO R' R4 t delete_method_responseR� R? R@ R R ( RB R_ R] R� R0 R1 R2 R3 RN R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_method_response s ! c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | d
t | � � }
i t |
� d 6Si d d
6SWn% t k
r� } i t d | � d
6SXd S( u�
Get API method response for a resource in the given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_method_response restApiId resourcePath httpMethod statusCode
R0 R1 R2 R3 u resourceRB RZ u idR] R� u responseu no such resourceu erroru boto3.get_errorN( RO R' R4 t get_method_responseR� R R R ( RB R_ R] R� R0 R1 R2 R3 RN R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_method_response s !c C@ s� ya t d | d | d | d | � } t | j d d | �} i g | D] } t | � ^ qF d 6SWn% t k
r� } i t d | � d 6SXd
S( u�
Get all models for a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_models restApiId
R0 R1 R2 R3 u itemsRB u modelsu boto3.get_erroru errorN( R4 R/ t
get_modelsR R R ( RB R0 R1 R2 R3 R7 t modelst modelR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_models6 s !(c
C@ s� yT t d | d | d | d | � } | j d | d | d | � } i t | � d 6SWn% t k
r{ } i t d | � d
6SXd S( u�
Get a model by name for a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_model restApiId modelName [True]
R0 R1 R2 R3 RB t modelNamet flattenu modelu boto3.get_erroru errorN( R4 t get_modelR R R (
RB R� R� R0 R1 R2 R3 R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_modelI s ! c C@ sA t | | d | d | d | d | �} i t | j d � � d 6S( u�
Check to see if the given modelName exists in the given restApiId
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.api_model_exists restApiId modelName
R0 R1 R2 R3 u modelu exists( R� R; R' ( RB R� R0 R1 R2 R3 RF ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt api_model_exists\ s
'c C@ s: | j d | d | d i d d 6| d 6| d 6g � } | S( u9
the replace patch operation on a Model resource
RB R� Rn u replaceu opu pathu value( t update_model( R7 RB R� RM Rp R ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _api_model_patch_replacek s !c C@ s� y t | t � r' t j j j | � n | } t d | d | d | d | � } t | | | d | � } i t d 6t | � d 6SWn, t
k
r� }
i t d 6t d |
� d 6SXd
S( u�
update the schema (in python dictionary format) for the given model in the given restApiId
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.update_api_model_schema restApiId modelName schema
R0 R1 R2 R3 u /schemau updatedu modelu boto3.get_erroru errorN(
R R R R
t jsont dumpsR4 R� R? R R R@ R ( RB R� t schemaR0 R1 R2 R3 t schema_jsonR7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt update_api_model_schemat s *! c C@ sy yF t d | d | d | d | � } | j d | d | � i t d 6SWn, t k
rt } i t d 6t d | � d 6SXd
S( u�
Delete a model identified by name in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_model restApiId modelName
R0 R1 R2 R3 RB R� u deletedu boto3.get_erroru errorN( R4 t delete_modelR? R R@ R ( RB R� R0 R1 R2 R3 R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_model� s !u application/jsonc
C@ s� y� t | t � r' t j j j | � n | } t d | d | d | d | � }
|
j d | d | d | d | d | � } i t d
6t | � d 6SWn, t
k
r� } i t d
6t d | � d
6SXd S( u#
Create a new model in a given API with a given schema, currently only contentType supported is
'application/json'
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_model restApiId modelName modelDescription '<schema>' 'content-type'
R0 R1 R2 R3 RB R R6 R� t contentTypeu createdu modelu boto3.get_erroru errorN(
R R R R
R� R� R4 t create_modelR? R R R@ R (
RB R� t modelDescriptionR� R� R0 R1 R2 R3 R� R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_model� s
*! c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | � } i t | � d
6Si d d 6SWn% t k
r� }
i t d
|
� d 6SXd S( u�
Get an integration for a given method in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_integration restApiId resourcePath httpMethod
R0 R1 R2 R3 u resourceRB RZ u idR] u integrationu no such resourceu erroru boto3.get_errorN( RO R' R4 t get_integrationR R R ( RB R_ R] R0 R1 R2 R3 RN R7 t integrationR8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_api_integration� s !"c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | d
| � }
i t |
� d 6Si d d
6SWn% t k
r� } i t d | � d
6SXd S( u�
Get an integration response for a given method in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_integration_response restApiId resourcePath httpMethod statusCode
R0 R1 R2 R3 u resourceRB RZ u idR] R� u responseu no such resourceu erroru boto3.get_errorN( RO R' R4 t get_integration_responseR R R ( RB R_ R] R� R0 R1 R2 R3 RN R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt! describe_api_integration_response� s !c
C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | � i t d
6Si t d
6d d 6SWn, t k
r� } i t d
6t d
| � d 6SXd S( u�
Deletes an integration for a given method in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_integration restApiId resourcePath httpMethod
R0 R1 R2 R3 u resourceRB RZ u idR] u deletedu no such resourceu erroru boto3.get_errorN( RO R' R4 t delete_integrationR? R@ R R (
RB R_ R] R0 R1 R2 R3 RN R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_integration� s ! c C@ s� y� t | | d | d | d | d | �j d � } | r� t d | d | d | d | � } | j d | d | d d | d
| � i t d 6Si t d 6d d
6SWn, t k
r� }
i t d 6t d |
� d
6SXd S( u�
Deletes an integration response for a given method in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_integration_response restApiId resourcePath httpMethod statusCode
R0 R1 R2 R3 u resourceRB RZ u idR] R� u deletedu no such resourceu erroru boto3.get_errorN( RO R' R4 t delete_integration_responseR? R@ R R ( RB R_ R] R� R0 R1 R2 R3 RN R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt delete_api_integration_response� s !
c C@ sH | j d � r | St d d | d | d | d | � } d j | | � S( uJ
Helper function to get an ARN if name does not look like an ARN.
u arn:aws:iam:u boto_iam.get_account_idR0 R1 R2 R3 u arn:aws:iam::{0}:role/{1}( t
startswitht __salt__R ( R R0 R1 R2 R3 t
account_id( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
_get_role_arn s
c
C@ ss y@t | d | d |
d | d | �} t | | d | d |
d | d | �j d � }
|
r-| d k rr t � n | } | d k r� t � n | } t d | d |
d | d | � } | j � d k r� d } d } n | j d | d |
d
d | d | d
| d | d | d | d | � } i t d 6| d 6Si t d 6d d 6SWn, t
k
rn} i t d 6t d | � d 6SXd S( uy
Creates an integration for a given method in a given API.
If integrationType is MOCK, uri and credential parameters will be ignored.
uri is in the form of (substitute APIGATEWAY_REGION and LAMBDA_FUNC_ARN)
"arn:aws:apigateway:APIGATEWAY_REGION:lambda:path/2015-03-31/functions/LAMBDA_FUNC_ARN/invocations"
credentials is in the form of an iam role name or role arn.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_integration restApiId resourcePath httpMethod \
integrationType integrationHttpMethod uri credentials ['{}' ['{}']]
R0 R1 R2 R3 u resourceu optionsu RB RZ u idR] t typet integrationHttpMethodt urit credentialsR� t requestTemplatesu createdu integrationu no such resourceu erroru boto3.get_errorN( R� RO R' R R R4 t lowert put_integrationR? R@ R R ( RB R_ R] t integrationTypeR� R� R� R� R� R0 R1 R2 R3 RN R7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_integration s& $ ! c C@ s" y� t | | d | d | d | d |
�j d � } | r� | d k rN t � n | } | d k ri t � n | } t d | d | d | d |
� } | j d | d | d d | d
| d | d | d
| � }
i t d 6|
d 6Si t d 6d d 6SWn, t k
r } i t d 6t d | � d 6SXd S( u)
Creates an integration response for a given method in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_api_integration_response restApiId resourcePath httpMethod \
statusCode selectionPattern ['{}' ['{}']]
R0 R1 R2 R3 u resourceRB RZ u idR] R� t selectionPatternR� t responseTemplatesu createdu responseu no such resourceu erroru boto3.get_errorN(
RO R' R R R4 t put_integration_responseR? R@ R R ( RB R_ R] R� R� R� R� R0 R1 R2 R3 RN R7 R R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt create_api_integration_responseK s ! c C@ s' g | D] } | | | k r | ^ q S( uW
Helper to return list of usage plan items matching the given attribute value.
( ( t attrR t planst plan( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt
_filter_plansl s c
C@ s� y� t d | d | d | d | � } t | j d � } | rQ t d | | � } n | rl t d | | � } n i g | D] } t | � ^ qv d 6SWn% t k
r� } i t d | � d
6SXd S( u�
Returns a list of existing usage plans, optionally filtered to match a given plan name
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_usage_plans
salt myminion boto_apigateway.describe_usage_plans name='usage plan name'
salt myminion boto_apigateway.describe_usage_plans plan_id='usage plan id'
R0 R1 R2 R3 u itemsu nameu idu plansu boto3.get_erroru errorN( R4 R/ t get_usage_plansR� R R R (
R t plan_idR0 R1 R2 R3 R7 R� R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt describe_usage_planss s !(c C@ s: | d k r6 t | t � s6 t d j | � � � q6 n d S( u?
Helper to verify that throttling parameters are valid
u2 throttle must be a dictionary, provided value: {0}N( R R R t TypeErrorR ( t throttle( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _validate_throttle� s c C@ s� | d
k r� t | t � s3 t d j | � � � n d d d g } d | k s^ | d | k r t d j d j | � � � � n d | k r� t d � � q� n d
S( u:
Helper to verify that quota parameters are valid
u/ quota must be a dictionary, provided value: {0}u DAYu WEEKu MONTHu periodu> quota must have a valid period specified, valid values are {0}u ,u limitu# quota limit must have a valid valueN( R R R R� R t
ValueErrort join( t quotat periods( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _validate_quota� s ! c C@ s� y� t | � t | � t d | � } | r9 | | d <n | rL | | d <n | r_ | | d <n t d | d | d | d | � } | j | � }
i t d 6|
d
6SWnN t k
r� } i t d | � d 6St t f k
r� } i t
j | � d 6SXd
S( u�
Creates a new usage plan with throttling and quotas optionally applied
.. versionadded:: 2017.7.0
name
Name of the usage plan
throttle
A dictionary consisting of the following keys:
rateLimit
requests per second at steady rate, float
burstLimit
maximum number of requests per second, integer
quota
A dictionary consisting of the following keys:
limit
number of allowed requests per specified quota period [required if quota parameter is present]
offset
number of requests to be subtracted from limit at the beginning of the period [optional]
period
quota period, must be one of DAY, WEEK, or MONTH. [required if quota parameter is present
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.create_usage_plan name='usage plan name' throttle='{"rateLimit": 10.0, "burstLimit": 10}'
R u descriptionu throttleu quotaR0 R1 R2 R3 u createdu resultu boto3.get_erroru errorN( R� R� R R4 t create_usage_planR? R R R� R� R t text_type( R R6 R� R� R0 R1 R2 R3 t valuesR7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyR� � s" %
!c C@ s, y�t | � t | � t d | d | d | d | � } g } | d k rh | j i d d 6d d 6� nv d | k r� | j i d
d 6d d 6t | d � d 6� n d
| k r� | j i d
d 6d d 6t | d
� d 6� n | d k r| j i d d 6d d 6� n� | j i d
d 6d d 6t | d � d 6� | j i d
d 6d d 6t | d � d 6� d | k r�| j i d
d 6d d 6t | d � d 6� n | r�| j d | d | � } i t d 6| d 6Si t d 6SWnN t k
r�}
i t
d |
� d 6St t f k
r'}
i t
j |
� d 6SXd S( u�
Updates an existing usage plan with throttling and quotas
.. versionadded:: 2017.7.0
plan_id
Id of the created usage plan
throttle
A dictionary consisting of the following keys:
rateLimit
requests per second at steady rate, float
burstLimit
maximum number of requests per second, integer
quota
A dictionary consisting of the following keys:
limit
number of allowed requests per specified quota period [required if quota parameter is present]
offset
number of requests to be subtracted from limit at the beginning of the period [optional]
period
quota period, must be one of DAY, WEEK, or MONTH. [required if quota parameter is present
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.update_usage_plan plan_id='usage plan id' throttle='{"rateLimit": 10.0, "burstLimit": 10}'
R0 R1 R2 R3 u removeu opu /throttleu pathu rateLimitu replaceu /throttle/rateLimitu valueu
burstLimitu /throttle/burstLimitu /quotau
/quota/periodu periodu /quota/limitu limitu offsetu
/quota/offsett usagePlanIdRn u updatedu resultu boto3.get_erroru errorN( R� R� R4 R RT R� t update_usage_planR? R@ R R R� R� R R� ( R� R� R� R0 R1 R2 R3 R7 Rn R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyR� � s4 %
! / / ,, / c C@ s� y� t d | d | d | d | d | � } d | k rE i | d d 6Sd | k r� | d r� t d | d | d | d | � } | j d | � } n i t d 6| d
6SWn% t k
r� } i t d | � d 6SXd S(
u�
Deletes usage plan identified by plan_id
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_usage_plan plan_id='usage plan id'
R� R0 R1 R2 R3 u erroru plansR� u deletedu usagePlanIdu boto3.get_errorN( R� R4 t delete_usage_planR? R R ( R� R0 R1 R2 R3 t existingR7 R� R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyR� + s
' !c C@ s� y� g } xD | D]< } | j i | d 6d d 6d j | d | d � d 6� q Wd } | r� t d | d | d
| d | � }
|
j d | d
| � } n i t d 6| d 6SWn? t k
r� } i t d | � d 6St k
r� } i | d 6SXd S( u�
Helper function that updates the usage plan identified by plan_id by adding or removing it to each of the stages, specified by apis parameter.
apis
a list of dictionaries, where each dictionary contains the following:
apiId
a string, which is the id of the created API in AWS ApiGateway
stage
a string, which is the stage that the created API is deployed to.
op
'add' or 'remove'
u opu
/apiStagesu pathu {0}:{1}u apiIdu stageu valueR0 R1 R2 R3 R� Rn u successu resultu boto3.get_erroru errorN( RT R R R4 R� R? R R t Exception( R� R! Rr R0 R1 R2 R3 Rn R" R� R7 R8 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt _update_usage_plan_apisF s"
#! c C@ s( t | | d d | d | d | d | �S( uR
Attaches given usage plan to each of the apis provided in a list of apiId and stage values
.. versionadded:: 2017.7.0
apis
a list of dictionaries, where each dictionary contains the following:
apiId
a string, which is the id of the created API in AWS ApiGateway
stage
a string, which is the stage that the created API is deployed to.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.attach_usage_plan_to_apis plan_id='usage plan id' apis='[{"apiId": "some id 1", "stage": "some stage 1"}]'
u addR0 R1 R2 R3 ( R� ( R� R! R0 R1 R2 R3 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt attach_usage_plan_to_apisj s c C@ s( t | | d d | d | d | d | �S( uS
Detaches given usage plan from each of the apis provided in a list of apiId and stage value
.. versionadded:: 2017.7.0
apis
a list of dictionaries, where each dictionary contains the following:
apiId
a string, which is the id of the created API in AWS ApiGateway
stage
a string, which is the stage that the created API is deployed to.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.detach_usage_plan_to_apis plan_id='usage plan id' apis='[{"apiId": "some id 1", "stage": "some stage 1"}]'
u removeR0 R1 R2 R3 ( R� ( R� R! R0 R1 R2 R3 ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt detach_usage_plan_from_apis� s (d t __doc__t
__future__R R R t loggingR t salt.extR t salt.utils.compatR t salt.utils.jsont salt.utils.versionst getLoggerR t logt botot boto3t botocore.exceptionsR t botocoreR t found_botocore_versiont setLevelt CRITICALR? R t ImportErrorR@ R
R R R# R% R/ R R9 R: R< RA RG RL RO RY R\ Ra Rd Rh Rl Rm Rq Ru Rv Rw Rx Ry Rz R} R~ R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R R ( ( ( s@ /usr/lib/python2.7/site-packages/salt/modules/boto_apigateway.pyt <module>M s�
& % . * :J$
Mini Shell