This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
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.
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?.