Alice Williams
1dd560977b
* add files back from lost local files Signed-off-by: Alice Williams <[email protected]> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <[email protected]> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <[email protected]> * better title for cron job report example Signed-off-by: Alice Williams <[email protected]> * for more details from tech reviewer Signed-off-by: Alice Williams <[email protected]> * for better cron job usage description Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <[email protected]> * more info Signed-off-by: Alice Williams <[email protected]> * more details from demonstration Signed-off-by: Alice Williams <[email protected]> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <[email protected]> * small addition Signed-off-by: Alice Williams <[email protected]> * for two configuration settings in the function Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <[email protected]> * for scheduling reports with lambda Signed-off-by: Alice Williams <[email protected]> * merge redundant set of steps together Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to add download correct title and link Signed-off-by: Alice Williams <[email protected]> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <[email protected]> * un-nest reporting directory Signed-off-by: Alice Williams <[email protected]> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <[email protected]> * tech review comments and some reorg Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to minor changes Signed-off-by: Alice Williams <[email protected]> * more info about crontab sequence Signed-off-by: Alice Williams <[email protected]> * cron updates Signed-off-by: Alice Williams <[email protected]> * for cron syntax Signed-off-by: Alice Williams <[email protected]> * small updates to lambda proc Signed-off-by: Alice Williams <[email protected]> * for final writer checklist Signed-off-by: Alice Williams <[email protected]> * cron link update Signed-off-by: Alice Williams <[email protected]> * format fix Signed-off-by: Alice Williams <[email protected]> * for doc review cron & lambda sections Signed-off-by: Alice Williams <[email protected]> * for cron reference to man page Signed-off-by: Alice Williams <[email protected]> * add internal link to cron ref Signed-off-by: Alice Williams <[email protected]> * reorg single topic into 7 pages Signed-off-by: Alice Williams <[email protected]> * minor update Signed-off-by: Alice Williams <[email protected]> * link to set ses permissions Signed-off-by: Alice Williams <[email protected]> * for tech review meeting updates Signed-off-by: Alice Williams <[email protected]> * small update Signed-off-by: Alice Williams <[email protected]> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <[email protected]> * for new download via artifacts hub Signed-off-by: Alice Williams <[email protected]> * for new download instructions Signed-off-by: Alice Williams <[email protected]> * small fix signature file Signed-off-by: Alice Williams <[email protected]> * typo Signed-off-by: Alice Williams <[email protected]> * for cleaner image Signed-off-by: Alice Williams <[email protected]> * remove image for push commands we won't use Signed-off-by: Alice Williams <[email protected]> --------- Signed-off-by: Alice Williams <[email protected]>
2.5 KiB
2.5 KiB
layout, title, nav_order, has_children
| layout | title | nav_order | has_children |
|---|---|---|---|
| default | Creating reports with the Reporting CLI | 75 | true |
Creating reports with the Reporting CLI
You can programmatically create dashboard reports in PDF or PNG format with the Reporting CLI without using OpenSearch Dashboards or the Reporting plugin. This allows you to create reports automatically within your email workflows.
If you want to download a CSV file, you need to have the Reporting plugin installed. {: .note }
For any dashboard view, you can request a report in PNG or PDF format to be sent to an email address. This can be useful for sending reports to multiple email recipients with an email alias. The only dashboard application that supports creating a CSV report is Discover.
With the Reporting CLI, you can specify options for your report in the command line. The report is sent to an email address as a PDF attachment by default. You can also request a PNG image or a CSV file with the --formats argument.
You can download the report to the directory in which you are running the Reporting CLI, or you can email the report by specifying Amazon Simple Email Service (Amazon SES) or SMTP for the email transport option.
You can connect to OpenSearch with any of the following authentication types:
- Basic – Basic HTTP authentication. Use
-a basic. - Cognito – Authentication through Amazon Cognito. Use
-a cognito. - SAML – Authentication between an identity provider and a service provider. Use
-a saml. Okta provides the SAML third-party authentication. - No auth – No authentication. Use
-a none. Authentication defaults to No auth if the-aflag is not specified.
To learn more about Amazon Cognito, see What is Amazon Cognito?.