api#

Exec functions for AWS API Gateway v2 API resources.

async idem_aws.exec.aws.apigatewayv2.api.get(hub, ctx, name: str, resource_id: str) → Dict[str, Any][source]#

Get an API resource from AWS

Parameters:

  • name (str) – The name of the Idem state

  • resource_id (str) – The API identifier

Returns:

Returns API resource

Return type:

Dict[str, Any]

Examples

Call from the CLI:

idem exec aws.apigatewayv2.api.get name="my_resource" resource_id="resource_id"

Call from code:

async def my_func(hub, ctx, name:str, resource_id:str):
    await hub.exec.aws.apigatewayv2.api.get(ctx, name, resource_id)

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.apigatewayv2.api.get
    - kwargs:
        name: my_resource
        resource_id: resource_id
async idem_aws.exec.aws.apigatewayv2.api.list_(hub, ctx) → Dict[str, Any][source]#

Get a list of API resource from AWS

Parameters:

None –

Returns:

Returns API resources

Return type:

Dict[str, Any]

Examples

Call from the CLI:

idem exec aws.apigatewayv2.api.list

Call from code:

async def my_func(hub, ctx):
    await hub.exec.aws.apigatewayv2.api.list(ctx)

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.apigatewayv2.api.list