Current File : //lib/python2.7/site-packages/salt/states/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 Z d d l Z d d l Z
d d l Z
d d l Z
d d l
m Z e j e � Z d � Z e e e e e e d d e e d �
Z d � Z e e e e e d
� Z d � Z e d � Z d
� Z d d d d d d d d d d d f d � Z d � Z d � Z d e f d � � YZ e e e e e e e d � Z! e e e e d � Z" e e e e d � Z# e e e e d! � Z$ d S(" u�
Manage Apigateway Rest APIs
===========================
.. versionadded:: 2016.11.0
:depends:
- boto >= 2.8.0
- boto3 >= 1.2.1
- botocore >= 1.4.49
Create and destroy rest apis depending on a swagger version 2 definition file.
Be aware that this interacts with Amazon's services, and so may incur charges.
This module uses ``boto3``, which can be installed via package, or pip.
This module accepts explicit vpc 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 `here
<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 file or
in the minion's config file:
.. code-block:: yaml
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
It's also possible to specify ``key``, ``keyid`` and ``region`` via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.. code-block:: yaml
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
.. code-block:: yaml
Ensure Apigateway API exists:
boto_apigateway.present:
- name: myfunction
- region: us-east-1
- keyid: GKTADJGHEIQSXMKKRBJ08H
- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
i ( t absolute_importt print_functiont unicode_literalsN( t sixc C@ s d t k r d St S( u)
Only load if boto is available.
u boto_apigateway.describe_apisu boto_apigateway( t __salt__t False( ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt __virtual__H s u! {stage}_{api}_{resource}_{method}u NONEc
C@ s8 i | d 6t d 6d d 6i d 6} y�t d | f d | f d |
f d | f g � } t | | | | | | | � } t | � } | j | � } | j d
� r� t d r� d j | | | | � | d <d | d <| S| j | | � S| j d
� r3t d r#d j | | | | � | d <d | d <n | j
| | � St d rgd j | | | | � | d <d | d <| S| j | � } | j d � r�| S| j | � } | j d � r�| S| j
| d | d | d | d |
�} | j d � r�| S| j | | � } Wn9 t t f k
r3} t | d <d j | j � | d <n X| S( u,
Ensure the spcified api_name with the corresponding swaggerfile is deployed to the
given stage_name in AWS ApiGateway.
this state currently only supports ApiGateway integration with AWS Lambda, and CORS support is
handled through a Mock integration.
There may be multiple deployments for the API object, each deployment is tagged with a description
(i.e. unique label) in pretty printed json format consisting of the following key/values.
.. code-block:: text
{
"api_name": api_name,
"swagger_file": basename_of_swagger_file
"swagger_file_md5sum": md5sum_of_swagger_file,
"swagger_info_object": info_object_content_in_swagger_file
}
Please note that the name of the lambda function to be integrated will be derived
via the provided lambda_funcname_format parameters:
- the default lambda_funcname_format is a string with the following
substitutable keys: "{stage}_{api}_{resource}_{method}". The user can
choose to reorder the known keys.
- the stage key corresponds to the stage_name passed in.
- the api key corresponds to the api_name passed in.
- the resource corresponds to the resource path defined in the passed swagger file.
- the method corresponds to the method for a resource path defined in the passed swagger file.
For the default lambda_funcname_format, given the following input:
.. code-block:: python
api_name = ' Test Service'
stage_name = 'alpha'
basePath = '/api'
path = '/a/{b}/c'
method = 'POST'
We will end up with the following Lambda Function Name that will be looked
up: 'test_service_alpha_a_b_c_post'
The canconicalization of these input parameters is done in the following order:
1. lambda_funcname_format is formatted with the input parameters as passed,
2. resulting string is stripped for leading/trailing spaces,
3. path parameter's curly braces are removed from the resource path,
4. consecutive spaces and forward slashes in the paths are replaced with '_'
5. consecutive '_' are replaced with '_'
Please note that for error response handling, the swagger file must have an error response model
with the following schema. The lambda functions should throw exceptions for any non successful responses.
An optional pattern field can be specified in errorMessage field to aid the response mapping from Lambda
to the proper error return status codes.
.. code-block:: yaml
Error:
type: object
properties:
stackTrace:
type: array
items:
type: array
items:
type: string
description: call stack
errorType:
type: string
description: error type
errorMessage:
type: string
description: |
Error message, will be matched based on pattern.
If no pattern is specified, the default pattern used for response mapping will be +*.
name
The name of the state definition
api_name
The name of the rest api that we want to ensure exists in AWS API Gateway
swagger_file
Name of the location of the swagger rest api definition file in YAML format.
stage_name
Name of the stage we want to be associated with the given api_name and swagger_file
definition
api_key_required
True or False - whether the API Key is required to call API methods
lambda_integration_role
The name or ARN of the IAM role that the AWS ApiGateway assumes when it
executes your lambda function to handle incoming requests
lambda_region
The region where we expect to find the lambda functions. This is used to
determine the region where we should look for the Lambda Function for
integration purposes. The region determination is based on the following
priority:
1. lambda_region as passed in (is not None)
2. if lambda_region is None, use the region as if a boto_lambda
function were executed without explicitly specifying lambda region.
3. if region determined in (2) is different than the region used by
boto_apigateway functions, a final lookup will be attempted using
the boto_apigateway region.
stage_variables
A dict with variables and their values, or a pillar key (string) that
contains a dict with variables and their values.
key and values in the dict must be strings. {'string': 'string'}
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
lambda_funcname_format
Please review the earlier example for the usage. The only substituable keys in the funcname
format are {stage}, {api}, {resource}, {method}.
Any other keys or positional subsitution parameters will be flagged as an invalid input.
authorization_type
This field can be either 'NONE', or 'AWS_IAM'. This will be applied to all methods in the given
swagger spec file. Default is set to 'NONE'
error_response_template
String value that defines the response template mapping that should be applied in cases error occurs.
Refer to AWS documentation for details: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
If set to None, the following default value is used:
.. code-block:: text
'#set($inputRoot = $input.path('$'))\n'
'{\n'
' "errorMessage" : "$inputRoot.errorMessage",\n'
' "errorType" : "$inputRoot.errorType",\n'
' "stackTrace" : [\n'
'#foreach($stackTrace in $inputRoot.stackTrace)\n'
' [\n'
'#foreach($elem in $stackTrace)\n'
' "$elem"\n'
'#if($foreach.hasNext),#end\n'
'#end\n'
' ]\n'
'#if($foreach.hasNext),#end\n'
'#end\n'
' ]\n'
.. versionadded:: 2017.7.0
response_template
String value that defines the response template mapping applied in case
of success (including OPTIONS method) If set to None, empty ({})
template is assumed, which will transfer response from the lambda
function as is.
.. versionadded:: 2017.7.0
u nameu resultu u commentu changesu regionu keyu keyidu profileu publishu testu� [stage: {0}] will be reassociated to an already available deployment that matched the given [api_name: {1}] and [swagger_file: {2}].
Stage variables will be set to {3}.u currentu� [stage: {0}] is already at desired state with an associated deployment matching the given [api_name: {1}] and [swagger_file: {2}].
Stage variables will be set to {3}.u� There is no deployment matching the given [api_name: {0}] and [swagger_file: {1}]. A new deployment will be created and the [stage_name: {2}] will then be associated to the newly created deployment.
Stage variables will be set to {3}.u abortt api_key_requiredt lambda_integration_rolet
lambda_regiont authorization_typeu {0}N( t Truet dictt _Swaggert _get_stage_variablest
verify_apit gett __opts__t formatt Nonet publish_apit overwrite_stage_variablest
deploy_apit
deploy_modelst deploy_resourcest
ValueErrort IOErrorR t args( t namet api_namet swagger_filet
stage_nameR R R t stage_variablest regiont keyt keyidt profilet lambda_funcname_formatR
t error_response_templatet response_templatet rett common_argst swaggert
stage_varst e( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt presentO sh �
c C@ s� t � } | d k r | St | t j � r� | t k rD t | } n t j d i � } | | k ro | | } n | t k r� t | } q� n t | t � r� | } n t | t � s� t � } n | S( uh
Helper function to retrieve stage variables from pillars/options, if the
input is a string
u masterN( R R t
isinstanceR t string_typesR t
__pillar__R ( R R( t master_opts( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR V s
c C@ sd i | d 6t d 6d d 6i d 6} yt d | f d | f d | f d | f g � } t | | d d d d | � }
|
j s� d
j | � | d <| St d r� | r� d j | | � | d <n d
j | � | d <d | d <| S|
j | � } | j d � r� | S| r#|
j � r#|
j
| � } n Wn9 t t f k
r_} t
| d <d j | j � | d <n X| S( uE
Ensure the stage_name associated with the given api_name deployed by boto_apigateway's
present state is removed. If the currently associated deployment to the given stage_name has
no other stages associated with it, the deployment will also be removed.
name
Name of the swagger file in YAML format
api_name
Name of the rest api on AWS ApiGateway to ensure is absent.
stage_name
Name of the stage to be removed irrespective of the swagger file content.
If the current deployment associated with the stage_name has no other stages associated
with it, the deployment will also be removed.
nuke_api
If True, removes the API itself only if there are no other stages associated with any other
deployments once the given stage_name is removed.
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
u nameu resultu u commentu changesu regionu keyu keyidu profileu [Rest API: {0}] does not exist.u testuf [stage: {0}] will be deleted, if there are no other active stages, the [api: {1} will also be deleted.u [stage: {0}] will be deleted.u abortu {0}N( R R R
R t restApiIdR R t delete_stageR t no_more_deployments_remaint
delete_apiR R R R ( R R R t nuke_apiR! R" R# R$ R( R) R* R, ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt absentp s: #
c @ s� t j � } t j j j | d � �7 � x- t � f d � d � D] } | j | � q@ WWd QXx* | D]" } | j t j t
| � � � qd W| j � S( u�
helper function to generate a md5 hash of the swagger definition file
any extra argument passed to the function is converted to a string
and participates in the hash calculation
u rbc @ s
� j d � S( Ni ( t read( ( t f( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt <lambda>� s t N( t hashlibt md5t saltt utilst filest fopent itert updateR t bt strt hexdigest( t fnameR t _hasht chunkt extra_arg( ( R9 s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _gen_md5_filehash� s
c C@ s% t j j j | d d d d d | �S( u@
helper function to generate pretty printed json output
t indenti t
separatorsu ,u : t sort_keys( u ,u : ( R> R? t jsont dumps( t dRN ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _dict_to_json_pretty� s c C@ sg x` | D]X } | j | � r t S| j � j d | j � � rC t S| j � | j � k r t Sq Wt S( uW
Helper function to see if given name has any of the patterns in given matches
u _( t endswithR t lowerR ( R t matchest m( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt
_name_matches� s
u idu nameu pathu
httpMethodu
statusCodeu Createdu Deletedu Updatedu Flushedu
Associatedu
Disassociatedc C@ s i } t | t � rxt j | � D]� \ } } t | t � r� | d k rR | n t | | � } | sv t | | � r| | | <qq% t | t � r� g } xB | D]: } t | | � } | s� t | | � r� | j | � q� q� W| r| | | <qq% t | | � r% | | | <q% q% Wn | S( u�
Helper function to reduce the amount of information that will be kept in the change log
for API GW related return values
u variables( R. R R t iteritemst _object_reducerRW t listt append( t ot namest resultt kt vt reducedt newlistt val( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyRY � s$ !
c C@ sB | d j d g � } | j i t | � | 6� | | d d <| S( uG
For logging create/update/delete operations to AWS ApiGateway
u changesu new( R R[ RY ( R( t changekeyt changevaluet cl( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _log_changes s c C@ sC t | d <t | d <d | k r? d j | j d � � | d <n | S( uB
helper function to update errors in the return structure
u resultu abortu erroru {0}u comment( R R R R ( R( t obj( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _log_error_and_abort s
R
c B@ s� e Z d Z dU Z dV Z dW Z dX Z e j d � Z d Z
i d d 6Z i d d 6Z i d d 6Z
i Z e i d d 6d d! 6� Z d" e f d# � � YZ d$ e f d% � � YZ d& � Z d' � Z d( � Z d) � Z d* � Z e d+ � � Z e d, � � Z e d- � � Z e d. � � Z e d/ � � Z d0 � Z d1 � Z e d2 � � Z! e d3 � � Z" e d4 � � Z# e# j$ d5 � � Z# e d6 � � Z% e d7 � � Z& d8 � Z' d9 � Z( d: � Z) d; � Z* d< � Z+ d= � Z, d> � Z- d? � Z. d@ � Z/ dA � Z0 dB � Z1 dC � Z2 dD � Z3 dE � Z4 dF � Z5 dG � Z6 dH � Z7 dI � Z8 dJ � Z9 dK � Z: dL � Z; dM � Z< dN � Z= dO � Z> dP � Z? dQ � Z@ dR � ZA dS � ZB dT � ZC RS(Y u
this is a helper class that holds the swagger definition file and the associated logic
related to how to interpret the file and apply it to AWS Api Gateway.
The main interface to the outside world is in deploy_api, deploy_models, and deploy_resources
methods.
u swaggeru infou hostu basePathu schemesu consumesu producesu pathsu definitionsu
parametersu responsesu securityDefinitionsu securityu tagsu externalDocsu getu putu postu deleteu optionsu headu patchu 2.0u ^x-u' http://json-schema.org/draft-04/schema#u/ #set($inputRoot = $input.path('$'))
{
"header_params" : {
#set ($map = $input.params().header)
#foreach( $param in $map.entrySet() )
"$param.key" : "$param.value" #if( $foreach.hasNext ), #end
#end
},
"query_params" : {
#set ($map = $input.params().querystring)
#foreach( $param in $map.entrySet() )
"$param.key" : "$param.value" #if( $foreach.hasNext ), #end
#end
},
"path_params" : {
#set ($map = $input.params().path)
#foreach( $param in $map.entrySet() )
"$param.key" : "$param.value" #if( $foreach.hasNext ), #end
#end
},
"apigw_context" : {
"apiId": "$context.apiId",
"httpMethod": "$context.httpMethod",
"requestId": "$context.requestId",
"resourceId": "$context.resourceId",
"resourcePath": "$context.resourcePath",
"stage": "$context.stage",
"identity": {
"user":"$context.identity.user",
"userArn":"$context.identity.userArn",
"userAgent":"$context.identity.userAgent",
"sourceIp":"$context.identity.sourceIp",
"cognitoIdentityId":"$context.identity.cognitoIdentityId",
"cognitoIdentityPoolId":"$context.identity.cognitoIdentityPoolId",
"cognitoAuthenticationType":"$context.identity.cognitoAuthenticationType",
"cognitoAuthenticationProvider":["$util.escapeJavaScript($context.identity.cognitoAuthenticationProvider)"],
"caller":"$context.identity.caller",
"apiKey":"$context.identity.apiKey",
"accountId":"$context.identity.accountId"
}
},
"body_params" : $input.json('$'),
"stage_variables": {
#foreach($variable in $stageVariables.keySet())
"$variable": "$util.escapeJavaScript($stageVariables.get($variable))"
#if($foreach.hasNext), #end
#end
}
}u application/jsonu {"statusCode": 200}u< #set($inputRoot = $input.path('$'))
{
"errorMessage" : "$inputRoot.errorMessage",
"errorType" : "$inputRoot.errorType",
"stackTrace" : [
#foreach($stackTrace in $inputRoot.stackTrace)
[
#foreach($elem in $stackTrace)
"$elem"
#if($foreach.hasNext),#end
#end
]
#if($foreach.hasNext),#end
#end
]
}u" Salt boto_apigateway.present Stateu provisioned_byu# See deployment or stage descriptionu contextt SwaggerParameterc B@ sJ e Z d Z d Z d � Z e d � � Z e d � � Z e d � � Z RS(
uI
This is a helper class for the Swagger Parameter Object
u bodyu queryu headeru pathc C@ s
| | _ d S( N( t
_paramdict( t selft paramdict( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt __init__� s c C@ sA | j j d � } | t j j k r( | St d j | � � � d S( uJ
returns location in the swagger parameter object
u inu7 Unsupported parameter location: {0} in Parameter ObjectN( Rk R R
Rj t LOCATIONSR R ( Rl t _location( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt location� s c C@ s� | j j d � } | rp | j d k r4 d j | � S| j d k rP d j | � S| j d k rl d j | � Sd St d j t | j � � � � d S(
uP
returns parameter name in the swagger parameter object
u nameu headeru method.request.header.{0}u queryu method.request.querystring.{0}u pathu method.request.path.{0}u Parameter must have a name: {0}N( Rk R Rq R R R RR ( Rl t _name( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR � s
c C@ s� | j d k r� | j j d � } | rn d | k rS | j d � j d � d } | St d j | j � � � n t d j | j � � � n d S( ul
returns the name of the schema given the reference in the swagger parameter object
u bodyu schemau $refu /i����uf Body parameter must have a JSON reference to the schema definition due to Amazon API restrictions: {0}u& Body parameter must have a schema: {0}N( Rq Rk R t splitR R R R ( Rl t _schemat schema_name( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt schema� s ( u bodyu queryu headeru path( t __name__t
__module__t __doc__Ro Rn t propertyRq R Rv ( ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyRj ~ s
t SwaggerMethodResponsec B@ s5 e Z d Z d � Z e d � � Z e d � � Z RS( uA
Helper class for Swagger Method Response Object
c C@ s
| | _ d S( N( t _r( Rl t r( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyRn � s c C@ sZ | j j d � } | rV d | k r> | j d � j d � d St d j | � � � n d S( ur
returns the name of the schema given the reference in the swagger method response object
u schemau $refu /i����uH Method response must have a JSON reference to the schema definition: {0}N( R| R Rs R R R ( Rl Rt ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyRv � s c C@ s | j j d i � } | S( uV
returns the headers dictionary in the method response object
u headers( R| R ( Rl t _headers( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt headers� s ( Rw Rx Ry Rn Rz Rv R ( ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR{ � s
c C@ s | | _ | | _ | | _ | | _ d | _ d | _ | | _ | | _ | d k rt j
j | � r� t j
j | � r� | | _
t | j
| | � | _ t j j j | j
d � � } t j j j | � | _ Wd QXd | _ n t d j | � � � | j � n | j � | j � d S( Nu u rbu Invalid swagger file path, {0}( t _api_namet _stage_namet _lambda_funcname_formatt _common_aws_argst
_restApiIdt
_deploymentIdt _error_response_templatet _response_templateR t ost patht existst isfilet
_swagger_fileRK t
_md5_filehashR> R? R@ RA t yamlt safe_loadt _cfgt _swagger_versionR R t _validate_swagger_filet _validate_lambda_funcname_formatt _resolve_api_id( Rl R R R% t swagger_file_pathR& R' t common_aws_argst sf( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyRn � s* $
c C@ s t t j d | � � S( uu
Helper function to determine if the passed code is in the 400~599 range of http error
codes
u ^\s*[45]\d\d\s*$( t boolt ret match( Rl t code( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _is_http_error_rescode� s c C@ s� x�| D]�\ } } x�t j | � D]�\ } } | t j k rD q# n d | k r_ t d � � n x�t j | j d � � D]f\ } } | j t | � � s� qx n d | k r� t d j | | | � � � n | j d � } d | k rt d j | | | � � � n | j d d � }
|
j d � d } | | k rKt d j |
� � � n | j | � } | j d
� d k r�t d j | � � � n d
| k r�t d j | � � � n | j d
� }
d |
k rx t d j | � � � qx qx Wq# Wq Wd S( u�
Helper function to help validate the convention established in the swagger file on how
to handle response code mapping/integration
u responsesu5 missing mandatory responses field in path item objectu schemau6 missing schema field in path {0}, op {1}, response {2}u $refuA missing $ref field under schema in path {0}, op {1}, response {2}u /i����u7 model schema {0} reference not found under /definitionsu typeu objectu$ model schema {0} must be type objectu
propertiesu, model schema {0} must have properties fieldsu errorMessageuu model schema {0} must have errorMessage as a property to match AWS convention. If pattern is not set, .+ will be usedN(
R RX R
t SWAGGER_OPERATION_NAMESR R R� RE R Rs ( Rl t pathst modsR� t opst opnamet opobjt rescodet resobjt schemaobjt schemaobjreft modelnamet modelt
modelprops( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _validate_error_response_model� s< % c C@ su yE | j r@ t d d d d d d d d � } | j j | � n t SWn) t k
rp t d j | j � � � n Xd S( u�
Checks if the lambda function name format contains only known elements
:return: True on success, ValueError raised on error
t stageu t apit resourcet methodu] Invalid lambda_funcname_format {0}. Please review documentation for known substitutable keysN( R� R R R t ExceptionR ( Rl t known_kwargs( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� s
c C@ s xK | j D]@ } | t j k r
t j j | � r
t d j | � � � q
q
Wx8 t j D]- } | | j k rX t d j | � � � qX qX W| j j d � | _ | j t j
k r� t d j | j t j
� � � n t j t
| j � � | j | j | j � � d S( u�
High level check/validation of the input swagger file based on
https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md
This is not a full schema compliance check, but rather make sure that the input file (YAML or
JSON) can be read into a dictionary, and we check for the content of the Swagger Object for version
and info.
u! Invalid Swagger Object Field: {0}u! Missing Swagger Object Field: {0}u swaggeru; Unsupported Swagger version: {0},Supported versions are {1}N( R� R
t SWAGGER_OBJ_V2_FIELDSt VENDOR_EXT_PATTERNR� R R t SWAGGER_OBJ_V2_FIELDS_REQUIREDR R� t SWAGGER_VERSIONS_SUPPORTEDt logt infot typet _modelsR� R� ( Rl t field( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� / s c C@ s | j S( u7
returns md5 hash for the swagger file
( R� ( Rl ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt md5_filehashN s c C@ s+ | j j d � } | s' t d � � n | S( uA
returns the swagger info object as a dictionary
u infou Info Object has no values( R� R R ( Rl R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� U s c C@ s
t | j � S( uR
returns the swagger info object as a pretty printed json string.
( RR R� ( Rl ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt info_json_ s c C@ s | j S( u-
returns the name of the api
( R� ( Rl ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt
rest_api_namef s c C@ s+ | j j d � } | s' t d � � n | S( uF
returns the version field in the swagger info object
u versionu$ Missing version value in Info Object( R� R R ( Rl t version( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt rest_api_versionm s c C@ s+ | j j d � } | s' t d � � n | S( uR
returns an iterator for the models specified in the swagger file
u definitionsuN Definitions Object has no values, You need to define them in your swagger file( R� R R ( Rl t models( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� x s c c@ sP | j � } x= t rK | j | � } | s. Pn | | j � j | � f Vq Wd S( uY
generator to return the tuple of model and its schema to create on aws.
N( t _build_all_dependenciesR t _get_model_without_dependenciesR� R ( Rl t
model_dictR� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� � s c C@ sl | j j d � } | s' t d � � n x5 | D]- } | j d � s. t d j | � � � q. q. Wt j | � S( uc
returns an iterator for the relative resource paths specified in the swagger file
u pathsuH Paths Object has no values, You need to define them in your swagger fileu /u2 Path object {0} should start with /. Please fix it( R� R R t
startswithR R RX ( Rl R� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� � s
c C@ s | j j d d � } | S( uL
returns the base path field as defined in the swagger file
u basePathu ( R� R ( Rl t basePath( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� � s c C@ s | j S( uX
returns the rest api id as returned by AWS on creation of the rest api
( R� ( Rl ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR2 � s c C@ s
| | _ d S( uV
allows the assignment of the rest api id on creation of the rest api
N( R� ( Rl R2 ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR2 � s c C@ s
t | j � S( u}
this property returns the unique description in pretty printed json for
a particular api deployment
( RR t deployment_label( Rl ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt deployment_label_json� s c C@ sM t � } | j | d <| j | d <t j j | j � | d <| j | d <| S( ur
this property returns the deployment label dictionary (mainly used by
stage description)
u swagger_info_objectu api_nameu swagger_fileu swagger_file_md5sum( R R� R� R� R� t basenameR� R� ( Rl t label( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� � s
c C@ s5 t d d | j d | | j � j d � } t | � S( uk
Helper function to find whether there are other stages still associated with a deployment
u# boto_apigateway.describe_api_stagesR2 t deploymentIdu stages( R R2 R� R R� ( Rl R� t stages( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _one_or_more_stages_remain� s c C@ s� t } t d d | j | j � j d � } | r� x[ | D]P } | j d � } t d d | j d | | j � j d � } | r8 t } Pq8 q8 Wn | S( uc
Helper function to find whether there are deployments left with stages associated
u( boto_apigateway.describe_api_deploymentsR2 u deploymentsu idu# boto_apigateway.describe_api_stagesR� u stages( R R R2 R� R R ( Rl t no_more_deploymentst deploymentst
deploymentR� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR4 � s
c C@ sP d } t d d | j d | j | j � j d � } | rL | j d � } n | S( uk
Helper method to find the deployment id that the stage name is currently assocaited with.
u u" boto_apigateway.describe_api_stageR2 t stageNameu stageu deploymentId( R R2 R� R� R ( Rl R� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _get_current_deployment_id� s c C@ sN | j � } t d d | j d | | j � j d � } | rJ | j d � Sd S( un
Helper method to find the deployment label that the stage_name is currently associated with.
u' boto_apigateway.describe_api_deploymentR2 R� u
deploymentu descriptionN( R� R R2 R� R R ( Rl R� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _get_current_deployment_label� s
c C@ sh t d d | j | j � j d � } | rd x6 | D]+ } | j d � | j k r2 | j d � Sq2 Wn d S( u�
Helper method to return the deployment id matching the desired deployment label for
this Swagger object based on the given api_name, swagger_file
u( boto_apigateway.describe_api_deploymentsR2 u deploymentsu descriptionu idu ( R R2 R� R R� ( Rl R� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _get_desired_deployment_id� s
c C@ s� t d d | j d | j d | | j � } | j d � sd t | d <t | d <| j d � | d <n t | d
| j d � � } | S( ua
overwrite the given stage_name's stage variables with the given stage_variables
u- boto_apigateway.overwrite_api_stage_variablesR2 R� t variablesu overwriteu resultu abortu erroru commentu overwrite_stage_variablesu stage( R R2 R� R� R R R Rg ( Rl R( R t res( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR s
c C@ s t d d | j d | j | j � j d � } | s� t d d | j d | j d | j d | d | | j � } | j d � s� i t d 6| j d
� d
6SnU t d d | j d | j d | | j � } | j d � s� i t d 6| j d
� d
6St d d | j d | j d | j | j � S(
uk
Helper method to associate the stage_name to the given deploymentId and make this current
u" boto_apigateway.describe_api_stageR2 R� u stageu boto_apigateway.create_api_stageR� t descriptionR� u setu erroru- boto_apigateway.overwrite_api_stage_variablesu' boto_apigateway.activate_api_deployment( R R2 R� R� R R� R ( Rl t stage_desc_jsonR R� t overwrite( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _set_current_deployment s, c C@ s� t d d | j d t j | j � j d � } | r� t | � d k r_ | d j d � | _ q� t d j | j | j
� � � n d S(
u�
returns an Api Id that matches the given api_name and the hardcoded _Swagger.AWS_API_DESCRIPTION
as the api description
u boto_apigateway.describe_apisR R� u restapii i u idu9 Multiple APIs matching given name {0} and description {1}N( R R� R
t AWS_API_DESCRIPTIONR� R t lenR2 R R R� ( Rl t apis( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� : s c C@ s" | j � } | rt d d | j d | j | j � } | j d � sy t | d <t | d <d j | j d � � | d <q | j | � s� t d
d | j d | | j � } | j d � st | d <t | d <d j | j d � � | d <qq d
j | j � | d <n d j | j � | d <| S( u�
Method to delete the given stage_name. If the current deployment tied to the given
stage_name has no other stages associated with it, the deployment will be removed
as well
u boto_apigateway.delete_api_stageR2 R� u deletedu abortu resultu" delete_stage delete_api_stage, {0}u erroru commentu% boto_apigateway.delete_api_deploymentR� u' delete_stage delete_api_deployment, {0}u stage {0} has been deleted.
u stage {0} does not exist(
R� R R2 R� R� R R R R R� ( Rl R( R� R^ ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR3 I s(
"c C@ sw | j rs | j � } | | j k rK d j | j | � | d <t | d <| S| j � | _ | j rs t | d <qs n | S( u�
this method helps determine if the given stage_name is already on a deployment
label matching the input api_name, swagger_file.
If yes, returns abort with comment indicating already at desired state.
If not and there is previous deployment labels in AWS matching the given input api_name and
swagger file, indicate to the caller that we only need to reassociate stage_name to the
previously existing deployment label.
uW Already at desired state, the stage {0} is already at the desired deployment label:
{1}u commentu currentu publish( R2 R� R� R R� R R� R� ( Rl R( t deployed_label_json( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR j s
c C@ s& t � } | j | d <t | � } | j r� | j | | � } | j d � sv t | d <t | d <| j d � | d <q"t | d | j d � � } n� t d d
| j
d | j d | d
| j d | | j
� } | j d � st | d <t | d <| j d � | d <n t | d | j d � � } | S( uf
this method tie the given stage_name to a deployment matching the given swagger_file
u current_deployment_labelu setu abortu resultu erroru commentu9 publish_api (reassociate deployment, set stage_variables)u responseu% boto_apigateway.create_api_deploymentR2 R� t stageDescriptionR� R� u createdu publish_api (new deployment)u
deployment( R R� RR R� R� R R R Rg R R2 R� R� R� ( Rl R( R t
stage_descR� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR � s0
c C@ s+ t d d | j | j � } | j d � r� | j d � d } | j � xO | D]D } t d d | j d | j d � | j � } | j d � sO | SqO Wn t d d | j | j � } | j d
� r xX | j d
� D]D } t d d | j d | j d
� | j � } | j d � s� | Sq� Wn i t d 6S( u�
Helper method to clean up resources and models if we detected a change in the swagger file
for a stage
u& boto_apigateway.describe_api_resourcesR2 u resourcesi u$ boto_apigateway.delete_api_resourcesR� u pathu deletedu# boto_apigateway.describe_api_modelsu modelsu boto_apigateway.delete_api_modelt modelNameu name( R R2 R� R t reverseR ( Rl t resourcesR� R� t delresR� R� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _cleanup_api� s(
c C@ s | j rV | j � } | j d � sR d j | j � | d <t | d <t | d <| S| St d d | j d t j | j
� } | j d � s� t | d <t | d <d
| k r� d j | d
d � | d <n | S| j d
i � j d � | _ t | d | j d
� � S( uM
this method create the top level rest api in AWS apigateway
u deletedu Failed to cleanup restAreId {0}u commentu abortu resultu boto_apigateway.create_apiR R� u createdu erroru Failed to create rest api: {0}.u messageu restapiu idu
deploy_api( R2 R� R R R R R R� R
R� R� Rg ( Rl R( R� t response( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR � s&
c C@ s t d d | j d t j | j � } | j d � r� t d rl d j | j � | d <d | d <t | d <| St d
d | j d t j | j � } | j d � s� t
| d <t | d <d | k r� d
j | d d � | d <n | St | d | � } n d j | j | j � | d <| S( u�
Method to delete a Rest Api named defined in the swagger file's Info Object's title value.
ret
a dictionary for returning status to Saltstack
u boto_apigateway.api_existsR R� u existsu testu( Rest API named {0} is set to be deleted.u commentu resultu abortu boto_apigateway.delete_apiu deletedu erroru Failed to delete rest api: {0}.u messageu
delete_apiu3 api already absent for swagger file: {0}, desc: {1}N(
R R� R
R� R� R R R R R R Rg R� ( Rl R( t exists_responset delete_api_response( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR5 � s,
c C@ s& | j d � d } d j | j | � S( uJ
Helper function to reference models created on aws apigw
u /i����u8 https://apigateway.amazonaws.com/restapis/{0}/models/{1}( Rs R R2 ( Rl R} t
model_name( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _aws_model_ref_from_swagger_ref s c C@ sp i } xc | j � D]U \ } } | d k r= | j | � } n t | t � r^ | j | � } n | | | <q W| S( uE
Helper function to map model schema to aws notation
u $ref( t itemsR� R. R t _update_schema_to_aws_notation( Rl Rv R^ R_ R` ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� s c C@ s g } | r% | j d d � | d <n | d d k rZ | j | j | j d i � � � n� | j d � } | r� | j d � d } | j � j | � } | j | j | � � | j | g � nN | j d � } | rx6 t j | � D]" \ } } | j | j | � � q� Wn t t | � � S( ue
Helper function to build the list of models the given object schema is referencing.
u typeu objectu arrayu itemsu $refu /i����u
properties( R t extendt _build_dependent_model_listRs R� R RX RZ t set( Rl t
obj_schemat dep_models_listt reft
ref_obj_modelt ref_obj_schemat
propertiest _t prop_obj_schema( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� s % c C@ sI i } x< t j | j � � D]% \ } } | j | � } | | | <q W| S( ug
Helper function to build a map of model to their list of model reference dependencies
( R RX R� R� ( Rl R( R� Rv t dep_list( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� - s
"c C@ s� d } | s | Sx3 t j | � D]" \ } } | g k r | } Pq q W| d k rj t d j | � � � n | j | � x9 t j | � D]( \ } } | | k r� | j | � q� q� W| S( uO
Helper function to find the next model that should be created
uH incomplete model definitions, models in dependency list not defined: {0}N( R R RX R R t popt remove( Rl t models_dictt
next_modelR� t dependenciesR� ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR� 7 s
c
C@ s� x�| j � D]�\ } } | j | � } | j i t j d 6d j | � d 6� t d d | j d | | j � } | j d � r t d d | j d | d t
| � | j � } | j d
� s t | d <t | d <d
| k rd j | t
| � | d
d � | d <n | St
| d | � } q
t d d | j d | d | d t
| � d d | j � } | j d � s�t | d <t | d <d
| k r�d j | t
| � | d
d � | d <n | St
| d | � } q
W| S( u�
Method to deploy swagger file's definition objects and associated schema to AWS Apigateway as Models
ret
a dictionary for returning status to Saltstack
u $schemau
{0} Schemau titleu boto_apigateway.api_model_existsR2 R� u existsu' boto_apigateway.update_api_model_schemaRv u updatedu resultu abortu erroru? Failed to update existing model {0} with schema {1}, error: {2}u messageu commentu
deploy_modelsu boto_apigateway.create_api_modelt modelDescriptiont contentTypeu application/jsonu createdu2 Failed to create model {0}, schema {1}, error: {2}( R� R� RC R
t JSON_SCHEMA_DRAFT_4R R R2 R� R RR R R Rg ( Rl R( R� Rv Rt t model_exists_responset update_model_schema_responset create_model_response( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR P sH
c C@ s| | j j d | j d | j d | d | � } | j � } t j d d | � } t j d d | � j � } t j d d | � S(
u�
Helper method to construct lambda name based on the rule specified in doc string of
boto_apigateway.api_present function
R� R� R� R� u {|}u u \s+|/u _u _+( R� R R� R� t stripR� t subRT ( Rl t resourcePatht
httpMethodt lambda_name( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _lambda_name� s c C@ s� | j j d � } | j j d � } t d d | | � } t d d | | � } t d | | j � } | | k r� | j d � s� t d | | j � } q� n | j d � s� t d j | | | � � � n | j d � j d � } d
j | | � } | S( uY
Helper Method to construct the lambda uri for use in method integration
u profileu regionu boto3.get_regionu lambdau
apigatewayu boto_lambda.describe_functionu functionu9 Could not find lambda function {0} in regions [{1}, {2}].u FunctionArnuG arn:aws:apigateway:{0}:lambda:path/2015-03-31/functions/{1}/invocations( R� R t __utils__R R R ( Rl R R R$ R! t apigw_regiont lambda_desct
lambda_arnt
lambda_uri( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _lambda_uri� s c C@ s� i } i } d | k rq xV | d D]G } t j | � } | j rQ t | | j <n | j r# | j | d <q# q# Wn | d k r� t j n t j } | d k r� d n d } i | d 6| d 6| d 6| d 6S(
u�
Helper function to construct the method request params, models, request_templates and
integration_type values needed to configure method request integration/mappings.
u
parametersu application/jsonu optionsu MOCKu AWSu paramsu modelsu request_templatesu integration_type( R
Rj R R Rv t REQUEST_OPTION_TEMPLATEt REQUEST_TEMPLATE( Rl t method_namet method_datat
method_paramst
method_modelst paramt pt request_templatest integration_type( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _parse_method_data� s
c C@ s� g } t | t � r| xd t j | � D]P \ } } t | t � rY | j | j | � � q% | d k r% | j | � q% q% Wn | S( Nu pattern( R. R R RX R� t _find_patternsR[ ( Rl R\ R^ R_ R` ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR � s c C@ sQ | j | � r d n d } | j � j | � } | j | � } | rM | d S| S( uD
returns the pattern specified in a response schema
u .+u .*i ( R� R� R R ( Rl Ru t
httpStatust defaultPatternR� t patterns( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _get_pattern_for_schema� s c C@ sg | d k s | j | � rA | j r5 i | j d 6n | j } n" | j rZ i | j d 6n | j } | S( Nu optionsu application/json( R� R� t RESPONSE_OPTION_TEMPLATER� t RESPONSE_TEMPLATE( Rl R t http_statust response_templates( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _get_response_template� s %"c C@ s� i } d } | j r: | j | d <| j | j | � } n i } i } xj | j D]_ } d j | � } t | | <| j j | � }
d |
k r� d j |
j d � � n d | | <qP W| j | | � } i | d 6| d 6| d 6| d
6| d 6S( u�
Helper function to construct the method response params, models, and integration_params
values needed to configure method response integration/mappings.
u .*u application/jsonu method.response.header.{0}u defaultu '{0}'u '*'u paramsu modelsu integration_paramsu patternu response_templates( Rv R R R R R R" ( Rl R t method_responseR t method_response_modelst method_response_patternt method_response_paramst" method_integration_response_paramst headert response_headert header_dataR! ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _parse_method_response� s$
2
c C@ s- | j | j � | � } | j � d k r9 t } d } n t d d | j d | d | j � d | d | d | j d
� d | j d � | j � }
|
j d
� s� t | |
� } | St | d |
� } d } | j � d k r| j
| j | | � d | �} n t d d | j d | d | j � d | j d � d d d | d | d | j d � | j � } | j d
� s�t | | � } | St | d | � } d | k rx�t j
| d � D]W\ }
} t |
� } | j | j � t j | � | � } t d d | j d | d | j � d | d | j d
� d | j d � | j � } | j d
� sct | | � } | St | d | � } t d! d | j d | d | j � d | d" | j d# � d | j d$ � d% | j d& � | j � } | j d
� s�t | | � } | St | d' | � } q�Wn t d( j | | � � � | S() u�
Method to create a method for the given resource path, along with its associated
request and response integrations.
ret
a dictionary for returning status to Saltstack
resource_path
the full resource path where the named method_name will be associated with.
method_name
a string that is one of the following values: 'delete', 'get', 'head', 'options',
'patch', 'post', 'put'
method_data
the value dictionary for this method in the swagger definition file.
api_key_required
True or False, whether api key is required to access this method.
lambda_integration_role
name of the IAM role or IAM role arn that Api Gateway will assume when executing
the associated lambda function
lambda_region
the region for the lambda function that Api Gateway will integrate to.
authorization_type
'NONE' or 'AWS_IAM'
u optionsu NONEu! boto_apigateway.create_api_methodR2 R R t authorizationTypet apiKeyRequiredt requestParametersu paramst
requestModelsu modelsu createdu _deploy_method.create_api_methodu R u& boto_apigateway.create_api_integrationt integrationTypeu integration_typet integrationHttpMethodu POSTt urit credentialst requestTemplatesu request_templatesu% _deploy_method.create_api_integrationu responsesu* boto_apigateway.create_api_method_responset
statusCodet responseParameterst responseModelsu) _deploy_method.create_api_method_responseu/ boto_apigateway.create_api_integration_responset selectionPatternu patternu integration_paramst responseTemplatesu response_templatesu. _deploy_method.create_api_integration_responseu" No responses specified for {0} {1}( R RT R R R2 t upperR R� Ri Rg R
R R RX RE R+ R
R{ R R ( Rl R( t
resource_pathR R R R R R
R� RV R t integrationR� t
response_dataR R# t mrt mir( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt _deploy_method s� !
c C@ s� x� | j D]� \ } } t d d | j d | | j � } | j d � sZ t | | � } | St | d | � } xS t j | � D]B \ } }
| t j
k r| | j | | | |
| | | | � } q| q| Wq
W| S( uH
Method to deploy resources defined in the swagger file.
ret
a dictionary for returning status to Saltstack
api_key_required
True or False, whether api key is required to access this method.
lambda_integration_role
name of the IAM role or IAM role arn that Api Gateway will assume when executing
the associated lambda function
lambda_region
the region for the lambda function that Api Gateway will integrate to.
authorization_type
'NONE' or 'AWS_IAM'
u$ boto_apigateway.create_api_resourcesR2 R� u createdu deploy_resources( R� R R2 R� R Ri Rg R RX R
R� R@ ( Rl R( R R R R
R� t pathDataR� R� R ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR t s ( u swaggeru infou hostu basePathu schemesu consumesu producesu pathsu definitionsu
parametersu responsesu securityDefinitionsu securityu tagsu externalDocs( u swaggeru infou basePathu schemesu pathsu definitions( u getu putu postu deleteu optionsu headu patch( u 2.0(D Rw Rx Ry R� R� R� R� R� t compileR� R� R R R R RR R� t objectRj R{ Rn R� R� R� R� Rz R� R� R� R� R� R� R� R� R� R2 t setterR� R� R� R4 R� R� R� R R� R� R3 R R R� R R5 R� R� R� R� R� R R R
R R R R" R+ R@ R ( ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyR
s�
1
3 ,
! # #
: rc
C@ su t � } i | d 6t d 6d d 6i d 6}
y
t d | f d | f d | f d | f g � } t d
d | | � } d | k r� t |
d <d
|
d <|
S| d sTt d r� d j | � |
d <d* |
d <|
St d d | d | d | d | | � }
d |
k r)t |
d <d j | |
d � |
d <|
Si d* d 6|
d d <d j | � |
d <n�| d d } t } d d+ f d d, f f } x� | D]� \ } } xr | D]j } | j | � d* k r�i n | j | � } | j | i � j | d* � | j | d* � k r�t } Pq�q�Wq�W| s3d! j | � |
d <t |
d <|
St d r^d" j | � |
d <d* |
d <|
St d# | d$ d | d | | �}
d |
k r�t |
d <d% j | |
d � |
d <|
Si | d 6|
d d <d& j | � |
d <t d
d | | � } d | k rt |
d <d' |
d <|
Si | d d d 6|
d d( <Wn9 t t
f k
rp} t |
d <d) j | j � |
d <n X|
S(- u
Ensure the spcifieda usage plan with the corresponding metrics is deployed
.. versionadded:: 2017.7.0
name
name of the state
plan_name
[Required] name of the usage plan
throttle
[Optional] throttling parameters expressed as a dictionary.
If provided, at least one of the throttling parameters must be present
rateLimit
rate per second at which capacity bucket is populated
burstLimit
maximum rate allowed
quota
[Optional] quota on the number of api calls permitted by the plan.
If provided, limit and period must be present
limit
[Required] number of calls permitted per quota period
offset
[Optional] number of calls to be subtracted from the limit at the beginning of the period
period
[Required] period to which quota applies. Must be DAY, WEEK or MONTH
.. code-block:: yaml
UsagePlanPresent:
boto_apigateway.usage_plan_present:
- plan_name: my_usage_plan
- throttle:
rateLimit: 70
burstLimit: 100
- quota:
limit: 1000
offset: 0
period: DAY
- profile: my_profile
u nameu resultu u commentu changesu regionu keyu keyidu profileu$ boto_apigateway.describe_usage_plansR u erroru' Failed to describe existing usage plansu plansu testu% a new usage plan {0} would be createdu! boto_apigateway.create_usage_planR� t throttlet quotau& Failed to create a usage plan {0}, {1}u planu oldu% A new usage plan {0} has been createdi u throttleu rateLimitu
burstLimitu quotau limitu offsetu periodu, usage plan {0} is already in a correct stateu% a new usage plan {0} would be updatedu! boto_apigateway.update_usage_planu idu& Failed to update a usage plan {0}, {1}u usage plan {0} has been updatedu5 Failed to describe existing usage plans after updatesu newu {0}N( u rateLimitu
burstLimit( u limitu offsetu period( t localsR R R R R R R R R R R ( R t plan_nameR� RE RF R! R" R# R$ t func_paramsR( R) t existingR^ t plant needs_updatingt modifiable_paramsR t fieldsR9 t actual_paramt newstateR, ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt usage_plan_present� s� 3
*0
!
c C@ s� i | d 6t d 6d d 6i d 6} yTt d | f d | f d | f d | f g � } t d
d | | � } d | k r� t | d <d
| d <| S| d s� d j | � | d <| St d r� d j | � | d <d | d <| S| d d d } t d | | � }
d |
k r0t | d <d j | |
� | d <| Sd j | � | d <i | d d d 6| d d <i d d 6| d d <Wn9 t t f k
r�} t | d <d j | j � | d <n X| S( ug
Ensures usage plan identified by name is no longer present
.. versionadded:: 2017.7.0
name
name of the state
plan_name
name of the plan to remove
.. code-block:: yaml
usage plan absent:
boto_apigateway.usage_plan_absent:
- plan_name: my_usage_plan
- profile: my_profile
u nameu resultu u commentu changesu regionu keyu keyidu profileu$ boto_apigateway.describe_usage_plansR u erroru' Failed to describe existing usage plansu plansu% Usage plan {0} does not exist alreadyu testu* Usage plan {0} exists and would be deletedi u idu! boto_apigateway.delete_usage_planu$ Failed to delete usage plan {0}, {1}u Usage plan {0} has been deletedu planu oldu newu {0}N(
R R R R R R R R R R ( R RH R! R" R# R$ R( R) RJ t plan_idR^ R, ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt usage_plan_absent% sD
c C@ s% i | d 6t d 6d d 6i d 6} y�t d | f d | f d | f d | f g � } t d
d | | � } d | k r� t | d <d
| d <| S| d s� d j | � | d <t | d <| St | d � d k r� d | d <t | d <| S| d d }
|
d } |
j d g � } g }
x* | D]" } | | k r |
j | � q q W|
sYd | d <| St d | |
| � } d | k r�d j | |
| d � | d <t | d <| Sd | d <| | d d <| j d i � j d g � | d d <Wn9 t t f k
r } t | d <d j | j
� | d <n X| S( u
Ensures usage plan identified by name is added to provided api_stages
.. versionadded:: 2017.7.0
name
name of the state
plan_name
name of the plan to use
api_stages
list of dictionaries, where each dictionary consists of the following keys:
apiId
apiId of the api to attach usage plan to
stage
stage name of the api to attach usage plan to
.. code-block:: yaml
UsagePlanAssociationPresent:
boto_apigateway.usage_plan_association_present:
- plan_name: my_plan
- api_stages:
- apiId: 9kb0404ec0
stage: my_stage
- apiId: l9v7o2aj90
stage: my_stage
- profile: my_profile
u nameu resultu u commentu changesu regionu keyu keyidu profileu$ boto_apigateway.describe_usage_plansR u erroru' Failed to describe existing usage plansu plansu Usage plan {0} does not existi uG There are multiple usage plans with the same name - it is not supportedi u idu apiStagesu3 Usage plan is already asssociated to all api stagesu) boto_apigateway.attach_usage_plan_to_apisu9 Failed to associate a usage plan {0} to the apis {1}, {2}u* successfully associated usage plan to apisu oldu newu {0}( R R R R R R� R R[ R R R ( R RH t
api_stagesR! R" R# R$ R( R) RJ RK RR t plan_stagest
stages_to_addR� R^ R, ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt usage_plan_association_presentg s\ "
*
c C@ sB i | d 6t d 6d d 6i d 6} y�t d | f d | f d | f d | f g � } t d
d | | � } d | k r� t | d <d
| d <| S| d s� d j | � | d <t | d <| St | d � d k r� d | d <t | d <| S| d d }
|
d } |
j d g � } | s/d j | � | d <| Sg }
x* | D]" } | | k r<|
j | � q<q<W|
svd | d <| St d | |
| � } d | k r�d j | |
| d � | d <t | d <| Sd | d <| | d d <| j d i � j d g � | d d <Wn9 t t f k
r=} t | d <d j | j
� | d <n X| S( u�
Ensures usage plan identified by name is removed from provided api_stages
If a plan is associated to stages not listed in api_stages parameter,
those associations remain intact.
.. versionadded:: 2017.7.0
name
name of the state
plan_name
name of the plan to use
api_stages
list of dictionaries, where each dictionary consists of the following keys:
apiId
apiId of the api to detach usage plan from
stage
stage name of the api to detach usage plan from
.. code-block:: yaml
UsagePlanAssociationAbsent:
boto_apigateway.usage_plan_association_absent:
- plan_name: my_plan
- api_stages:
- apiId: 9kb0404ec0
stage: my_stage
- apiId: l9v7o2aj90
stage: my_stage
- profile: my_profile
u nameu resultu u commentu changesu regionu keyu keyidu profileu$ boto_apigateway.describe_usage_plansR u erroru' Failed to describe existing usage plansu plansu Usage plan {0} does not existi uG There are multiple usage plans with the same name - it is not supportedi u idu apiStagesu/ Usage plan {0} has no associated stages alreadyu7 Usage plan is already not asssociated to any api stagesu+ boto_apigateway.detach_usage_plan_from_apisu> Failed to disassociate a usage plan {0} from the apis {1}, {2}u/ successfully disassociated usage plan from apisu oldu newu {0}( R R R R R R� R R[ R R R ( R RH RT R! R" R# R$ R( R) RJ RK RR RU t stages_to_removeR� R^ R, ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt usage_plan_association_absent� sb $
*
(% Ry t
__future__R R R R< t loggingR� R� t salt.utils.filesR> t salt.utils.jsont salt.utils.yamlt salt.extR t getLoggerRw R� R R R- R R R7 RK R RR RW RY Rg Ri RC R
RQ RS RW RY ( ( ( s? /usr/lib/python2.7/site-packages/salt/states/boto_apigateway.pyt <module>4 sH � O
� � � � � �B]
Mini Shell