stream#

async idem_aws.exec.aws.kinesis.stream.get(hub, ctx, name: str, resource_id: str = None) → Dict[source]#

Pass required params to get a Kinesis stream resource. Retrieves the specified Kinesis Stream.

Parameters:

  • name (str) – AWS Kinesis Stream name to uniquely identify the resource.

  • resource_id (str, Optional) – AWS Kinesis Stream name.

Returns:

result(bool):

Whether the result of the function has been successful (True) or not (False).

comment(list):

A list of messages.

ret(dict or None):

The Kinesis Stream in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.kinesis.stream.get name="idem_name" resource_id="resource_id"

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

async def state_function(hub, ctx, name, resource_id, **kwargs):
    ret = await hub.exec.aws.kinesis.stream.get(
        ctx, name=name, resource_id=resource_id
    )