integration#

Exec functions for AWS API Gateway v2 Integration resources.

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

Gets an Integration.

Parameters:

  • resource_id (str) – The integration ID.

  • api_id (str) – The API identifier.

  • name (str, Optional) – The name of the Idem state.

Returns:

Returns an integration.

Return type:

Dict[str, Any]

Examples

Call from the CLI:

idem exec aws.apigatewayv2.integration.get resource_id="integration_id" api_id="api_id" name="my_resource"

Call from code:

async def my_func(hub, ctx, resource_id:str, api_id: str, name:str = None):
    await hub.exec.aws.apigatewayv2.integration.get(ctx, resource_id, api_id, name)

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.apigatewayv2.integration.get
    - kwargs:
        resource_id: integration_id
        api_id: api_id
        name: my_resource