rest_api#

Exec module for managing Amazon API Rest APIs.

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

Returns a rest api, including their root resource id.

Parameters:

  • name (str) – idem name associated with this resource_id.

  • resource_id (str) – id of the specific rest_api to look up.

Returns:

Returns details of a rest_api.

Return type:

dict[str, Any]

Examples

idem exec aws.apigateway.rest_api.get name=test_rest_api resource_id=xvwtynovjx --output json

    Call from code:

async def my_func(hub, ctx, name:str, resource_id:str):
    await hub.exec.aws.apigateway.rest_api.get(ctx, name, resource_id, api_id)

Normally, rest_api would be managed via aws.apigateway.rest_api.present, but using get in a state is possible:

my_unmanaged_rest_api:
  exec.run:
    - path: aws.apigateway.rest_api.get
    - kwargs:
        name: my_resource
        resource_id: resource_id