| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/boto_apigateway.py |
"""
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
"""
# keep lint from choking on _get_conn and _cache_id
# pylint: disable=E0602
import datetime
import logging
import salt.utils.compat
import salt.utils.json
import salt.utils.versions
log = logging.getLogger(__name__)
# pylint: disable=import-error
try:
# pylint: disable=unused-import
import boto
import boto3
from botocore import __version__ as found_botocore_version
# pylint: enable=unused-import
from botocore.exceptions import ClientError
logging.getLogger("boto").setLevel(logging.CRITICAL)
logging.getLogger("boto3").setLevel(logging.CRITICAL)
HAS_BOTO = True
except ImportError:
HAS_BOTO = False
# pylint: enable=import-error
def __virtual__():
"""
Only load if boto libraries exist and if boto libraries are greater than
a given version.
"""
# the boto_apigateway execution module relies on the connect_to_region() method
# which was added in boto 2.8.0
# https://github.com/boto/boto/commit/33ac26b416fbb48a60602542b4ce15dcc7029f12
return salt.utils.versions.check_boto_reqs(
boto_ver="2.8.0", boto3_ver="1.2.1", botocore_ver="1.4.49"
)
def __init__(opts):
if HAS_BOTO:
__utils__["boto3.assign_funcs"](__name__, "apigateway")
def _convert_datetime_str(response):
"""
modify any key-value pair where value is a datetime object to a string.
"""
if response:
return dict(
[
(k, f"{v}") if isinstance(v, datetime.date) else (k, v)
for k, v in response.items()
]
)
return None
def _filter_apis(name, apis):
"""
Return list of api items matching the given name.
"""
return [api for api in apis if api["name"] == name]
def _filter_apis_desc(desc, apis):
"""
Return list of api items matching the given description.
"""
return [api for api in apis if api["description"] == desc]
def _multi_call(function, contentkey, *args, **kwargs):
"""
Retrieve full list of values for the contentkey from a boto3 ApiGateway
client function that may be paged via 'position'
"""
ret = function(*args, **kwargs)
position = ret.get("position")
while position:
more = function(*args, position=position, **kwargs)
ret[contentkey].extend(more[contentkey])
position = more.get("position")
return ret.get(contentkey)
def _find_apis_by_name(
name, description=None, region=None, key=None, keyid=None, profile=None
):
"""
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.
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
apis = _multi_call(conn.get_rest_apis, "items")
if name:
apis = _filter_apis(name, apis)
if description is not None:
apis = _filter_apis_desc(description, apis)
return {"restapi": [_convert_datetime_str(api) for api in apis]}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_apis(
name=None, description=None, region=None, key=None, keyid=None, profile=None
):
"""
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'
"""
if name:
return _find_apis_by_name(
name,
description=description,
region=region,
key=key,
keyid=keyid,
profile=profile,
)
else:
return _find_apis_by_name(
"",
description=description,
region=region,
key=key,
keyid=keyid,
profile=profile,
)
def api_exists(name, description=None, region=None, key=None, keyid=None, profile=None):
"""
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
"""
apis = _find_apis_by_name(
name,
description=description,
region=region,
key=key,
keyid=keyid,
profile=profile,
)
return {"exists": bool(apis.get("restapi"))}
def create_api(
name, description, cloneFrom=None, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
if cloneFrom:
api = conn.create_rest_api(
name=name, description=description, cloneFrom=cloneFrom
)
else:
api = conn.create_rest_api(name=name, description=description)
api = _convert_datetime_str(api)
return {"created": True, "restapi": api} if api else {"created": False}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api(name, description=None, region=None, key=None, keyid=None, profile=None):
"""
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'
"""
try:
conn_params = dict(region=region, key=key, keyid=keyid, profile=profile)
r = _find_apis_by_name(name, description=description, **conn_params)
apis = r.get("restapi")
if apis:
conn = _get_conn(**conn_params)
for api in apis:
conn.delete_rest_api(restApiId=api["id"])
return {"deleted": True, "count": len(apis)}
else:
return {"deleted": False}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_resources(restApiId, region=None, key=None, keyid=None, profile=None):
"""
Given rest api id, return all resources for this api.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_resources myapi_id
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
resources = sorted(
_multi_call(conn.get_resources, "items", restApiId=restApiId),
key=lambda k: k["path"],
)
return {"resources": resources}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_resource(
restApiId, path, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
r = describe_api_resources(
restApiId, region=region, key=key, keyid=keyid, profile=profile
)
resources = r.get("resources")
if resources is None:
return r
for resource in resources:
if resource["path"] == path:
return {"resource": resource}
return {"resource": None}
def create_api_resources(
restApiId, path, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
path_parts = path.split("/")
created = []
current_path = ""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
for path_part in path_parts:
if current_path == "/":
current_path = f"{current_path}{path_part}"
else:
current_path = f"{current_path}/{path_part}"
r = describe_api_resource(
restApiId,
current_path,
region=region,
key=key,
keyid=keyid,
profile=profile,
)
resource = r.get("resource")
if not resource:
resource = conn.create_resource(
restApiId=restApiId, parentId=created[-1]["id"], pathPart=path_part
)
created.append(resource)
if created:
return {"created": True, "restApiId": restApiId, "resources": created}
else:
return {"created": False, "error": "unexpected error."}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_resources(
restApiId, path, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
if path == "/":
return {"deleted": False, "error": "use delete_api to remove the root resource"}
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
r = describe_api_resource(
restApiId, path, region=region, key=key, keyid=keyid, profile=profile
)
resource = r.get("resource")
if resource:
conn.delete_resource(restApiId=restApiId, resourceId=resource["id"])
return {"deleted": True}
else:
return {"deleted": False, "error": f"no resource found by {path}"}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_resource_method(
restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
r = describe_api_resource(
restApiId, resourcePath, region=region, key=key, keyid=keyid, profile=profile
)
resource = r.get("resource")
if not resource:
return {"error": "no such resource"}
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
method = conn.get_method(
restApiId=restApiId, resourceId=resource["id"], httpMethod=httpMethod
)
return {"method": method}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
"""
Gets info about the given api key
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_key apigw_api_key
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.get_api_key(apiKey=apiKey)
return {"apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_keys(region=None, key=None, keyid=None, profile=None):
"""
Gets information about the defined API Keys. Return list of apiKeys.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_keys
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
apikeys = _multi_call(conn.get_api_keys, "items")
return {"apiKeys": [_convert_datetime_str(apikey) for apikey in apikeys]}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def create_api_key(
name,
description,
enabled=True,
stageKeys=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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"}]'
"""
try:
stageKeys = list() if stageKeys is None else stageKeys
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.create_api_key(
name=name, description=description, enabled=enabled, stageKeys=stageKeys
)
if not response:
return {"created": False}
return {"created": True, "apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
"""
Deletes a given apiKey
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_key apikeystring
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_api_key(apiKey=apiKey)
return {"deleted": True}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def _api_key_patch_replace(conn, apiKey, path, value):
"""
the replace patch operation on an ApiKey resource
"""
response = conn.update_api_key(
apiKey=apiKey, patchOperations=[{"op": "replace", "path": path, "value": value}]
)
return response
def _api_key_patchops(op, pvlist):
"""
helper function to return patchOperations object
"""
return [{"op": op, "path": p, "value": v} for (p, v) in pvlist]
def _api_key_patch_add(conn, apiKey, pvlist):
"""
the add patch operation for a list of (path, value) tuples on an ApiKey resource list path
"""
response = conn.update_api_key(
apiKey=apiKey, patchOperations=_api_key_patchops("add", pvlist)
)
return response
def _api_key_patch_remove(conn, apiKey, pvlist):
"""
the remove patch operation for a list of (path, value) tuples on an ApiKey resource list path
"""
response = conn.update_api_key(
apiKey=apiKey, patchOperations=_api_key_patchops("remove", pvlist)
)
return response
def update_api_key_description(
apiKey, description, region=None, key=None, keyid=None, profile=None
):
"""
update the given apiKey with the given description.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.update_api_key_description api_key description
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = _api_key_patch_replace(conn, apiKey, "/description", description)
return {"updated": True, "apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"updated": False, "error": __utils__["boto3.get_error"](e)}
def enable_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
"""
enable the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = _api_key_patch_replace(conn, apiKey, "/enabled", "True")
return {"apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def disable_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
"""
disable the given apiKey.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = _api_key_patch_replace(conn, apiKey, "/enabled", "False")
return {"apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def associate_api_key_stagekeys(
apiKey, stagekeyslist, region=None, key=None, keyid=None, profile=None
):
"""
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", ...]'
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
pvlist = [("/stages", stagekey) for stagekey in stagekeyslist]
response = _api_key_patch_add(conn, apiKey, pvlist)
return {"associated": True, "apiKey": _convert_datetime_str(response)}
except ClientError as e:
return {"associated": False, "error": __utils__["boto3.get_error"](e)}
def disassociate_api_key_stagekeys(
apiKey, stagekeyslist, region=None, key=None, keyid=None, profile=None
):
"""
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", ...]'
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
pvlist = [("/stages", stagekey) for stagekey in stagekeyslist]
response = _api_key_patch_remove(conn, apiKey, pvlist)
return {"disassociated": True}
except ClientError as e:
return {"disassociated": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_deployments(
restApiId, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
deployments = []
_deployments = conn.get_deployments(restApiId=restApiId)
while True:
if _deployments:
deployments = deployments + _deployments["items"]
if "position" not in _deployments:
break
_deployments = conn.get_deployments(
restApiId=restApiId, position=_deployments["position"]
)
return {
"deployments": [
_convert_datetime_str(deployment) for deployment in deployments
]
}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_deployment(
restApiId, deploymentId, region=None, key=None, keyid=None, profile=None
):
"""
Get API deployment for a given restApiId and deploymentId.
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_deployent restApiId deploymentId
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
deployment = conn.get_deployment(restApiId=restApiId, deploymentId=deploymentId)
return {"deployment": _convert_datetime_str(deployment)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def activate_api_deployment(
restApiId, stageName, deploymentId, region=None, key=None, keyid=None, profile=None
):
"""
Activates previously deployed deployment for a given stage
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.activate_api_deployent restApiId stagename deploymentId
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.update_stage(
restApiId=restApiId,
stageName=stageName,
patchOperations=[
{"op": "replace", "path": "/deploymentId", "value": deploymentId}
],
)
return {"set": True, "response": _convert_datetime_str(response)}
except ClientError as e:
return {"set": False, "error": __utils__["boto3.get_error"](e)}
def create_api_deployment(
restApiId,
stageName,
stageDescription="",
description="",
cacheClusterEnabled=False,
cacheClusterSize="0.5",
variables=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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"}'
"""
try:
variables = dict() if variables is None else variables
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
deployment = conn.create_deployment(
restApiId=restApiId,
stageName=stageName,
stageDescription=stageDescription,
description=description,
cacheClusterEnabled=cacheClusterEnabled,
cacheClusterSize=cacheClusterSize,
variables=variables,
)
return {"created": True, "deployment": _convert_datetime_str(deployment)}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_deployment(
restApiId, deploymentId, region=None, key=None, keyid=None, profile=None
):
"""
Deletes API deployment for a given restApiId and deploymentID
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_deployent restApiId deploymentId
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_deployment(restApiId=restApiId, deploymentId=deploymentId)
return {"deleted": True}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def overwrite_api_stage_variables(
restApiId, stageName, variables, region=None, key=None, keyid=None, profile=None
):
"""
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"}'
"""
try:
res = describe_api_stage(
restApiId, stageName, region=region, key=key, keyid=keyid, profile=profile
)
if res.get("error"):
return {"overwrite": False, "error": res.get("error")}
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
# remove all existing variables that are not in the given variables,
# followed by adding of the variables
stage = res.get("stage")
old_vars = stage.get("variables", {})
patch_ops = []
for old_var in old_vars:
if old_var not in variables:
patch_ops.append(
dict(op="remove", path=f"/variables/{old_var}", value="")
)
for var, val in variables.items():
if var not in old_vars or old_vars[var] != val:
patch_ops.append(
dict(op="replace", path=f"/variables/{var}", value=val)
)
if patch_ops:
stage = conn.update_stage(
restApiId=restApiId, stageName=stageName, patchOperations=patch_ops
)
return {"overwrite": True, "stage": _convert_datetime_str(stage)}
except ClientError as e:
return {"overwrite": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_stage(
restApiId, stageName, region=None, key=None, keyid=None, profile=None
):
"""
Get API stage for a given apiID and stage name
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_stage restApiId stageName
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
stage = conn.get_stage(restApiId=restApiId, stageName=stageName)
return {"stage": _convert_datetime_str(stage)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_stages(
restApiId, deploymentId, region=None, key=None, keyid=None, profile=None
):
"""
Get all API stages for a given apiID and deploymentID
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_stages restApiId deploymentId
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
stages = conn.get_stages(restApiId=restApiId, deploymentId=deploymentId)
return {"stages": [_convert_datetime_str(stage) for stage in stages["item"]]}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def create_api_stage(
restApiId,
stageName,
deploymentId,
description="",
cacheClusterEnabled=False,
cacheClusterSize="0.5",
variables=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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"}'
"""
try:
variables = dict() if variables is None else variables
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
stage = conn.create_stage(
restApiId=restApiId,
stageName=stageName,
deploymentId=deploymentId,
description=description,
cacheClusterEnabled=cacheClusterEnabled,
cacheClusterSize=cacheClusterSize,
variables=variables,
)
return {"created": True, "stage": _convert_datetime_str(stage)}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_stage(
restApiId, stageName, region=None, key=None, keyid=None, profile=None
):
"""
Deletes stage identified by stageName from API identified by restApiId
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_stage restApiId stageName
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_stage(restApiId=restApiId, stageName=stageName)
return {"deleted": True}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def flush_api_stage_cache(
restApiId, stageName, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.flush_stage_cache(restApiId=restApiId, stageName=stageName)
return {"flushed": True}
except ClientError as e:
return {"flushed": False, "error": __utils__["boto3.get_error"](e)}
def create_api_method(
restApiId,
resourcePath,
httpMethod,
authorizationType,
apiKeyRequired=False,
requestParameters=None,
requestModels=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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"}'
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
requestParameters = (
dict() if requestParameters is None else requestParameters
)
requestModels = dict() if requestModels is None else requestModels
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
method = conn.put_method(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
authorizationType=str(authorizationType),
apiKeyRequired=apiKeyRequired,
requestParameters=requestParameters,
requestModels=requestModels,
)
return {"created": True, "method": method}
return {"created": False, "error": "Failed to create method"}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_method(
restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
method = conn.get_method(
restApiId=restApiId, resourceId=resource["id"], httpMethod=httpMethod
)
return {"method": _convert_datetime_str(method)}
return {"error": "get API method failed: no such resource"}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def delete_api_method(
restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_method(
restApiId=restApiId, resourceId=resource["id"], httpMethod=httpMethod
)
return {"deleted": True}
return {"deleted": False, "error": "get API method failed: no such resource"}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def create_api_method_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
responseParameters=None,
responseModels=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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"}'
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
responseParameters = (
dict() if responseParameters is None else responseParameters
)
responseModels = dict() if responseModels is None else responseModels
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.put_method_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=str(statusCode),
responseParameters=responseParameters,
responseModels=responseModels,
)
return {"created": True, "response": response}
return {"created": False, "error": "no such resource"}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_method_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_method_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=str(statusCode),
)
return {"deleted": True}
return {"deleted": False, "error": "no such resource"}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_method_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.get_method_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=str(statusCode),
)
return {"response": _convert_datetime_str(response)}
return {"error": "no such resource"}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_models(restApiId, region=None, key=None, keyid=None, profile=None):
"""
Get all models for a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_models restApiId
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
models = _multi_call(conn.get_models, "items", restApiId=restApiId)
return {"models": [_convert_datetime_str(model) for model in models]}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_model(
restApiId, modelName, flatten=True, region=None, key=None, keyid=None, profile=None
):
"""
Get a model by name for a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.describe_api_model restApiId modelName [True]
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
model = conn.get_model(
restApiId=restApiId, modelName=modelName, flatten=flatten
)
return {"model": _convert_datetime_str(model)}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def api_model_exists(
restApiId, modelName, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
r = describe_api_model(
restApiId, modelName, region=region, key=key, keyid=keyid, profile=profile
)
return {"exists": bool(r.get("model"))}
def _api_model_patch_replace(conn, restApiId, modelName, path, value):
"""
the replace patch operation on a Model resource
"""
response = conn.update_model(
restApiId=restApiId,
modelName=modelName,
patchOperations=[{"op": "replace", "path": path, "value": value}],
)
return response
def update_api_model_schema(
restApiId, modelName, schema, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
schema_json = (
salt.utils.json.dumps(schema) if isinstance(schema, dict) else schema
)
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = _api_model_patch_replace(
conn, restApiId, modelName, "/schema", schema_json
)
return {"updated": True, "model": _convert_datetime_str(response)}
except ClientError as e:
return {"updated": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_model(
restApiId, modelName, region=None, key=None, keyid=None, profile=None
):
"""
Delete a model identified by name in a given API
CLI Example:
.. code-block:: bash
salt myminion boto_apigateway.delete_api_model restApiId modelName
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_model(restApiId=restApiId, modelName=modelName)
return {"deleted": True}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def create_api_model(
restApiId,
modelName,
modelDescription,
schema,
contentType="application/json",
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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'
"""
try:
schema_json = (
salt.utils.json.dumps(schema) if isinstance(schema, dict) else schema
)
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
model = conn.create_model(
restApiId=restApiId,
name=modelName,
description=modelDescription,
schema=schema_json,
contentType=contentType,
)
return {"created": True, "model": _convert_datetime_str(model)}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def describe_api_integration(
restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
integration = conn.get_integration(
restApiId=restApiId, resourceId=resource["id"], httpMethod=httpMethod
)
return {"integration": _convert_datetime_str(integration)}
return {"error": "no such resource"}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def describe_api_integration_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.get_integration_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=statusCode,
)
return {"response": _convert_datetime_str(response)}
return {"error": "no such resource"}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def delete_api_integration(
restApiId, resourcePath, httpMethod, region=None, key=None, keyid=None, profile=None
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_integration(
restApiId=restApiId, resourceId=resource["id"], httpMethod=httpMethod
)
return {"deleted": True}
return {"deleted": False, "error": "no such resource"}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def delete_api_integration_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
conn.delete_integration_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=statusCode,
)
return {"deleted": True}
return {"deleted": False, "error": "no such resource"}
except ClientError as e:
return {"deleted": False, "error": __utils__["boto3.get_error"](e)}
def _get_role_arn(name, region=None, key=None, keyid=None, profile=None):
"""
Helper function to get an ARN if name does not look like an ARN.
"""
if name.startswith("arn:aws:iam:"):
return name
account_id = __salt__["boto_iam.get_account_id"](
region=region, key=key, keyid=keyid, profile=profile
)
return f"arn:aws:iam::{account_id}:role/{name}"
def create_api_integration(
restApiId,
resourcePath,
httpMethod,
integrationType,
integrationHttpMethod,
uri,
credentials,
requestParameters=None,
requestTemplates=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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 ['{}' ['{}']]
"""
try:
credentials = _get_role_arn(
credentials, region=region, key=key, keyid=keyid, profile=profile
)
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
requestParameters = (
dict() if requestParameters is None else requestParameters
)
requestTemplates = dict() if requestTemplates is None else requestTemplates
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
if httpMethod.lower() == "options":
uri = ""
credentials = ""
integration = conn.put_integration(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
type=integrationType,
integrationHttpMethod=integrationHttpMethod,
uri=uri,
credentials=credentials,
requestParameters=requestParameters,
requestTemplates=requestTemplates,
)
return {"created": True, "integration": integration}
return {"created": False, "error": "no such resource"}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def create_api_integration_response(
restApiId,
resourcePath,
httpMethod,
statusCode,
selectionPattern,
responseParameters=None,
responseTemplates=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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 ['{}' ['{}']]
"""
try:
resource = describe_api_resource(
restApiId,
resourcePath,
region=region,
key=key,
keyid=keyid,
profile=profile,
).get("resource")
if resource:
responseParameters = (
dict() if responseParameters is None else responseParameters
)
responseTemplates = (
dict() if responseTemplates is None else responseTemplates
)
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
response = conn.put_integration_response(
restApiId=restApiId,
resourceId=resource["id"],
httpMethod=httpMethod,
statusCode=statusCode,
selectionPattern=selectionPattern,
responseParameters=responseParameters,
responseTemplates=responseTemplates,
)
return {"created": True, "response": response}
return {"created": False, "error": "no such resource"}
except ClientError as e:
return {"created": False, "error": __utils__["boto3.get_error"](e)}
def _filter_plans(attr, name, plans):
"""
Helper to return list of usage plan items matching the given attribute value.
"""
return [plan for plan in plans if plan[attr] == name]
def describe_usage_plans(
name=None, plan_id=None, region=None, key=None, keyid=None, profile=None
):
"""
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'
"""
try:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
plans = _multi_call(conn.get_usage_plans, "items")
if name:
plans = _filter_plans("name", name, plans)
if plan_id:
plans = _filter_plans("id", plan_id, plans)
return {"plans": [_convert_datetime_str(plan) for plan in plans]}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def _validate_throttle(throttle):
"""
Helper to verify that throttling parameters are valid
"""
if throttle is not None:
if not isinstance(throttle, dict):
raise TypeError(
f"throttle must be a dictionary, provided value: {throttle}"
)
def _validate_quota(quota):
"""
Helper to verify that quota parameters are valid
"""
if quota is not None:
if not isinstance(quota, dict):
raise TypeError(f"quota must be a dictionary, provided value: {quota}")
periods = ["DAY", "WEEK", "MONTH"]
if "period" not in quota or quota["period"] not in periods:
raise ValueError(
"quota must have a valid period specified, valid values are {}".format(
",".join(periods)
)
)
if "limit" not in quota:
raise ValueError("quota limit must have a valid value")
def create_usage_plan(
name,
description=None,
throttle=None,
quota=None,
region=None,
key=None,
keyid=None,
profile=None,
):
"""
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}'
"""
try:
_validate_throttle(throttle)
_validate_quota(quota)
values = dict(name=name)
if description:
values["description"] = description
if throttle:
values["throttle"] = throttle
if quota:
values["quota"] = quota
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
res = conn.create_usage_plan(**values)
return {"created": True, "result": res}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
except (TypeError, ValueError) as e:
return {"error": str(e)}
def update_usage_plan(
plan_id, throttle=None, quota=None, region=None, key=None, keyid=None, profile=None
):
"""
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}'
"""
try:
_validate_throttle(throttle)
_validate_quota(quota)
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
patchOperations = []
if throttle is None:
patchOperations.append({"op": "remove", "path": "/throttle"})
else:
if "rateLimit" in throttle:
patchOperations.append(
{
"op": "replace",
"path": "/throttle/rateLimit",
"value": str(throttle["rateLimit"]),
}
)
if "burstLimit" in throttle:
patchOperations.append(
{
"op": "replace",
"path": "/throttle/burstLimit",
"value": str(throttle["burstLimit"]),
}
)
if quota is None:
patchOperations.append({"op": "remove", "path": "/quota"})
else:
patchOperations.append(
{
"op": "replace",
"path": "/quota/period",
"value": str(quota["period"]),
}
)
patchOperations.append(
{"op": "replace", "path": "/quota/limit", "value": str(quota["limit"])}
)
if "offset" in quota:
patchOperations.append(
{
"op": "replace",
"path": "/quota/offset",
"value": str(quota["offset"]),
}
)
if patchOperations:
res = conn.update_usage_plan(
usagePlanId=plan_id, patchOperations=patchOperations
)
return {"updated": True, "result": res}
return {"updated": False}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
except (TypeError, ValueError) as e:
return {"error": str(e)}
def delete_usage_plan(plan_id, region=None, key=None, keyid=None, profile=None):
"""
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'
"""
try:
existing = describe_usage_plans(
plan_id=plan_id, region=region, key=key, keyid=keyid, profile=profile
)
# don't attempt to delete the usage plan if it does not exist
if "error" in existing:
return {"error": existing["error"]}
if "plans" in existing and existing["plans"]:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
res = conn.delete_usage_plan(usagePlanId=plan_id)
return {"deleted": True, "usagePlanId": plan_id}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
def _update_usage_plan_apis(
plan_id, apis, op, region=None, key=None, keyid=None, profile=None
):
"""
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'
"""
try:
patchOperations = []
for api in apis:
patchOperations.append(
{
"op": op,
"path": "/apiStages",
"value": "{}:{}".format(api["apiId"], api["stage"]),
}
)
res = None
if patchOperations:
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
res = conn.update_usage_plan(
usagePlanId=plan_id, patchOperations=patchOperations
)
return {"success": True, "result": res}
except ClientError as e:
return {"error": __utils__["boto3.get_error"](e)}
except Exception as e: # pylint: disable=broad-except
return {"error": e}
def attach_usage_plan_to_apis(
plan_id, apis, region=None, key=None, keyid=None, profile=None
):
"""
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"}]'
"""
return _update_usage_plan_apis(
plan_id, apis, "add", region=region, key=key, keyid=keyid, profile=profile
)
def detach_usage_plan_from_apis(
plan_id, apis, region=None, key=None, keyid=None, profile=None
):
"""
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"}]'
"""
return _update_usage_plan_apis(
plan_id, apis, "remove", region=region, key=key, keyid=keyid, profile=profile
)