stage#

Exec module for managing Amazon API Gateway Stage.

async idem_aws.exec.aws.apigateway.stage.get(hub, ctx, resource_id: str)[source]#

Get an API Gateway Stage from AWS. If more than one resource is found, the first resource returned from AWS: will be used. The function returns None when no resource is found.

Parameters:

resource_id (str) –

Idem Resource ID that is generated once the resource is created,: formatted as: <rest_api_id>-<name>.

Returns:

{"result": True|False, "comment": A message List, "ret": Dict[str, Any]}

Examples

Calling this exec module function from the cli with resource_id

idem exec aws.apigateway.stage.get resource_id="resource_id"

Calling this exec module function from within a state module in pure python

my_unmanaged_stack:
  exec.run:
    - path: aws.apigateway.stage.get
    - kwargs:
        resource_id: '<rest_api_id>-<name>'