Method format_examples

samcli/commands/logs/core/command.py:23–90

(ctx: Context, formatter: CommandHelpTextFormatter)

    @staticmethod
    def format_examples(ctx: Context, formatter: CommandHelpTextFormatter):
        with formatter.indented_section(name="Examples", extra_indents=1):
            with formatter.indented_section(
                name="Fetch logs with Lambda Function Logical ID and Cloudformation Stack Name"
            ):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} -n HelloWorldFunction --stack-name mystack"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(name="View logs for specific time range"):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} -n HelloWorldFunction --stack-name mystack -s "
                                f"'10min ago' -e '2min ago'"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(name="Tail new logs"):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} -n HelloWorldFunction --stack-name " f"mystack --tail"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(name="Fetch from Cloudwatch log groups"):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --cw-log-group /aws/lambda/myfunction-123 "
                                f"--cw-log-group /aws/lambda/myfunction-456"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )

            with formatter.indented_section(name="Fetch logs from supported resources in Cloudformation stack"):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} ---stack-name mystack"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )

            with formatter.indented_section(name="Fetch logs from resource defined in nested Cloudformation stack"):