Developer Console

Step 5: Verify that Your Uploaded Catalog Has No Errors

After you upload your catalog file, Amazon posts reports to your catalog bucket at an hourly cadence. The reports include details of the video items processed in the past hour. Review these reports to make sure there are no errors with your catalog. If there are errors, you must interpret the messages contained in the ingestion report and troubleshoot your catalog file.

Receiving and understanding the catalog ingestion report

After you've uploaded your catalog data to the Amazon Simple Storage Service (S3) bucket for integration into the Amazon catalog, the catalog integration system starts processing your catalog and generates ingestion reports hourly. These reports include the number of video items processed in the past hour and have details about any problems found with the video items.

Retrieving your ingestion report

The ingestion reports are HTML files placed in the same S3 bucket as your uploaded catalog file. You can opt to receive an email telling you that the new report is ready, providing a basic summary of its contents and giving you a command with which you can download the full report.

How to receive ingestion status notification emails

To receive your ingestion report summary emails, ask your Amazon representative to add you to the distribution list for your catalog. The ingestion system sends emails for successes and failures, so if you want to receive both types of emails, ask to be included on both lists. If a video item was processed in the past hour, reports are generated hourly.

How to use the information in the email

The email that you receive provides the status of the video items processed in the past hour. To view the errors encountered when processing the video items, see the full report. The email contains an Amazon Web Services (AWS) command to retrieve the full report.

To use the AWS command to retrieve the report, you must first install the Amazon Web Services Command Line Interface (CLI) tool, after which you can use AWS commands in a normal command or terminal window. This ensures that your proprietary catalog information remains protected, because only someone with permission to access your S3 bucket can retrieve the report using that command.

Here's an example of the AWS command to retrieve the report. Copy the line from the email and paste it into your command or terminal window.

aws s3api get-object --bucket cdf-test --key reports/12_17_2024/report-1734398489665-20241217012129.html --version-id FciuqMvVh2oWFv726L6Ytf8ECLbO6Kj0 report.html

When run successfully, this command downloads the report to your current folder. The downloaded file has the name report.html. To understand what the command does, see the AWS CLI Command Reference get-object page.

Ingestion report

The ingestion report has three sections:

The summary

The following image shows an example of the summary section of an ingestion report.

Shows counts for Errors, Warnings, and Suggestions. Shows counts for Total, Added, Deleted, Skipped, Updated, and Unchanged.
Example ingestion report summary section

The summary includes the following:

  • A unique ID given to each ingestion attempt
  • The date and time when the ingestion attempt was made
  • Counts of video items processed, including total, added, deleted, skipped, updated, and unchanged
  • Error, warning, and suggestion message counts for processed items

Errors, warnings, and suggestions

This portion of the report is where you find the information that you need to fix any problems. You can view the report information by expanding the sections. The following image shows the three message sections with the Details buttons collapsed.

Errors, Warnings, and Suggestions sections, each with an expandable Details section.

The Details button opens an expandable section that lists individual messages. At the end of each message is the number of entries that generated it. After expanding a details section, click the plus sign next to a message to display the IDs of the works that generated the message. In some cases, this shows an additional message with more details. The following image shows an example with expanded error details.

The error shown is 'Id attribute has invalid type'. The error is expanded to show the individual items with these issues.
Expanded errors showing details

Counts

The last section in the report provides details on the changes to your catalog as a result of the ingestion. Click the Details button in each category to show the IDs of the works in each. The following image shows the counts section of the report.

Shows sections Added, Deleted, Skipped, Updated, and Unchanged. Sections with at least one item contain an expandable Details button.

If you have a list of expected changes, you can compare it against these lists as a final verification. The skipped count indicates the number of video items skipped from ingestion due to an error or warning. If the ingestion was successful, the total, added, deleted, updated, and unchanged numbers should reflect your expected results.

Acting on the ingestion report

What you do next depends on errors present in your ingestion reports.

  • No errors: As long as the counts of total, added, deleted, updated, and unchanged are as you expect, there is no further action required. However, consider addressing any warnings and suggestions. For an explanation and course of action for each message, see Catalog Ingestion Report Messages.

  • With Errors: For an explanation and course of action for each entry in the Error section, see Catalog Ingestion Report Messages. If you still have trouble understanding what needs to be done or how to do it, contact your Amazon representative.

Catalog summary report

The Catalog Summary Report provides a consolidated view of your catalog's current status with Amazon. This consolidated view is comprehensive and includes all your catalog items, any outstanding errors and warnings, and optimization suggestions. The report shows all issues in one place, regardless of when they were introduced, providing you with a centralized source of information for catalog maintenance. You can use the report to help efficiently manage and improve your catalog's health. The report is generated daily and available in your S3 bucket at /reports/<Date>/catalog-summary-<DateTime>.html.

The following image shows an example Catalog Summary Report.

Shows the Errors, Warnings, Suggestions, and Catalog Items sections, each with an expandable Details section.

Ingestion reports FAQ

The following are frequently asked questions (FAQ) about ingestion reports.

Q: How do I know if my uploaded catalog file was ingested into the system?
You can receive the ingestion results through an opt-in email. Ask your Amazon representative to add you to the email distribution list.
Q: My catalog ingestion has errors. What do I do next?
Look at your ingestion report for the specific errors. The ingestion report documentation contains explanations and follow-up instructions for each error. For details, see Catalog Ingestion Report Messages.

Next Steps

Continue on to the next step: Step 6: Update your Catalog at Regular Intervals.


Last updated: Feb 04, 2025