id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
supplychain-ug-094
|
supplychain-ug.pdf
| 94 |
have Value for a value, a value, a value, a value, the column enter enter enter enter 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1 1 1 1 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for eff_start eff_start eff_start eff_start _date, and _date, and _date, and _date, and name is not required for Lead Time Insights. 9999-12-3 9999-12-3 9999-12-3 9999-12-3 1 1 1 1 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for eff_end_d eff_end_d eff_end_d eff_end_d ate. ate. ate. ate. Insights 362 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column eff_end_date used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – You must Required – You must Required – You must Required – You must Column name enter a enter a enter a enter a eff_end_d value for value for value for value for ate eff_start eff_start eff_start eff_start should be _date and _date and _date and _date and available eff_end_d eff_end_d eff_end_d eff_end_d in your ate. If you ate. If you ate. If you ate. If you dataset. don't have don't have don't have don't have Value for a value, a value, a value, a value, the column enter enter enter enter 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1 1 1 1 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for eff_start eff_start eff_start eff_start _date, and _date, and _date, and _date, and name is not required for Lead Time Insights. 9999-12-3 9999-12-3 9999-12-3 9999-12-3 1 1 1 1 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for eff_end_d eff_end_d eff_end_d eff_end_d ate. ate. ate. ate. Insights 363 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? time_zone Optional Optional Optional Optional Column name time_zone should be available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 364 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? is_active Optional Optional Optional Optional Column name is_active should be available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 365 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column tpartner_type used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Column name ingest data ingest data ingest data ingest data tpartner_ from SAP from SAP from SAP from SAP type or EDI, the or EDI, the or EDI, the or EDI, the should be default default default default available value for value for value for value for in your string is string is string is string is dataset. SCN_RESER SCN_RESER SCN_RESER SCN_RESER Value for VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA the column LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI name DED. When DED. When DED. When DED. When is not you upload you upload you upload you upload required data using the data using the data using the data using the for Lead Time Amazon S3 Amazon S3 Amazon S3 Amazon S3 Insights. connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for successful successful successful successful ingestion. ingestion. ingestion. ingestion. Insights 366 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column geo_id used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Column name ingest data ingest data ingest data ingest data geo_id from SAP from SAP from SAP from SAP should be or EDI, the or EDI, the or EDI, the or EDI, the available default default default default in your value for value for value for value for dataset. string is string is string is string is Value for SCN_RESER SCN_RESER SCN_RESER SCN_RESER the column VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA name LUE_PROVI LUE_PROVI LUE_PROVI
|
supplychain-ug-095
|
supplychain-ug.pdf
| 95 |
for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Column name ingest data ingest data ingest data ingest data geo_id from SAP from SAP from SAP from SAP should be or EDI, the or EDI, the or EDI, the or EDI, the available default default default default in your value for value for value for value for dataset. string is string is string is string is Value for SCN_RESER SCN_RESER SCN_RESER SCN_RESER the column VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA name LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI is not DED. When DED. When DED. When DED. When required you upload you upload you upload you upload for Lead data using the data using the data using the data using the Time Insights. Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for successful successful successful successful ingestion. ingestion. ingestion. ingestion. Insights 367 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? id inbound_o rder order_type Note This data entity is order_status required for Lead Time to_site_id Insights but optional for Inventory Visibilit y, Network Map, Inventory Insights, and Rebalance Recommend ations. submitted_date Not required Not required Not required Not required Not required Not required ations? Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Required Optional – Data can be used by inbound order line. Optional Column name site_id should be available in your dataset. Value for the column name is not required for Lead Time Insights. Required Insights 368 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Required Required Required Required Required 369 tpartner_id id inbound_o rder_line Insights AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? order_id Required Required Required Required Required order_type Required Required Required Required Optional status Required Required Required Required Optional product_id Required Required Required Required Required to_site_id Required Required Required Required Required from_site_id Required Required Required Required Required quantity_ submitted Required – One Required – One Required – One Required – One Required – One quantity_ confirmed quantity_received quantity quantity quantity quantity quantity field field field field field should be should be should be should be should be set. set. set. set. set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional
|
supplychain-ug-096
|
supplychain-ug.pdf
| 96 |
Required Required to_site_id Required Required Required Required Required from_site_id Required Required Required Required Required quantity_ submitted Required – One Required – One Required – One Required – One Required – One quantity_ confirmed quantity_received quantity quantity quantity quantity quantity field field field field field should be should be should be should be should be set. set. set. set. set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – One quantity field should be set. Optional – This field should be blank for open Optional – This field should be blank for open Optional – This field should be blank for open Optional – This field should be blank for open Optional – This field should be blank for open orders. orders. orders. orders. orders. Insights 370 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column quantity_uom used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – This field is Required – This field is Required – This field is Required – This field is Column name required to required to required to required to quantity_ determine determine determine determine uom the the the the unit for unit for unit for unit for should be available quantity quantity quantity quantity in your fields. fields. fields. fields. dataset. Value for the column name is not required for Lead Time Insights. expected_ delivery_date Required Required Required Required Required Insights 371 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? submitted_date Column name Column name Column name ations? Column name Required submitted submitted submitted submitted _date _date _date _date should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 372 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? incoterm Column name incoterm Column name incoterm Column name incoterm ations? Column name incoterm Optional should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not name is not name is not name is not required required required required for for for for Inventory visibility. Network map. Inventory Insights. Rebalance Recommend ations. Insights 373 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? product_group_id Column name Column name Column name ations? Column name Optional product_g product_g product_g product_g roup_id roup_id roup_id roup_id should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 374 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? company_id Column name Column name Column name ations? Column name Optional company_i company_i company_i company_i d should d should d should d should be be be be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required
|
supplychain-ug-097
|
supplychain-ug.pdf
| 97 |
column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? company_id Column name Column name Column name ations? Column name Optional company_i company_i company_i company_i d should d should d should d should be be be be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance Insights. map. Insights. Recommend ations. Insights 375 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column tpartner_id used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 376 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? reservation_id Optional – This field Optional – This field Optional – This field Optional – This field Column name reservati on_id should be available in your dataset. Value for the column name is not required for Lead Time Insights. is used to is used to is used to is used to determine determine determine determine the the the the connectio connectio connectio connectio n between n between n between n between order order order order line and line and line and line and order line order line order line order line schedule. schedule. schedule. schedule. For For For For example, example, example, example, 1001 - A, where 1001 - A, where 1001 - A, where 1001 - A, where 1001 is the 1001 is the 1001 is the 1001 is the order_id order_id order_id order_id and A is the and A is the and A is the and A is the order_lin order_lin order_lin order_lin e_id in the e_id in the e_id in the e_id in the inbound_o inbound_o inbound_o inbound_o rder_line rder_line rder_line rder_line _schedule _schedule _schedule _schedule table. table. table. table. Insights 377 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? order_rec eive_date Column name Column name Column name ations? Column name Optional order_rec order_rec order_rec order_rec eive_date eive_date eive_date eive_date should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 378 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required Required Required Required Required Required – This field is Required – This field is
|
supplychain-ug-098
|
supplychain-ug.pdf
| 98 |
for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 378 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required Required Required Required Required Required – This field is Required – This field is Required – This field is Required – This field is Required. When you required to required to required to required to ingest data link back link back link back link back from SAP to an order line along to an order line along to an order line along to an order line along or EDI, the default with the with the with the with the value for order_lin order_lin order_lin order_lin string is e_id. e_id. e_id. e_id. SCN_RESER VED_NO_VA LUE_PROVI DED. When you upload data using the Amazon S3 connector , you must enter a value or use SCN_RESER VED_NO_VA LUE_PROVI DED for successful ingestion. 379 inbound_o id rder_line _schedule order_id Note This data entity is required for Lead Time Insights but optional for Inventory Visibilit y, Network Map, Inventory Insights, and Rebalance Recommend ations. Insights AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – This field Required – This field Required – This field Required – This field Column name is required is required is required is required order_lin to link to link to link to link e_id back to an back to an back to an back to an should be order line order line order line order line available along with along with along with along with in your order_id. order_id. order_id. order_id. dataset. Value for the column name is not required for Lead Time Insights. Column name company_i d should be available in your Column name company_i d should be available in your Column name company_i d should be available in your Column name company_i d should be available in your Column name company_i d should be available in your dataset. dataset. dataset. dataset. dataset. Value for Value for Value for Value for Value for the column the column the column the column the column name is not name is not name is not name is not name is not required required required required required When order_line_id data is not ingested for this data entity, Insights will use the supply data from inbound_o rder_line company_id data entity. For custom configura tions, contact Get support for AWS Insights 380 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Supply Chain. for Lead for Lead for Lead for Lead for Lead Time Insights. Time Insights. Time Insights. Time Insights. Time Insights. product_id Required Required Required Required Required expected_ delivery_date Optional – delivery_ Optional – delivery_ Optional – delivery_ Optional – delivery_ Optional date or date or date or date or expected_ expected_ expected_ expected_ delivery delivery delivery delivery date date date date must be must be must be must be provided. provided. provided. provided. Insights 381 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column delivery_date used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Optional – delivery_ Optional – delivery_ Optional – delivery_ Optional – delivery_ date or date or date or date or Column name delivery_ expected_ expected_ expected_ expected_ date delivery delivery delivery delivery date date date date should be available must be must be must be must be in your provided. provided. provided. provided. dataset. Value for the column name is not required for Lead Time Insights. Insights 382 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column ship_date used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Optional – Date Optional – Date Optional – Date Optional – Date Column name when the when the when the when the ship_date order was order was order
|
supplychain-ug-099
|
supplychain-ug.pdf
| 99 |
be must be must be in your provided. provided. provided. provided. dataset. Value for the column name is not required for Lead Time Insights. Insights 382 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column ship_date used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Optional – Date Optional – Date Optional – Date Optional – Date Column name when the when the when the when the ship_date order was order was order was order was should be shipped. shipped. shipped. shipped. available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 383 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column quantity_ submitted used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – One Required – One Required – One Required – One quantity quantity quantity quantity field field field field Column name quantity_ submitted should be should be should be should be should be set. This set. This set. This set. This available field uses field uses field uses field uses in your the uom the uom the uom the uom dataset. set at the set at the set at the set at the Value for line level. line level. line level. line level. the column name is not required for Lead Time Insights. Insights 384 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column quantity_ confirmed used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – One Required – One Required – One Required – One quantity quantity quantity quantity field field field field Column name quantity_ confirmed should be should be should be should be should be set. This set. This set. This set. This available field uses field uses field uses field uses in your the uom the uom the uom the uom dataset. set at the set at the set at the set at the Value for line level. line level. line level. line level. the column name is not required for Lead Time Insights. Insights 385 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? quantity_received Required – One Required – One Required – One Required – One Column name quantity quantity quantity quantity quantity_ field field field field received should be should be should be should be should be set. This set. This set. This set. This available field uses field uses field uses field uses in your the uom the uom the uom the uom dataset. set at the set at the set at the set at the Value for line level. line level. line level. line level. the column name is not required for Lead Time Insights. shipment id Required Required Required Required Optional order_id Required Required Required – This field is required to calculate the in- transit and on-order values for projected inventory visibility. Required – This field is required to calculate the in- transit and on-order Required – This field is required to calculate the in- transit and on-order values for values for projected projected inventory inventory visibility. visibility. Insights 386 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? order_line_id Required Required Required – This field is required to calculate the in- transit and on-order values for projected inventory visibility. ations? Required – This field is Required – This field is required to required to calculate calculate the in- the in- transit and transit and on-order on-order values for values for projected projected inventory inventory visibility. visibility. product_id Required Required Required Required Required ship_to_site_id Optional – Derived Optional – Derived Optional – Derived Optional – Derived Required actual_de livery_date from from from from inbound inbound inbound inbound order line. order line. order line. order line. Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da
|
supplychain-ug-100
|
supplychain-ug.pdf
| 100 |
calculate the in- the in- transit and transit and on-order on-order values for values for projected projected inventory inventory visibility. visibility. product_id Required Required Required Required Required ship_to_site_id Optional – Derived Optional – Derived Optional – Derived Optional – Derived Required actual_de livery_date from from from from inbound inbound inbound inbound order line. order line. order line. order line. Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da te must be Optional – planned_d elivery_d ate or actual_de livery_da te must be provided. provided. provided. provided. Required Insights 387 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column units_shipped uom used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Optional – Derived Optional – Derived Optional – Derived Optional – Derived Optional – Derived from from from from from inbound inbound inbound inbound inbound order line. order line. order line. order line. order line. Optional – This field Optional – This field Optional – This field Optional – This field Optional – This field is used to is used to is used to is used to is used to determine determine determine determine determine the the the the the unit for unit for unit for unit for unit for quantity quantity quantity quantity quantity fields. fields. fields. fields. fields. Insights 388 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? planned_s hip_date Optional – planned_s Optional – planned_s Optional – planned_s Optional – planned_s Column name hip_date or hip_date or hip_date or hip_date or planned_s actual_sh actual_sh actual_sh actual_sh hip_date ip_date ip_date ip_date ip_date should be must be must be must be must be available provided. provided. provided. provided. in your dataset. Value for the column name is not required for Lead Time Insights. Insights 389 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? actual_ship_date Optional – planned_s Optional – planned_s Optional – planned_s Optional – planned_s Column name hip_date or hip_date or hip_date or hip_date or actual_sh actual_sh actual_sh actual_sh actual_sh ip_date ip_date ip_date ip_date ip_date should be must be must be must be must be available provided. provided. provided. provided. in your dataset. Value for the column name is not required for Lead Time Insights. Insights 390 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? planned_d elivery_date Optional – planned_d Optional – planned_d Optional – planned_d Optional – planned_d Column name elivery_d elivery_d elivery_d elivery_d planned_d ate or ate or ate or ate or elivery_d actual_de actual_de actual_de actual_de ate livery_da livery_da livery_da livery_da should be te must be te must be te must be te must be available provided. provided. provided. provided. in your dataset. Value for the column name is not required for Lead Time Insights. Optional ship_from_site_id Optional – Derived from inbound order line. Optional – Derived from inbound order line. Optional – Derived from inbound order line. Optional – Derived from inbound order line. Insights 391 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? supplier_ tpartner_id Column name Column name Column name ations? Column name Optional supplier_ supplier_ supplier_ supplier_ tpartner_id tpartner_id tpartner_id tpartner_id should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 392 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network
|
supplychain-ug-101
|
supplychain-ug.pdf
| 101 |
should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for Inventory name is not required for Network name is not name is not required required for Inventory for Rebalance visibility. map. Insights. Recommend ations. Insights 392 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? transport ation_mode Column name Column name Column name ations? Column name Optional transport transport transport transport ation_mod ation_mod ation_mod ation_mod e should e should e should e should be be be be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for name is not required for name is not required for name is not required for Inventory Network Inventory Rebalance visibility. map. Insights. Recommend ations. Insights 393 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ship_from _site_add Column name Column name Column name ations? Column name Optional ress_country ship_from ship_from ship_from ship_from _site_add _site_add _site_add _site_add ress_coun ress_coun ress_coun ress_coun try try try try should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for name is not required for name is not required for name is not required for Inventory Network Inventory Rebalance visibility. map. Insights. Recommend ations. Insights 394 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column ship_to_s ite_addre ss_country used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? Column name Column name Column name ations? Column name Optional ship_to_s ship_to_s ship_to_s ship_to_s ite_addre ite_addre ite_addre ite_addre ss_country ss_country ss_country ss_country should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not required for name is not required for name is not required for name is not required for Inventory Network Inventory Rebalance visibility. map. Insights. Recommend ations. Insights 395 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? carrier_id Column name Column name Column name ations? Column name Optional carrier_id carrier_id carrier_id carrier_id should be should be should be should be available available available available in your dataset. in your dataset. in your dataset. in your dataset. Value for Value for Value for Value for the column the column the column the column name is not name is not name is not name is not required required required required for for for for Inventory visibility. Network map. Inventory Insights. Rebalance Recommend ations. Insights 396 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector
|
supplychain-ug-102
|
supplychain-ug.pdf
| 102 |
the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Required Required Required Required Required 397 package_id id inv_polic y Insights AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? site_id Required Required Required Required Required product_id Required Required Required Required Required min_safety_stock Required Required Required Required Required max_safety_stock Required Required Required Required Required qty_uom Optional – This field Optional – This field Optional – This field Optional – This field Optional – This field is used to is used to is used to is used to is used to determine determine determine determine determine the the the the the UOM for UOM for UOM for UOM for UOM for inventory inventory inventory inventory inventory policy. policy. policy. policy. policy. Insights 398 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? min_doc_limit Optional – This field is Optional – This field is Optional – This field is Optional – This field is Column name required if required if required if required if min_doc_l you want you want you want you want imit to see the to see the to see the to see the should be days of cover. days of cover. days of cover. days of cover. available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 399 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? max_doc_limit Optional – This field is Optional – This field is Optional – This field is Optional – This field is Column name required if required if required if required if max_doc_l you want you want you want you want imit to see the to see the to see the to see the should be days of cover. days of cover. days of cover. days of cover. available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 400 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? eff_start_date Required – You must Required – You must Required – You must Required – You must Required – You must enter a enter a enter a enter a enter a value for value for value for value for value for eff_start eff_start eff_start eff_start eff_start _date and _date and _date and _date and _date and eff_end_d eff_end_d eff_end_d eff_end_d eff_end_d ate. If you ate. If you ate. If you ate. If you ate. If you don't have don't have don't have don't have don't have a value, a value, a value, a value, a value, enter enter enter enter enter 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1 1 1 1 1 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for eff_start eff_start eff_start eff_start eff_start _date, and _date, and _date, and _date, and _date, and 9999-12-3 9999-12-3 9999-12-3 9999-12-3 9999-12-3 1 1 1 1 1 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for eff_end_d eff_end_d eff_end_d eff_end_d eff_end_d ate. ate. ate. ate. ate. Insights 401 AWS
|
supplychain-ug-103
|
supplychain-ug.pdf
| 103 |
you ate. If you ate. If you don't have don't have don't have don't have don't have a value, a value, a value, a value, a value, enter enter enter enter enter 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1 1 1 1 1 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for eff_start eff_start eff_start eff_start eff_start _date, and _date, and _date, and _date, and _date, and 9999-12-3 9999-12-3 9999-12-3 9999-12-3 9999-12-3 1 1 1 1 1 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for eff_end_d eff_end_d eff_end_d eff_end_d eff_end_d ate. ate. ate. ate. ate. Insights 401 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? eff_end_date Required – You must Required – You must Required – You must Required – You must Required – You must enter a enter a enter a enter a enter a value for value for value for value for value for eff_start eff_start eff_start eff_start eff_start _date and _date and _date and _date and _date and eff_end_d eff_end_d eff_end_d eff_end_d eff_end_d ate. If you ate. If you ate. If you ate. If you ate. If you don't have don't have don't have don't have don't have a value, a value, a value, a value, a value, enter enter enter enter enter 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1900-01-0 1 1 1 1 1 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for 00:00:00 for eff_start eff_start eff_start eff_start eff_start _date, and _date, and _date, and _date, and _date, and 9999-12-3 9999-12-3 9999-12-3 9999-12-3 9999-12-3 1 1 1 1 1 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for 23:59:59 for eff_end_d eff_end_d eff_end_d eff_end_d eff_end_d ate. ate. ate. ate. ate. company_id Optional Optional Optional Optional Optional ss_policy Required – abs_level when there Required – abs_level when there Required – abs_level when there Required – abs_level when there Required – abs_level when there is no value. is no value. is no value. is no value. is no value. Insights 402 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? fallback_policy_1 Optional Optional Optional Optional Column name fallback_ policy_1 should be available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 403 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? product_group_id Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 404 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column dest_geo_id used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value
|
supplychain-ug-104
|
supplychain-ug.pdf
| 104 |
Guide Column Data entity Is the column Is the column Is the column Is the column Is the column dest_geo_id used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 405 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? vendor_tp artner_id Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 406 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? inv_level snapshot_date Required Required Required Required Required site_id Note product_id Enter Required Required Required Required Required Required Required Required Required Required the on- company_id hand on_hand_i inventory nventory at the allocated _inventory beginning of the day. Optional Optional Optional Optional Optional Required Required Required Required Required Optional Optional Optional Optional Column name allocated _inventory should be available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 407 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column quantity_uom used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Optional – This field Optional – This field Optional – This field Optional – This field Column name is used to is used to is used to is used to quantity_ determine determine determine determine uom the quantity UOM for the quantity UOM for the quantity UOM for the quantity UOM for should be available in your inventory inventory inventory inventory dataset. records. records. records. records. Value for the column name is not required for Lead Time Insights. Insights 408 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column inv_condition used for used for used for used for
|
supplychain-ug-105
|
supplychain-ug.pdf
| 105 |
Optional – This field Column name is used to is used to is used to is used to quantity_ determine determine determine determine uom the quantity UOM for the quantity UOM for the quantity UOM for the quantity UOM for should be available in your inventory inventory inventory inventory dataset. records. records. records. records. Value for the column name is not required for Lead Time Insights. Insights 408 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column inv_condition used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. When you Required. When you Required. When you Required. When you Required. When you ingest data ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the or EDI, the default default default default default value for value for value for value for value for string is string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When DED. When you upload you upload you upload you upload you upload data using the data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 409 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column lot_number used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required – Insights Required – Insights Required – Insights Required – Insights Required – Insights expects expects expects expects expects one one one one one inventory inventory inventory inventory inventory level level level level level record per record per record per record per record per site and product for the given site and product for the given site and product for the given site and product for the given site and product for the given snapshot snapshot snapshot snapshot snapshot date. date. date. date. date. When you upload When you upload When you upload When you upload When you upload data data data data data using the using the using the using the using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector connector , you must , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for DED for successful successful successful successful successful ingestion. ingestion. ingestion. ingestion. ingestion. Insights 410 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? forecast site_id Required Required Required Required product_id Required Required Required Required mean Required Required Required Required Not required Not required Not required Insights 411 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? forecast_start_dtt m Required Required Required Required Not required Note Make sure the forecast_ start_dtt m and forecast_ end_dttm are set at different dates when forecast is set at a daily interval. The forecast_ end_dttm must be set at the explicit end of the date range. Insights 412 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? forecast_ end_dttm quantity_uom Required Required Required Required Not required Optional
|
supplychain-ug-106
|
supplychain-ug.pdf
| 106 |
Required Required Required Required Not required Note Make sure the forecast_ start_dtt m and forecast_ end_dttm are set at different dates when forecast is set at a daily interval. The forecast_ end_dttm must be set at the explicit end of the date range. Insights 412 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? forecast_ end_dttm quantity_uom Required Required Required Required Not required Optional – This field Optional – This field Optional – This field Optional – This field Column name is used to is used to is used to is used to quantity_ determine the determine the determine the determine the quantity UOM for forecast. quantity UOM for forecast. quantity UOM for forecast. quantity UOM for forecast. uom should be available in your dataset. Value for the column name is not required for Lead Time Insights. Insights 413 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? snapshot_date Required. When you Required. When you Required. When you Required. When you Not required ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the default default default default value for value for value for value for string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When you upload you upload you upload you upload data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for successful successful successful successful ingestion. ingestion. ingestion. ingestion. Insights 414 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? region_id Required. When you Required. When you Required. When you Required. When you Not required ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the default default default default value for value for value for value for string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When you upload you upload you upload you upload data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for successful successful successful successful ingestion. ingestion. ingestion. ingestion. Insights 415 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? product_group_id Required. When you Required. When you Required. When you Required. When you Not required ingest data ingest data ingest data ingest data from SAP from SAP from SAP from SAP or EDI, the or EDI, the or EDI, the or EDI, the default default default default value for value for value for value for string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When you upload you upload you upload you upload data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or
|
supplychain-ug-107
|
supplychain-ug.pdf
| 107 |
the or EDI, the or EDI, the default default default default value for value for value for value for string is string is string is string is SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED. When DED. When DED. When DED. When you upload you upload you upload you upload data using the data using the data using the data using the Amazon S3 Amazon S3 Amazon S3 Amazon S3 connector connector connector connector , you must , you must , you must , you must enter a value or use enter a value or use enter a value or use enter a value or use SCN_RESER SCN_RESER SCN_RESER SCN_RESER VED_NO_VA VED_NO_VA VED_NO_VA VED_NO_VA LUE_PROVI LUE_PROVI LUE_PROVI LUE_PROVI DED for DED for DED for DED for successful successful successful successful ingestion. ingestion. ingestion. ingestion. Insights 416 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? company_id vendor_le ad_time vendor_tp artner_id product_id site_id planned_l ead_time eff_start_date eff_end_date Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required Not required ations? Not required Not required Not required Not required Not required Not required Not required Optional Required Required Required Required Optional Optional Insights 417 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? product_group_id Not required Not required Not required ations? Not required Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESER VED_NO_VA LUE_PROVI DED. When you upload data using the Amazon S3 connector , you must enter a value or use SCN_RESER VED_NO_VA LUE_PROVI DED for successful ingestion. Insights 418 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? region_id Not required Not required Not required ations? Not required Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESER VED_NO_VA LUE_PROVI DED. When you upload data using the Amazon S3 connector , you must enter a value or use SCN_RESER VED_NO_VA LUE_PROVI DED for successful ingestion. Insights 419 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? source_site_id Not required Not required Not required ations? Not required Optional. Site from where the inbound shipment originated. trans_mode Not required Not required Not required Not required Optional. Transport ation mode used. For example, ship, truck, rail. Insights 420 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? Required. Determine Required. Determine Required. Determine Required. Determine Not required s the s the s the s the outbound outbound outbound outbound shipment shipment shipment shipment ID. ID. ID. ID. Required. Determine Required. Determine Required. Determine Required. Determine Not required s the s the s the s the outbound outbound outbound outbound order ID. order ID. order ID. order ID. Required. Determine Required. Determine Required. Determine Required. Determine Not required s the s the s the s the product ID product ID product ID product ID shipped. shipped. shipped. shipped. Required. Determine s the site from where the units are shipped. Required. Determine s the site from where the units are shipped. Required. Determine s the site from where the units are shipped. Required. Determine s the site from where the units are shipped. Not required outbound_ id order_lin e Note This data cust_order_id entity is optional. Insights will product_id use the demand data from ship_from_site_id the forecast entity. If you ingest informati on for ship_to_site_id the outbound_ order_lin Optional. Site where the Optional. Site where the Optional. Site where the Optional. Site where the Not required products products products products Insights 421 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the
|
supplychain-ug-108
|
supplychain-ug.pdf
| 108 |
Required. Determine s the site from where the units are shipped. Required. Determine s the site from where the units are shipped. Not required outbound_ id order_lin e Note This data cust_order_id entity is optional. Insights will product_id use the demand data from ship_from_site_id the forecast entity. If you ingest informati on for ship_to_site_id the outbound_ order_lin Optional. Site where the Optional. Site where the Optional. Site where the Optional. Site where the Not required products products products products Insights 421 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? should be should be should be should be shipped. shipped. shipped. shipped. Optional. Final Optional. Final Optional. Final Optional. Final Not required e entity, make sure final_quantity_req uested the shipment informati on is also ingested quantity quantity quantity quantity after all updates and after all updates and after all updates and after all updates and cancellat cancellat cancellat cancellat ions. ions. ions. ions. for the quantity_ promised outbound_ shipment entity to gather quantity_ delivered the demand for the status correct dates. Required. Quantity Required. Quantity Required. Quantity Required. Quantity Not required agreed to be agreed to be agreed to be agreed to be delivered. delivered. delivered. delivered. Not required Not required Optional. Actual quantity delivered. Optional. Displays the status of the order line. For example, Optional. Actual quantity delivered. Optional. Displays the status of the order line. For example, Optional. Actual quantity delivered. Optional. Displays the status of the order line. For example, Optional. Actual quantity delivered. Optional. Displays the status of the order line. For example, canceled, canceled, canceled, canceled, Insights 422 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? open, open, open, open, closed, and so on. closed, and so on. closed, and so on. closed, and so on. Optional. Unit of measure for Optional. Unit of measure for Optional. Unit of measure for Optional. Unit of measure for quantity. quantity. quantity. quantity. For For For For example, example, example, example, eaches, cases. eaches, cases. eaches, cases. eaches, cases. Optional Optional Optional Optional Optional Optional Optional Optional Not required Not required Not required quantity_uom requested _delivery_date promised_ delivery_date Insights 423 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? outbound_ id shipment Required. Determine Required. Determine Required. Determine Required. Determine Not required Note This data entity from_site_id is optional. AWS Supply Chain will use product_id the demand data from the outbound_ order_lin e or cust_order_id forecast data entity. s the s the s the s the outbound outbound outbound outbound shipment shipment shipment shipment ID. ID. ID. ID. Required. Determine Required. Determine Required. Determine Required. Determine Not required s the site s the site s the site s the site from from from from where the where the where the where the units are units are units are units are shipped. shipped. shipped. shipped. Required. Determine Required. Determine Required. Determine Required. Determine Not required s the s the s the s the product product product product ID of the ID of the ID of the ID of the product shipped. product shipped. product shipped. product shipped. Required. Determine s the outbound order ID. Required. Determine s the outbound order ID. Required. Determine s the outbound order ID. Required. Determine s the outbound order ID. Not required Insights 424 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? cust_order_line_id Required. Determine Required. Determine Required. Determine Required. Determine Not required s the s the s the s the outbound outbound outbound outbound order line order line order line order line ID. ID. ID. ID. expected_ ship_date Required. Determine Required. Determine Required. Determine Required. Determine Not required s when the s when the s when the s when the products products products products exit the exit the exit the exit the from_site. from_site. from_site. from_site. actual_ship_date Optional. Determine Optional. Determine Optional. Determine Optional. Determine Not required shipped_qty s the s the s the s the actual date actual date actual date actual date when the when
|
supplychain-ug-109
|
supplychain-ug.pdf
| 109 |
Determine Required. Determine Not required s the s the s the s the outbound outbound outbound outbound order line order line order line order line ID. ID. ID. ID. expected_ ship_date Required. Determine Required. Determine Required. Determine Required. Determine Not required s when the s when the s when the s when the products products products products exit the exit the exit the exit the from_site. from_site. from_site. from_site. actual_ship_date Optional. Determine Optional. Determine Optional. Determine Optional. Determine Not required shipped_qty s the s the s the s the actual date actual date actual date actual date when the when the when the when the product product product product exits the exits the exits the exits the from_site. from_site. from_site. from_site. Required. Determine s the quantity shipped from the Required. Determine s the quantity shipped from the Required. Determine s the quantity shipped from the Required. Determine s the quantity shipped from the from_site. from_site. from_site. from_site. Not required Insights 425 AWS Supply Chain User Guide Column Data entity Is the column Is the column Is the column Is the column Is the column used for used for used for used for used for Inventory Network Inventory Rebalance Lead time visibility? map? Insights? recommend Insights? ations? cust_ship ment_status Optional. Status Optional. Status Optional. Status Optional. Status Not required of the of the of the of the shipment. shipment. shipment. shipment. For For For For example, example, example, example, canceled, canceled, canceled, canceled, open, open, open, open, closed, and closed, and closed, and closed, and so on. so on. so on. so on. to_site_id Optional. Site where Optional. Site where Optional. Site where Optional. Site where Not required products products products products should be should be should be should be shipped. shipped. shipped. shipped. Optional Optional Optional Optional Optional Optional Optional Optional Not required Not required expected_ delivery_date actual_de livery_date Insights 426 AWS Supply Chain User Guide Order Planning and Tracking Note To generate an order insight, in addition to ingesting the required data entities and columns, you must configure your milestone and process definitions. For more information on configuring orders, see Configuring Order Planning and Tracking for the first time. The table below lists the required data entities and columns to generate a order planning and Is the column used by Order Planning and Tracking? Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VA LUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VA LUE_PROVIDED for successful ingestion. tracking process. Data entity Column site id Note The site data entity columns not listed in this table are optional for order planning and tracking. AWS Order Planning and Tracking 427 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? Supply Chain highly recommend s ingesting data for the optional columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the Order Planning and Tracking 428 AWS Supply Chain User Guide Data entity Column process milestone s. Is the column used by Order Planning and Tracking? Order Planning and Tracking 429 AWS Supply Chain User Guide Data entity Column product id Is the column used by Order Planning and Tracking? Note The product data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional columns to Order Planning and Tracking 430 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 431 AWS Supply Chain User Guide Data entity Column vendor_pr oduct vendor_tpartner_id Is the column used by Order Planning and Tracking? product_id eff_start_date eff_end_date Note The vendor_pr oduct data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Order Planning and Tracking 432 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. geography id Required – This column is used by conditional filters to display regions or country. Order Planning and Tracking 433 AWS Supply Chain User Guide Data entity Column inbound_o rder id tpartner_id Is the column used by Order Planning and Tracking? Required Required Note The inbound_o rder data entity columns not listed in this table are optional for order planning
|
supplychain-ug-110
|
supplychain-ug.pdf
| 110 |
Data entity Column Is the column used by Order Planning and Tracking? columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. geography id Required – This column is used by conditional filters to display regions or country. Order Planning and Tracking 433 AWS Supply Chain User Guide Data entity Column inbound_o rder id tpartner_id Is the column used by Order Planning and Tracking? Required Required Note The inbound_o rder data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Order Planning and Tracking 434 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 435 AWS Supply Chain User Guide Is the column used by Order Planning and Tracking? Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VA LUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VA LUE_PROVIDED for successful ingestion. Data entity Column inbound_o rder_line id order_id tpartner_id product_id Note The inbound_o rder_line data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Order Planning and Tracking 436 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 437 AWS Supply Chain User Guide Data entity Column shipment id Is the column used by Order Planning and Tracking? supplier_tpartner_id product_id order_id order_line_id package_id Note The shipment data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional columns to Order Planning and Tracking 438 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 439 AWS Supply Chain User Guide Is the column used by Order Planning and Tracking? Required – This column is a required key for the reservati on_id column in the process_p roduct data entity. Required – This column is used when defining a default order plan. Required – This column is a required key for the reservati on_detail_id column in the process_product data entity. Data entity Column reservation reservation_id Note The reservati reservation_type on data entity columns reservation_detail_id not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional columns Order Planning and Tracking 440 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 441 AWS Supply Chain User Guide Is the column used by Order Planning and Tracking? Required Required – This column is used by the site_id column in the process_header data entity. For example, this column can be referenced in the milestone rules for specific processes. Required Required – This date is required to calculate the forecast completion date and to determine the Order line status. Data entity Column process_h eader process_id site_id Note The process_h eader data entity columns status required_on_site not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Order Planning and Tracking 442 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 443 AWS Supply Chain User Guide Data entity Column process_product_id process_p roduct Note The process_p process_id product_id reservation_id reservation_detail_id requested_availability_date roduct data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Is the column used by Order Planning and Tracking? Required – This column is part of the primary key in the process_product data entity
|
supplychain-ug-111
|
supplychain-ug.pdf
| 111 |
enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Order Planning and Tracking 443 AWS Supply Chain User Guide Data entity Column process_product_id process_p roduct Note The process_p process_id product_id reservation_id reservation_detail_id requested_availability_date roduct data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional Is the column used by Order Planning and Tracking? Required – This column is part of the primary key in the process_product data entity and is used as a reference in other entities. Required – This column is part of the primary key in the process_product data entity and is used to associate the header with the line. Required Required Required Required – The field is displayed as Required on site date in the AWS Supply Chain web application. This date is required to calculate the forecast completion date and to determine the Order line status. When you ingest data, you must enter a value for requested_availabi lity_date. When informati on is not available for the requested_availability_date column, order planning and tracking will use the column values from process_h eader > planned_start_date Order Planning and Tracking 444 AWS Supply Chain User Guide Is the column used by Order Planning and Tracking? to calculate the forecast completion date. Data entity Column columns to enhance the feature output. When data is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. work_orde r_plan process_id product_id business_process_id Required Required Required Order Planning and Tracking 445 AWS Supply Chain User Guide Data entity Column business_process_sequence preferred_source duration Is the column used by Order Planning and Tracking? Required Required Required – This column provides the process lead time to determine the target date of the process completio n. The following table describes the data entities that are not required to generate order planning and tracking. If these data entities are included in your dataset, the required columns are listed in the table below. Data entity Column trading_p artner id tpartner_type geo_id eff_start_date eff_end_date Is the column used by Order Planning and Tracking? Required – This column is used to link the trading partner. process_operation_id Required process_id process_o peration Note The process_o peration Order Planning and Tracking 446 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? data entity columns not listed in this table are optional for order planning and tracking. AWS Supply Chain highly recommend s ingesting data for the optional columns to enhance the feature output. When data Order Planning and Tracking 447 AWS Supply Chain User Guide Data entity Column Is the column used by Order Planning and Tracking? is ingested for the optional columns, you can use them to configure rules to evaluate the process milestone s. Demand Planning The following table lists the data entities and columns used by Demand Planning. How to read the table: • Required – The columns in this data entity are mandatory to execute a demand forecast without any failures. • Conditionally required – The columns in this data entity are required depending on the configurations set under demand plan settings. For more information, see Manage Demand Plan settings. • Recommended for forecast quality – The columns in this data entity are required for the quality for the forecast. Demand Planning 448 AWS Supply Chain User Guide • Optional – The column name is optional. For enhanced feature output, it is recommended to add the column name with values. Prequisites before uploading your dataset To successfully generate a forecast, make sure your dataset adheres to the following. • At least one product_id has a sales history of at least four times the forecast time horizon provided in the outbound_order_line dataset. For example, if the forecast time horizon is 26 weeks, the minimum order data requirement is 26*4 = 104 weeks. • Product_id under the product data entity should not contain any incomplete data (null or empty string) or duplicates. • All the additional columns selected for granularity in the forecast configuration (that are conditionally required ‘) does not contain incomplete data (null or empty string). • The column id across all data entities (for example, product_id, site_id, ship_from_site_id) does not contain special characters, such as asterisk (*) and double quotes (" "). • The order_date does not contain invalid date. For example, 2/29/2023, that is 29th February 2023 is only valid on a leap year. To improve forecast accuracy, Demand Planning highly recommends the following. • Upload two to three years of outbound order line history as input to generate an accurate forecast. This duration allows the forecasting models to capture your business
|
supplychain-ug-112
|
supplychain-ug.pdf
| 112 |
conditionally required ‘) does not contain incomplete data (null or empty string). • The column id across all data entities (for example, product_id, site_id, ship_from_site_id) does not contain special characters, such as asterisk (*) and double quotes (" "). • The order_date does not contain invalid date. For example, 2/29/2023, that is 29th February 2023 is only valid on a leap year. To improve forecast accuracy, Demand Planning highly recommends the following. • Upload two to three years of outbound order line history as input to generate an accurate forecast. This duration allows the forecasting models to capture your business cycles and ensure a more robust and reliable prediction. • For improved forecast accuracy, it is also recommended to include product attributes such as brand, color, product_group_id, product_introduction_day and discontinue_day in the product data entity. • You can provide additional demand drivers information through the supplementary_time_series data entity. Note, only numerical values are supported. • You provide alternate product mapping when you have similar products or previous version for a new product. • Remove any non-recurring or one-time event such as COVID before uploading the historical sales data. Prequisites before uploading your dataset 449 AWS Supply Chain User Guide Data mapping example for fulfillment Below is an example to map brick and mortar or online sales to outbound order line dataset and optimize the historical demand setup. Use this example to structure your data for accurate forecasting. Review the configurations in this example to make sure your forecasting models capture the different fulfillment scenarios. Note If the data fields ship_from_site_id, ship_to_site_id, and channel_id are selected for forecast granularity, make sure they have values or enter NULL as the value. The forecast will fail if the fields are blank. Data field Description Scenario 1 – Store sales (POS) Scenario 2 – E-commerce Scenario 3 – E-commerc demand fulfilled e demand by store fulfilled by ship_from _site_id Site at which inventory is managed Store ID Store ID ship_to_s ite_id Site that received the order Enter NULL to avoid forecast failure Country, Region, State, or Zip – as applicable online fulfillment center (direct to customer) Fulfillment Center ID External retailer sore ID, or Country, Region, State, or Zip – as applicable channel_i d Map how an item is sold Brick and mortar E-commerce E-commerce Data mapping example for fulfillment 450 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? Required outbound_ order_lin Demand Planning uses id Required e cust_order_id Required product_id Required this data as the primary source of historica l demand for forecast. Additionally, fields selected as granulari ty are sent for training and are available as filters to review the demand plan. order_date Required Required final_qua ntity_req uested How is this column used in Forecasti ng? id, cust_orde r_id, and product_i d are used to uniquely identify a record in the data entity and this combination should always be unique. Make sure the column values do not have invalid character s such as asterisk and double-quotes. Required for forecast creation. Identifies the period for time-series forecasting. Required for forecast creation. Data mapping example for fulfillment 451 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? How is this column used in Forecasti ng? Identifies the quantity used for time-seri es forecasti ng. This column must not contain null values and must be numerical . Make sure there are no commas in the values. For example, 500000.00 is an accepted value in Demand Planning. Data mapping example for fulfillment 452 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? ship_from _site_id Conditionally required ship_to_site_id Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension (Site Hierarchy ). This column must have a value and is used for filtering and analysis of data. For informati on on how to map data for different fulfillment scenarios, see Data mapping example for fulfillment. Data mapping example for fulfillment 453 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? channel_id Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension (Channel Hierarchy). This column must have a value and is used for filtering and analysis of data. For informati on on how to map data for different fulfillment scenarios, see Data mapping example for fulfillment. Data mapping example for fulfillment 454 AWS Supply Chain User Guide
|
supplychain-ug-113
|
supplychain-ug.pdf
| 113 |
for fulfillment 453 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? channel_id Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension (Channel Hierarchy). This column must have a value and is used for filtering and analysis of data. For informati on on how to map data for different fulfillment scenarios, see Data mapping example for fulfillment. Data mapping example for fulfillment 454 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? customer_ tpartner_id Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension (Customer Hierarchy). This column must have a value and is used for filtering and analysis of data. For informati on on how to map data for different fulfillment scenarios, see Data mapping example for fulfillment. Data mapping example for fulfillment 455 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? ship_to_s ite_addre ss_city ship_to_s ite_addre ss_state ship_to_s ite_addre ss_country Conditionally required Conditionally required Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension (Site Hierarchy ). This column must have a value and is used for filtering and analysis of data. For informati on on how to map data for different fulfillment scenarios, see Data mapping example for fulfillment. Data mapping example for fulfillment 456 AWS Supply Chain Data entity Is this data entity How is this data entity Column Is the column required? required? used? User Guide How is this column used in Forecasti ng? status Recommend ed for forecast This column is recommend quality product Required Demand Planning uses id Required the product attributes to establish hierarchy filters for demand plan review and for model training. ed for forecast quality. Orders with canceled status are not considered as forecast input. Required for data ingestion into Supply Chain Data Lake (SCDL). Make sure the column values do not have duplicate IDs and special characters such as asterix and double-qu otes. Data mapping example for fulfillment 457 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? description Required How is this column used in Forecasti ng? Required for data ingestion into Supply Chain Data Lake (SCDL). This column can contain special characters such as asterix, hyphen, quotes, and double-quotes. Data mapping example for fulfillment 458 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? parent_pr oduct_id product_g roup_id product_type brand_name color display_desc Conditionally required Conditionally required Conditionally required Conditionally required Conditionally required Conditionally required How is this column used in Forecasti ng? This column is condition ally required for forecast creation if the column is selected for forecast dimension s (Product Hierarchy). Make sure the column has values and is used for filtering and analysis of data and model training. Data mapping example for fulfillment 459 AWS Supply Chain Data entity Is this data entity How is this data entity Column Is the column required? required? used? User Guide How is this column used in Forecasti ng? product_a vailable_day Recommend ed for forecast Recommend ed. The value quality in this column improves forecast quality by allowing the forecasting model to consider the timing of new product introductions. discontin ue_day Recommend ed for forecast Recommend ed. The value quality in this column improves forecast quality by allowing the forecasti ng model to consider the timing for product retirements. Data mapping example for fulfillment 460 AWS Supply Chain Data entity Is this data entity How is this data entity Column Is the column required? required? used? User Guide How is this column used in Forecasti ng? base_uom Recommend ed for forecast Unit of measure quality for product. Default is Eaches. is_deleted Recommend ed for forecast Recommend ed. Enter Y if quality the product ID should be excluded from forecasting. pkg_height Recommend ed for forecast Recommend ed. The physical character istics of the product that the forecasti ng models can understand. pkg_length pkg_width shipping_ dimension casepack_size quality Recommend ed for forecast quality Recommend ed for forecast quality Recommend ed for forecast quality Recommend ed for forecast quality Data mapping example for fulfillment 461 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? product_a
|
supplychain-ug-114
|
supplychain-ug.pdf
| 114 |
product. Default is Eaches. is_deleted Recommend ed for forecast Recommend ed. Enter Y if quality the product ID should be excluded from forecasting. pkg_height Recommend ed for forecast Recommend ed. The physical character istics of the product that the forecasti ng models can understand. pkg_length pkg_width shipping_ dimension casepack_size quality Recommend ed for forecast quality Recommend ed for forecast quality Recommend ed for forecast quality Recommend ed for forecast quality Data mapping example for fulfillment 461 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? product_a lternate Recommend ed for forecast Demand Planning uses alternati ve_product_id Required quality the data of product’s predecessor(s) or alternate (s) to create forecast for new products. When data is ingested into the product_a lternate data entity, Product lineage support for forecast is enabled. For more information, see Product lineage. You can skip ingesting data into the product_a lternate data entity and the forecast can still be generated. product_id Required product_a lternate_id Required How is this column used in Forecasti ng? Required for data ingestion into Supply Chain Data Lake (SCDL). Unique record identifier. Required for data ingestion into Supply Chain Data Lake (SCDL). ID of the new product or new version of the product. Make sure product_id is populated in the product data entity. Required for data ingestion into SCDL. Identifier for a similar product or previous version of the product. To consider Data mapping example for fulfillment 462 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? alternate_type Required How is this column used in Forecasti ng? multiple similar products as a single product_i d, enter the products in separate rows. Make sure product_a lternate_id is populated in the product data entity. Required for applying product supercession or lineage. Use the static value similar_d emand_pro duct in all the rows. Data mapping example for fulfillment 463 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? alternate _product_qty Required How is this column used in Forecasti ng? Required for applying product supercession or lineage. Enter the proportion of history of the alternate _product_ id you want to use for forecasting product_id. For example, if it is 60%, enter 60. When you have multiple alternati ve_product_id for a single product_id, the alternate _product_qty does not have to add up to 100. Data mapping example for fulfillment 464 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? Required alternate _product_ qty_uom eff_start_date Required How is this column used in Forecasti ng? Required for applying product supercession or lineage. Use the specific static value "percentage". Required for data ingestion into SCDL. Enter the start timeframe to consider the history of a similar product. Make sure this date is on or before the eff_end_d ate or you can leave this field empty and Demand Planning will auto-fill the year with 1000. Data mapping example for fulfillment 465 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? eff_end_date Required status Recommend ed for forecast quality How is this column used in Forecasti ng? Required for data ingestion into SCDL. Enter the end timeframe to consider in history of a similar product. Make sure this date is on or after the eff_start _date or you can leave this field empty and Demand Planning will auto-fill the year with 9999.. Recommend ed. Enter Inactive to ignore the product supercession or lineage mapping. Data mapping example for fulfillment 466 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? supplemen tary_time Recommend ed for forecast Demand Planning uses id Required _series quality this data as the primary source for tagging casual factors such as promotion al events, discounts, holidays, and so on. order_date Required How is this column used in Forecasti ng? Required for data ingestion into Supply Chain Data Lake (SCDL). Unique record identifier. Required for data ingestion into Supply Chain Data Lake (SCDL). Timestamp when the timeseries was recorded. Data mapping example for fulfillment 467 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? time_seri es_name Required How is this column used in Forecasti ng? Required for data ingestion into Supply Chain Data Lake (SCDL). Name of the specific type of time series. The time_seri es_name column must start with a letter, be 2 to 56 characters long, and can contain letters, numbers,
|
supplychain-ug-115
|
supplychain-ug.pdf
| 115 |
Data Lake (SCDL). Unique record identifier. Required for data ingestion into Supply Chain Data Lake (SCDL). Timestamp when the timeseries was recorded. Data mapping example for fulfillment 467 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? time_seri es_name Required How is this column used in Forecasti ng? Required for data ingestion into Supply Chain Data Lake (SCDL). Name of the specific type of time series. The time_seri es_name column must start with a letter, be 2 to 56 characters long, and can contain letters, numbers, and underscor es. No other special characters are allowed. Data mapping example for fulfillment 468 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? time_seri es_value Required product_id Optional How is this column used in Forecasti ng? Required for data ingestion into SCDL. Value correspon ding to the specific time series. Demand Planning only supports numerical input and time-series with categoric al value is not considered. Recommend ed. Unique identifier for a specific product. Use this column if the demand driver is available at product level. Data mapping example for fulfillment 469 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? site_id Optional channel_id Optional How is this column used in Forecasti ng? Recommend ed. Unique identifier for a specific site or location. Use this column if the demand driver is available at site level. This column can represent either ship_from _site_id or ship_to_site_id based on the lowest level site hierarchy configuration. Recommend ed. Unique identifier for a specific channel. Use this column if the demand driver is available at channel level. Data mapping example for fulfillment 470 AWS Supply Chain User Guide Data entity Is this data entity How is this data entity Column Is the column required? required? used? customer_ tpartner_id Optional How is this column used in Forecasti ng? Recommend ed. Unique identifier for a specific customer. Use this column if the demand driver is available at customer level. Data mapping example for fulfillment 471 AWS Supply Chain User Guide Data entities supported in AWS Supply Chain The following is an overview of the data entities supported in AWS Supply Chain. Note The data entities listed in this chapter are required for Data Lake ingestion. For data entities required for each AWS Supply Chain module, see Data entities and columns used in AWS Supply Chain. For information on application datasets displayed in AWS Supply Chain Analytics, see Application datasets used in AWS Supply Chain Analytics. Category Category type Data entity and description Organization Non-trans actional data company - Entity to store the name and location of your company. Non-trans actional data geography - Entity stores geographical hierarchy of your company. Non-trans actional data trading_partner - Contains the partners that have trading relationship with your company, such as vendors, 3PLs, channel partners, or distributors. Non-trans actional data trading_partner_poc - Contains informati on that can be identified about the point of contacts at the partners such as vendors, 3PLs, channel partners, or distributors, that have trading relationship with your company. Product Non-trans actional data product - Contains the key product attribute s, including name, description, brand, codes, category, business group, and price. 472 AWS Supply Chain Category Category type Data entity and description Non-trans actional data product_hierarchy - Contains the product categories and sub-categories. Non-trans actional data product_uom - Contains the product packaging options and conversations between packages. Non-trans actional data product_alternate - Contains information about alternative products, including type of alternative. Non-trans actional data un_details - Contains information about hazardous products. Network Non-trans actional data site - Stores information for sites holding inventory such as Stores, Distribution Centers ,including ID, name, address, geographical region, and site type. Non-trans actional data transportation_lane - Contains information about transportation lanes, including from and to sites, transportation mode, and transit time. Vendor management Non-trans actional data vendor_product - Contains the product information per vendor, including price, lead- time, and inbound sites. Non-trans actional data vendor_lead_time - Contains the planned and actual lead times from the vendor. Non-trans actional data vendor_holiday - Displays information on vendor outages due to holidays and shutdowns. User Guide 473 AWS Supply Chain Category Category type Data entity and description User Guide Planning Non-trans actional data inv_policy - Contains inventory policies such as minimum and maximum safety stock policy, target inventory quantity, minimum or ma maximum order quantity and so on, for product, product-site, and other possible combinations. Non-trans actional data segmentation - Used to store segments. Segments are used in conjunction with product, site, and effective dates for uniqueness. For example, HV1 for High Value, HLW for Halloween Products,
|
supplychain-ug-116
|
supplychain-ug.pdf
| 116 |
the vendor. Non-trans actional data vendor_holiday - Displays information on vendor outages due to holidays and shutdowns. User Guide 473 AWS Supply Chain Category Category type Data entity and description User Guide Planning Non-trans actional data inv_policy - Contains inventory policies such as minimum and maximum safety stock policy, target inventory quantity, minimum or ma maximum order quantity and so on, for product, product-site, and other possible combinations. Non-trans actional data segmentation - Used to store segments. Segments are used in conjunction with product, site, and effective dates for uniqueness. For example, HV1 for High Value, HLW for Halloween Products, seasonal, volatile and so on. Non-trans actional data sourcing_rules - Defines rules at product-site level to specify the sourcing related attribute s (for example, rule type, to and from site, transportation lane, minimum and maximum quantity, priority, ratio, and so on). Non-trans actional data sourcing_schedule - Sourcing schedule determines when to source. For example, source from vendors or transfer between sites. Non-trans actional data sourcing_schedule_details - Provides sourcing schedule details. For example, the days in a week, a product be sourced from a vendor. Transactional data reservation - Provides details about inventory reservation. For example, reservation ID, type, date, quantity, product ID. Transactional data product_bom - Displays bill of material for product with type, level, ratios, quantities, and cost attributes. 474 AWS Supply Chain Category Category type Data entity and description User Guide Operation Transactional data process_header - Track execution activities within a plant or site. For example, manufactu ring, maintenance or repairs. Transactional data process_operation - Defines operation associated with an activity. For example, Stop machine, Oiling, and so on. Transactional data process_product - Define the product or material associated with an activity. Transactional data production_process - Defines attribute s associated with the manufacturing or production process. Inventory Management Transactional data inv_level - A snapshot of the product’s inventory condition in each site. For example, snapshot date, on-hand inventory, condition of the product. Inbound Transactional data inbound_order - Contains information about inbound orders into your companies locations . For example, for example, purchase orders (POs), blanket POs, production orders, or stock transfer orders). Transactional data inbound_order_line - Stores line level information for inbound_order, including product_id, and quantity. Transactional data inbound_order_line_schedule - Stores schedule-line level data within an inbound_o rder_line and is relevant only when schedules are used. 475 AWS Supply Chain Category Category type Data entity and description Transactional data shipment - Stores shipment information like origin, carrier code, ship date, product, quantity, ship from site, expected delivery date, and actual delivery date, or inbound orders (PO,TO and so on) including ship date, product, quantity, ship from site, expected delivery date, and actual delivery date. Transactional data shipment_stop - Contains list of shipment stops with corresponding date and time. This field is used when there are multiple stops for shipments. Transactional data shipment_stop_order - Contains list of orders picked and dropped per shipment stop. Transactional data shipment_lot - Contains the shipment details per shipment lot. Outbound fulfillment Transactional data outbound_order_line - Contains orders originating from your company and shipped to locations outside of the your network. Outbound_order_line contains order date, customer location, incoterms, and so on. It also includes product, price, discount, and units. outbound_shipment - Stores shipment information for outbound orders, including ship date, product, quantity, ship from site, expected delivery date, and actual delivery date. Transactional data User Guide 476 AWS Supply Chain Category Category type Data entity and description User Guide Cost management Transactional data customer_cost - Displays the information about the costs incurred by you during the supply chain operations. Plan Transactional data supply_plan - Displays the supply plan generated by AWS Supply Chain Supply Planning. Forecast Transactional data forecast - Stores forecast over forecast horizon for product, product-site, or other combinati ons. Transactional data supplementary_time_series - Displays additional demand driver time series informati on such as price, promotions, and out-of-stock indicator to improve forecast quality. Reference Non-trans actional data reference_field - Contains mapping of any entity-field-value combination to a correspon ding description, such as mapping specific inbound_order status code to status descripti on. Non-trans actional data calendar - Calendars can be used for many purposes by the application, such as planning, execution, and reporting. Non-trans actional data uom_conversion - Contains conversions for unit of measure (UOM). Insights Transactional data work_order_plan - Provides the supply chain process plan for a work order along with source type and duration to finish each supply chain process. 477 AWS Supply Chain Note User Guide • All fields marked as type timestamp should be in ISO 8601 format. • The dataset that you ingest into AWS Supply Chain can only include the following special characters: ASCII 35 (number sign: #), 36 (dollar sign: $), 37 (percent sign: %), 45 (hyphen: -), 46 (period: .), 47 (slash: /), 94 (caret),
|
supplychain-ug-117
|
supplychain-ug.pdf
| 117 |
Non-trans actional data uom_conversion - Contains conversions for unit of measure (UOM). Insights Transactional data work_order_plan - Provides the supply chain process plan for a work order along with source type and duration to finish each supply chain process. 477 AWS Supply Chain Note User Guide • All fields marked as type timestamp should be in ISO 8601 format. • The dataset that you ingest into AWS Supply Chain can only include the following special characters: ASCII 35 (number sign: #), 36 (dollar sign: $), 37 (percent sign: %), 45 (hyphen: -), 46 (period: .), 47 (slash: /), 94 (caret), 95 (underscore: _), 123 (left curly brace: { ), and 125 (right curly brace: }). Organization This section lists the data entities within the organization category. Topics • company • geography • trading_partner • trading_partner_poc company Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name company Column id The table below lists the column names supported by the data entity. Column Data type Required Description id string Yes ID of the company. Organization 478 AWS Supply Chain User Guide Column Data type Required Description description string address_1 address_2 address_3 city string string string string state_prov string postal_code string country string phone_number string time_zone string calendar_id 1 string source string source_event_id string No No No No No No No No No No No No No Description of the company. Company address. Company address. Company address. City where the company is located. State where the company is located. Postal code of the company address. Country where the company is located. Company's contact number. Company's local time zone. Default calendar that the company uses for planning. Source of data. ID of the event created in the source system. company 479 AWS Supply Chain User Guide Column Data type Required Description source_update_dttm timestamp No Date time stamp of the update made in the source system. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column calendar_id Reference calendar calendar_id geography Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name geography Column id The table below lists the column names supported by the data entity: Column id Data type Required Description string Yes Geographical ID. Referred to by other entities as geo_id or region_id. geography 480 AWS Supply Chain Column description company_id 1 parent_geo_id 1 address_1 address_2 address_3 city state_prov postal_code Data type Required Description User Guide string string string string string string string string string No No No No No No No No No Geographical location. Company ID. Stores parent geographical ID for this record. If blank, this is a top level region in the company. City correspon ding to this geo- region. City correspon ding to this geo- region. City correspon ding to this geo- region. Displays the city corresponding to this geo-regio n. State correspon ding to this geo- region. Postal code corresponding to this geo-regio n. geography 481 Data type Required Description User Guide AWS Supply Chain Column country phone_number time_zone source source_event_id string No string string string string No No No No source_update_dttm timestamp No Country corresponding to this geo-regio n. Company's contact number. Company local time zone. Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1 Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company parent_geo_id Organization geography id id geography 482 AWS Supply Chain trading_partner Primary key (PK) User Guide The table below lists the column names that are uniquely identified in the data entity. Name trading_partner Column id, tpartner_type, geo_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Column Data type Required Description id string Yes description string company_id 2 string tpartner_type string geo_id 2 string eff_start_date timestamp No No Yes1 Yes1 Yes1 Partner ID. Referred to by other entities as tpartner_ id unless explicitly stated otherwise. Description of the trading partner. Company ID. Type of partner, for example, vendor, channel partner, or 3PL. Region of the company associated with the trading partner. The start timestamp of the relationship between the trading partner and the company. trading_partner 483 AWS Supply Chain User Guide Column Data type Required Description eff_end_date timestamp Yes1 is_active string address_1 string address_2 string address_3 string city string state_prov string postal_code string country string phone_number string time_zone string latitude double No No No No No No No No No No No The end timestamp of the relationship between the trading partner and the company. Indicates whether trading partner is active or inactive. The address corresponding to the
|
supplychain-ug-118
|
supplychain-ug.pdf
| 118 |
channel partner, or 3PL. Region of the company associated with the trading partner. The start timestamp of the relationship between the trading partner and the company. trading_partner 483 AWS Supply Chain User Guide Column Data type Required Description eff_end_date timestamp Yes1 is_active string address_1 string address_2 string address_3 string city string state_prov string postal_code string country string phone_number string time_zone string latitude double No No No No No No No No No No No The end timestamp of the relationship between the trading partner and the company. Indicates whether trading partner is active or inactive. The address corresponding to the trading partner. The address corresponding to the trading partner. The address corresponding to the trading partner. The city corresponding to the trading partner. The state corresponding to the trading partner. The postal code of the trading partner. The country corresponding to the trading partner. The trading partner's contact phone number. The trading partner's local time zone. Latitude of trading partner location. trading_partner 484 AWS Supply Chain User Guide Column Data type Required Description longitude double os_id string duns_number string source string source_event_id string source_up date_dttm timestamp No No No No No No Longitude of trading partner location. Organizational identifier issued by Open Supplier Hub. Unique nine-digit identific ation number provided by Dun and Bradstreet (D and B). Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED; and the default value for timestamp is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company geo_id Organization geography id id trading_partner 485 AWS Supply Chain trading_partner_poc Primary key (PK) User Guide The table below lists the column names that are uniquely identified in the data entity. Name Column trading_partner_poc tpartner_id, email The table below lists the column names supported by the data entity: Column Data type Required Description tpartner_id 1 string email string poc_first_name string poc_last_name string poc_org_u nit_name poc_org_u nit_description string string source string source_event_id string Yes Yes No No No No No No Partner ID. Referred to by other entities as tpartner_ id unless explicitly stated otherwise. Partner's email ID. Partner's first name. Partner's last name. Name of the team or internal organizational unit. AWS profile or descripti on of the team's role in an organization to be shared with the customer to describe their team. Source of data. ID of the event created in the source system. trading_partner_poc 486 AWS Supply Chain User Guide Column Data type Required Description source_up date_dttm timestamp No Date time stamp of the update made in the source system. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column tpartner_id Organization trading_partner id Product This section lists the data entities within the product category. Topics • product • product_hierarchy • product_uom • product_alternate • un_details product Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name product Product Column id 487 AWS Supply Chain User Guide The table below lists the column names supported by the data entity: Column id Data type Required Description string Yes description string Yes company_id1 product_group_id1 string string No No product_type string No hts_code string No Displays the product ID. Referred to by other entities as product_id. Displays the descripti on of the product. Displays the company ID. Displays the product group ID that this product belongs to. Type of product, for example, finished good, component , service, or packaging. Harmonize d Tariff Schedule code. product 488 AWS Supply Chain Column is_hazmat Data type Required Description User Guide string No is_flammable string No is_special_handling string No is_perishable string No is_digital string No is_deleted string No Displays whether product is Hazmat compliant. Indicator of whether the product is flammable or not. Displays if the product requires special handling. Displays if the product is perishable. Displays if the product is digital. Indicates whether product is deleted ("true") or active ("false"). product 489 AWS Supply Chain Column Data type Required Description User Guide is_lot_controlled string No is_expiry_controlled string No creation_date timestamp No brand_name parent_product_id1 string string No No display_desc string No Indicates if the product is a lot- controlled product. Indicates if the product is an expiry-date controlled product. Product launch or release date. Product brand name. If the product is part of a bundle, lists the ID of the parent product. External facing descripti on of the product. product 490 AWS Supply Chain Column Data type Required Description User Guide discontinue_day timestamp
|
supplychain-ug-119
|
supplychain-ug.pdf
| 119 |
whether product is deleted ("true") or active ("false"). product 489 AWS Supply Chain Column Data type Required Description User Guide is_lot_controlled string No is_expiry_controlled string No creation_date timestamp No brand_name parent_product_id1 string string No No display_desc string No Indicates if the product is a lot- controlled product. Indicates if the product is an expiry-date controlled product. Product launch or release date. Product brand name. If the product is part of a bundle, lists the ID of the parent product. External facing descripti on of the product. product 490 AWS Supply Chain Column Data type Required Description User Guide discontinue_day timestamp No base_uom string No unit_cost double No unit_price double No inventory_holding_cost double No Date when the product was discontin ued. Unit of measure for product. Default is Eaches. Average unit cost of the product. Measured in currency_ uom per base_uom. Unit price, standard price, or MSRP of the product. Average yearly holding cost of the product. product 491 AWS Supply Chain Column Data type Required Description User Guide currency_uom string No product_available_day timestamp No shipping_weight double No shipping_dimension double No unit_volume double No pkg_length double No Currency unit of measure for the price and other economic variables of this product. Date when the product is available for fulfillme nt. Default weight to be used by the carrier. Dimensional weight to be used by the carrier. Volume of product per base_uom. Packaged length of the individual product. product 492 AWS Supply Chain Column pkg_width Data type Required Description User Guide double No pkg_height double No weight_uom string No dim_uom string No volume_uom diameter color casepack_size string double string int No No No No Packaged width of the individual product. Packaged height of the individual product. Unit of measure for product's weight. Unit of measure for product's dimensions. Product volume. Diameter of an individual product. Product color Number of products in each casepack. product 493 AWS Supply Chain Column gtin Data type Required Description User Guide string No Global Trade Item Number (GTIN). 14- digit number that includes various EAN/UCC numbering structures and is used to uniquely identify a product. Long Term Horizon time window used to determine salvage value. UOM for Long Term Horizon time window used to determine salvage value. Product cost expected to recover at the end of Long Term Horizon. long_term_horizon double No long_term_horizon_uom string No salvage_value_percentage double No product 494 AWS Supply Chain Column Data type Required Description User Guide sap_0material_attr__prdha string No shelf_life double No Product hierarchy . Predicate key for SAP mapping. Upsert key for T179. Duration for which a product can be stored or kept fresh and safe for consumption or use before it spoils or expires. This information is crucial for managing inventory levels, determini ng reorder points, and ensuring that products are sold or consumed before their expiration dates. product 495 AWS Supply Chain Column Data type Required Description User Guide shelf_life_uom string No un_id string No demand_planning_enabled string No Unit of measure of the shelf life. UN IDs are four-digi t numbers that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substance s, and so on.) in the framework of international transport. If this field is populated then the is_hazmat flag must be true. Identifies parts used for demand planning. product 496 AWS Supply Chain Column Data type Required Description User Guide inventory_planning_enabled string No mrp_enabled string No purchased_item string No Identifies parts used for inventory planning. Identifie s parts enabled for planning in MRP. Identifies parts that are purchased. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_group_id Product product_hierarchy parent_product_id Product product id id id un_id Product un_details un_id product_hierarchy Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. product_hierarchy 497 AWS Supply Chain Name product_hierarchy Column id User Guide The table below lists the column names supported by the data entity: Data type Required Description Column id description company_id1 parent_product_group_id1 string string string string Yes No No No creation_date timestamp No update_date timestamp No product_hierarchy 498 Product group ID. Descripti on of the product group. Company ID. Parent of this product group. If null, it indicates this record is a top level product group. Date when the product group was created. Date when the product group was updated. AWS Supply Chain Column source 1Foreign key Foreign key (FK) User Guide Data type Required Description string No Source of data. The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company parent_product_gro up_id Product product_hierarchy id id product_uom Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name product_bom Column product_uom_id, eff_start_date,
|
supplychain-ug-120
|
supplychain-ug.pdf
| 120 |
of this product group. If null, it indicates this record is a top level product group. Date when the product group was created. Date when the product group was updated. AWS Supply Chain Column source 1Foreign key Foreign key (FK) User Guide Data type Required Description string No Source of data. The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company parent_product_gro up_id Product product_hierarchy id id product_uom Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name product_bom Column product_uom_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Column Data type Required Description product_uom_id string Yes product_uom ID for product unit of measureme 499 AWS Supply Chain Column Data type Required Description User Guide product_id string Yes uom description company_id 1 price cost string string string double Yes No No No double No currency_uom string No status string No nt (UOM) combination. Product associate d with product-uom combination. UOM identifier. Description of product-u om. Company ID. Price of product-u om. Cost of product-u om. Unit of measure (UOM) of currency. Status of record. For example, Active, Inactive and so on. product_uom 500 AWS Supply Chain Column is_standard barcode_type barcode_value type Data type Required Description User Guide string No string string string No No No quantity double No quantity_uom string No length width double double No No Describe if this is a standard product-u om. Type of barcode. Value of barcode. Type of product-u om. Displays the quantity for one product uom ID in terms of base UOM for the product. Unit of measure (UOM) of quantity in base UOM. Length of the package. Width of the package. product_uom 501 AWS Supply Chain Column height dimension_uom volume volume_uom weight weight_uom Data type Required Description User Guide double string double string double string No No No No No No Height of the package. Unit of measure (UOM) of dimension. Volume of the package. Unit of measure (UOM) of volume. Package weight. Unit of measure (UOM) of weight. Displays the date and time the record becomes effective. Displays the date and time the record ends. eff_start_date timestamp Yes eff_end_date timestamp Yes product_uom 502 AWS Supply Chain Column source 1Foreign key Foreign key (FK) User Guide Data type Required Description string No Source of data. The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company id product_alternate Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name product_alternate Note Column product_alternate_id, eff_start_date, eff_end_date To avoid data ingestion failure, you must enter a value for eff_start_date and eff_end_date. The table below lists the column names supported by the data entity: product_alternate 503 AWS Supply Chain User Guide Column name Data type Required Description product_alternate_id string Yes product_id 2 alternative_product_id site_id alternate_type company_id 2 priority string string string string string int Yes Yes No No No No alternate_group_id string No Unique identifier for a record. Product ID. Alternate product ID. Site ID. Alternate product type. For example, similar_d emand_val ue. Company ID. Priority or rank of alternatives. Used to group interchan geable alternate products. Note, this field does not correspond to product_g roup in product_alternate 504 AWS Supply Chain Column name Data type Required Description User Guide status string No alternate_product_qty double No alternate_product_qty_uom string No eff_start_date timestamp Yes product_h ierarchy. Status of the alternate product record. For example, Active, Inactive. Quantity of the alternate product. The conversion is done per base_UOM of primary product. Unit of measure (UOM) of alternati ve product quantity. Displays the date and time the record becomes effective. product_alternate 505 AWS Supply Chain Column name eff_end_date source source_event_id Data type Required Description User Guide timestamp Yes string string No No Displays the date and time the record ends. Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. source_update_dttm timestamp No 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column product_id Product product company_id Organization company id id product_alternate 506 AWS Supply Chain un_details Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name product_un_details Column un_id The table below lists the column names supported by the data entity: Column name un_class Data type Required Description string No Hazardous material categorie s and subcatego ries. One of nine classes of hazardous materials (as of 2024). Image of the symbol for the hazmat
|
supplychain-ug-121
|
supplychain-ug.pdf
| 121 |
(FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column product_id Product product company_id Organization company id id product_alternate 506 AWS Supply Chain un_details Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name product_un_details Column un_id The table below lists the column names supported by the data entity: Column name un_class Data type Required Description string No Hazardous material categorie s and subcatego ries. One of nine classes of hazardous materials (as of 2024). Image of the symbol for the hazmat class. Descripti on of the UN Proper Shipping Name. hazmat_class string No image_url string No un_description string No un_details 507 AWS Supply Chain Column name un_id Data type Required Description User Guide string Yes UN IDs are four-digi t numbers that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substance s, and so on.) in the framework of international transport. Network This section lists the data entities within the network category. Topics • site • transportation_lane site Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Network 508 AWS Supply Chain Name site Column id User Guide The table below lists the column names supported by the data entity: Column Data type Required Description id description company_id1 geo_id1 address_1 address_2 address_3 city string string string string string string string string state_prov string postal_code string country string Yes No No No No No No No No No No Site ID. Description of the site. Company ID. If the site belongs to a geography, displays the ID of the geographical hierarchy. Site address. Site address. Site address. City in which the site is located. State where the site is located. Postal code of the site. Country where the site is located. site 509 AWS Supply Chain User Guide Column Data type Required Description phone_number string email string time_zone string site_type string unlocode string latitude double longitude double is_active string site_calendar_id1 string site_classifier string No No No No No No No No No No Contact number of the site. Point of contacts email information. Local time zone of the site. Type of site, for example, warehouse , delivery station, factory, store, and so on. Standardized UN/ LOCODE for the site. Latitude of the site location. Longitude of the site location. Indicates whether site is active ("true") or deleted ("false") Site's operating and holiday calendar. Information about site classification. For example, if a store is "high foot fall store" or if DC is Central DC vs Regional DC. site 510 AWS Supply Chain User Guide Column Data type Required Description open_date timestamp end_date timestamp source string source_event_id string source_update_dttm timestamp No No No No No Date when the site started operations. Date when the site discontinued operational perspecti ve. Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company geo_id Organization geography id id site_calendar_id Reference calendar calendar_id transportation_lane Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. transportation_lane 511 AWS Supply Chain Name transportation_lane User Guide Column id, from_site_id, to_site_id, from_geo_id, to_geo_id, carrier_tpartner_id, trans_mode, service_type, product_group_id The table below lists the column names supported by the data entity: Column id from_site_id2 Data type Required Description string string Yes Yes1 to_site_id2 string Yes1 company_id2 from_geo_id2 string string No Yes1 Lane ID. Origin site location for the lane. You can exclude this field if the from_geo_ id is populated. Destination site location for the lane. You can exclude this field if the to_geo_id is populated. Company ID. When lane definition is at geographical level, displays the 'from' or 'source' geographical region. transportation_lane 512 AWS Supply Chain Column to_geo_id2 Data type Required Description User Guide string Yes1 carrier_tpartner_id2 trans_mode string string Yes1 Yes1 service_type string Yes1 product_group_id2 string Yes1 product_id2 string No transit_time double No When lane definition is at geographi cal level, displays the 'to' or 'source' geographical region. ID of the carrier. Transportation mode, for example, ship, rail, or truck. Provides information on the shipping method for the carrier. Product group ID if transit time varies by product group. Product ID is used when a lane has product-specific configuration. Transit time of products. transportation_lane 513 AWS Supply Chain Column Data type Required Description User Guide transit_time_sd double No time_uom distance string double distance_uom string No No No eff_start_date timestamp No eff_end_date timestamp No daily_start_time string daily_end_time string open_sun string No No No Standard deviation of transit time. Unit of measure of transit time. Distance
|
supplychain-ug-122
|
supplychain-ug.pdf
| 122 |
or 'source' geographical region. ID of the carrier. Transportation mode, for example, ship, rail, or truck. Provides information on the shipping method for the carrier. Product group ID if transit time varies by product group. Product ID is used when a lane has product-specific configuration. Transit time of products. transportation_lane 513 AWS Supply Chain Column Data type Required Description User Guide transit_time_sd double No time_uom distance string double distance_uom string No No No eff_start_date timestamp No eff_end_date timestamp No daily_start_time string daily_end_time string open_sun string No No No Standard deviation of transit time. Unit of measure of transit time. Distance traveled on the lane. Unit of measure (UOM) of distance. Date and time when this record becomes effective. Date and time till when this record becomes effective. Time when the lane begins operating. Time when the lane ends operation. Displays whether the lane is open on Sunday. transportation_lane 514 AWS Supply Chain Column open_mon Data type Required Description User Guide string No open_tue string No open_wed string No open_thu string No open_fri string No open_sat string No cost_per_unit cost_per_weight double double No No Displays whether the lane is open on Monday. Displays whether the lane is open on Tuesday. Displays whether the lane is open on Wednesday. Displays whether the lane is open on Thursday. Displays whether the lane is open on Thursday. Displays whether the lane is open on Saturday. Cost per distance UOM. Cost per weight UOM. transportation_lane 515 AWS Supply Chain Column cost_currency weight_uom Data type Required Description User Guide string string No No emissions_per_unit double No emissions_per_weight double No source transportation_cost string double No No transportation_cost_uom string No source_event_id string No source_update_dttm timestamp No Currency UOM of costs. Unit of measurement for weight. Carbon emissions emitted per unit distance UOM. Carbon emissions emitted per weight UOM. Source of data. Transportation cost related to the transport lane. Transportation cost UOM related to the transport lane. ID of the event created in the source system. Date time stamp of the update made in the source system. transportation_lane 516 AWS Supply Chain User Guide 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is: SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column from_site_id, to_site_id Category Network FK/Data entity FK/Column site id id id id id id company_id Organization company from_geo_id, to_geo_id Organization geography carrier_tpartner_id Organization trading_partner product_group_id Product product_hierarchy product_id Product product_id Vendor management This section lists the data entities within the vendor management category. Topics • vendor_product • vendor_lead_time • vendor_holiday vendor_product Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Vendor management 517 AWS Supply Chain Name vendor_product User Guide Column vendor_tpartner_id, product_id, eff_start _date, eff_end_date The table below lists the column names supported by the data entity: Data type Required Description Column company_id2 vendor_tpartner_id2 product_id2 vendor_product_code string string string string No Yes Yes No vendor_product_desc string No vendor_cost double No vendor_cost_uom string No Company ID. Trading partner ID of the vendor. Product ID. Product identifier used by the vendor. Product description used by the vendor. Cost of product from this vendor. Unit of measure (UOM) of the product cost from this vendor. vendor_product 518 AWS Supply Chain Column status Data type Required Description User Guide string No unit_volume double No volume_uom string No unit_weight double No weight_uom string No release_date timestamp No Status of the product, for example, new product (NP), and obsolete (OB). Volume of one unit of product. Unit of measure (UOM) for volume. Weight of one unit of product. Weight unit of measureme nt for weight. Date when the product was released by the vendor. vendor_product 519 AWS Supply Chain Column end_date Data type Required Description User Guide timestamp No eff_start_date timestamp Yes1 eff_end_date timestamp Yes1 min_order_unit double No country_of_origin string No Date when the vendor stopped supplying the product. Displays the date and time from when the vendor's product is active. Displays the date and time till when the vendor's product will be active. Minimum order quantity for a product from this vendor. Country of origin by product. vendor_product 520 AWS Supply Chain Column Data type Required Description User Guide sap_eina__infnr string No sap_eine__ebeln string No sap_eine__ebelp string No max_order_unit double No source string No Record on number of purchases . Predicate key for SAP mapping. Upsert key for EINE. Purchasing Document Number. Predicate key for SAP mapping. Upsert key for EKPO. Item Number of Purchasin g Document. Predicate key for SAP mapping. Upsert key for EKPO. Maximum order quantity for the vendor. Source of data. vendor_product 521 AWS Supply Chain Column Data type Required Description User Guide source_event_id string No source_update_dttm timestamp No ID of the event created in the source system. Date
|
supplychain-ug-123
|
supplychain-ug.pdf
| 123 |
Data type Required Description User Guide sap_eina__infnr string No sap_eine__ebeln string No sap_eine__ebelp string No max_order_unit double No source string No Record on number of purchases . Predicate key for SAP mapping. Upsert key for EINE. Purchasing Document Number. Predicate key for SAP mapping. Upsert key for EKPO. Item Number of Purchasin g Document. Predicate key for SAP mapping. Upsert key for EKPO. Maximum order quantity for the vendor. Source of data. vendor_product 521 AWS Supply Chain Column Data type Required Description User Guide source_event_id string No source_update_dttm timestamp No ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for timestamp date type value is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company vendor_tpartner_id Organization trading_partner product_id Product product_id id id id vendor_lead_time Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. vendor_lead_time 522 AWS Supply Chain Name vendor_lead_time User Guide Column vendor_tpartner_id, product_id, product_g roup_id, site_id, region_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Data type Required Description Column company_id2 vendor_tpartner_id2 product_id2 product_group_id2 site_id2 region_id2 string string string string string string No Yes Yes1 Yes1 Yes1 Yes1 planned_lead_time double No Company ID. Trading partner ID of the vendor. Product ID. Used if lead time is set at product- group level. Site where this product is being supplied. Used if lead time is set at geographical region level. Site level values will override this value. Planned lead time from vendor into company's site. vendor_lead_time 523 AWS Supply Chain Column Data type Required Description User Guide planned_lead_time_dev double No actual_lead_time_mean double No actual_lead_time_sd double No actual_p50 double No actual_p90 double No shipping_cost double No cost_uom string No Standard deviation of lead time. Field to store actual lead time computed from transactional data. Standard deviation of actual lead time. 50th percentil e of actual lead time. 90th percentil e of actual lead time. Inbound shipping cost from vendor to company. Unit of measure of shipping cost. vendor_lead_time 524 AWS Supply Chain Column we_pay Data type Required Description User Guide string No eff_start_date timestamp Yes1 eff_end_date timestamp Yes1 sap_eina__infnr string No source_site_id 2 string No trans_mode string No Yes or No indicator. Yes if company pays for inbound shipping, and No if vendor pays for shipping. Date and time from when this record is effective. Date and time till when this record is effective. Record on number of purchases. Predicate key for SAP mapping. Upsert key for EINE. Site from where the inbound shipment is originated. Transportation mode. For example, ship, water, truck, or rail. vendor_lead_time 525 AWS Supply Chain Column source source_event_id Data type Required Description User Guide string string No No source_update_dttm timestamp No Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for string and timestamp date type values are SCN_RESERVED_NO_VALUE_PROVIDED for string; and for timestamp, 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column site_id Category Network source_site_id Network site site FK/Data entity FK/Column company_id Organization company region_id Organization geography vendor_tpartner_id Organization trading_partner product_group_id Product product_hierarchy product_id Product product_id id id id id id id id vendor_lead_time 526 AWS Supply Chain vendor_holiday Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name vendor_holiday Column vendor_tpartner_id, outage_start_date, outage_end_date The table below lists the column names supported by the data entity: Column Data type Required Description company_id2 string vendor_tpartner_id2 string outage_start_date timestamp outage_end_date timestamp outage_type comment string string No Yes Yes1 Yes1 No No Company ID. Trading partner ID of the vendor. Outage start date. Outage end date. Type of outage. Comment from the vendor. 1You must enter a value. When you ingest data from SAP or EDI, the default value for timestamp date type value is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: vendor_holiday 527 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column company_id Organization company vendor_tpartner_id Organization trading_partner id id Planning This section lists the data entities within the planning category. Topics • product_bom • inv_policy • segmentation • sourcing_rules • sourcing_schedule • sourcing_schedule_details
|
supplychain-ug-124
|
supplychain-ug.pdf
| 124 |
Comment from the vendor. 1You must enter a value. When you ingest data from SAP or EDI, the default value for timestamp date type value is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: vendor_holiday 527 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column company_id Organization company vendor_tpartner_id Organization trading_partner id id Planning This section lists the data entities within the planning category. Topics • product_bom • inv_policy • segmentation • sourcing_rules • sourcing_schedule • sourcing_schedule_details • reservation • supply_planning_parameters product_bom Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name product_bom Column id, product_id, component_product_id The table below lists the column names supported by the data entity: Planning 528 AWS Supply Chain User Guide column Data type Required Description id product_id 2 site_id 2 company_id2 string string string string level int component_product_ id string Yes Yes No No No Yes 1 component_quantity _per double Yes component_quantity _uom string component_line_num ber int lifecycle_phase string assembly_cost double No No No No Displays the BOM ID. Product for which the BOM is defined. Site for which the BOM is defined. Displays the company ID. Displays the level of the BOM in multi-lev el BOM. Displays the component's product ID. Quantity of component required to produce one unit of parent product. Unit of measurement of the component. Line ID of the child record. Information about the life cycle phase associated with the BOM. UOM of the product. product_bom 529 AWS Supply Chain User Guide column Data type Required Description assembly_cost_uom string eff_start_date timestamp eff_end_date timestamp description production_process _id string string alternative_produc t_id string priority string alternate_group_id string alternate_product_ qty double alternate_product_ qty_uom string ratio double No No No No No No1 No No No No No Assembly cost of the product. Dates from when the record is effective. Dates till when the record is effective. BOM description. ID associated with a specific production process. ID of the alternate product used in the BOM. Priority of the product or components used in the BOM. ID of the alternate product group. Quantity of the alternate product used in the BOM. UOM associated with the quantity of the alternate product. Ratio of the products in the BOM. product_bom 530 AWS Supply Chain User Guide column Data type Required Description creation_date timestamp change_date timestamp source string source_event_id string source_update_dttm timestamp No1 No1 No No No Date when the BOM was created. Date when the BOM was updated. Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for string and timestamp date type values are: SCN_RESERVED_NO_VALUE_PROVIDED for string; and for timestamp , 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company product_id site_id Product Network product site id id id production_process _id Operation production_process production_process _id product_bom 531 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column Product product_alternate product_alternate_id alternative_produc t_id inv_policy Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name inv_policy Column id, site_id, product_id, product_group_id, dest_geo_id, vendor_tpartner_id, eff_start _date, eff_end_date The table below lists the column names supported by the data entity: Column id site_id2 product_id2 company_id2 product_group_id2 Data type Required Description string string string string string Yes Yes1 Yes1 No Yes1 Policy ID. Site ID for the policy being defined. Product ID for the policy being defined. Company ID. Product group ID that the policies are being defined inv_policy 532 AWS Supply Chain Column Data type Required Description User Guide dest_geo_id2 string Yes1 vendor_tpartner_id2 string Yes1 status string No for. Overridden at product level. Sets default values at geo level of the destination. Trading partner ID of the vendor. This field is used when policies vary by vendor. Status of the inventory policy record, for example, on- hold, or active. inv_policy 533 AWS Supply Chain Column ss_policy Data type Required Description User Guide string No Type of safety stock policy. The safety stock policy is associated with corresponding data. abs_level – Uses units specified in min/max safety stock (SS). Source is customer system or external tool. Ordering is suggested whenever inventory falls below min SS level. sl – Targets inventory between min and max service level for in-stock percentages. For example, if min/max service level is 50% and 90%, ordering will be done to maintain inventory inv_policy 534 AWS Supply Chain
|
supplychain-ug-125
|
supplychain-ug.pdf
| 125 |
inventory policy record, for example, on- hold, or active. inv_policy 533 AWS Supply Chain Column ss_policy Data type Required Description User Guide string No Type of safety stock policy. The safety stock policy is associated with corresponding data. abs_level – Uses units specified in min/max safety stock (SS). Source is customer system or external tool. Ordering is suggested whenever inventory falls below min SS level. sl – Targets inventory between min and max service level for in-stock percentages. For example, if min/max service level is 50% and 90%, ordering will be done to maintain inventory inv_policy 534 AWS Supply Chain Column Data type Required Description User Guide between these percentiles of forecast over plan horizon. DOC_dem – Uses days of cover computed from historica l demand as target level of inventory. DOC_fcst – Uses days of cover computed from forecast as target level of inventory. Fallback inventory policy. Specifies the replenishment interval. For safety stock policy "abs_leve l". This field is absolute value of minimum safety stock level. fallback_policy_1 repl_interval string double No No min_safety_stock double No inv_policy 535 AWS Supply Chain Column Data type Required Description User Guide max_safety_stock double No min_inventory_qty double No max_inventory_qty double No target_inventory_qty double woc_limit double No No max_doc_limit double No For safety stock policy "abs_level". This is absolute value of maximum safety stock level. Minimum inventory level quantity threshold. Maximum inventory level quantity threshold. Target inventory level quantity. Provides the weeks of cover limit. Provides the maximum days of cover value for safety stock policies "DOC_dem" and "DOC_fcst". inv_policy 536 AWS Supply Chain Column Data type Required Description User Guide min_doc_limit double No target_doc_limit double No permitted_var double No min_sl No target_sl double No Provides the minimum days of cover value for safety stock policies "DOC_dem" and "DOC_fcst". Provides the target value for safety stock policies "DOC_dem" and "DOC_fcst". Allowed variance used in policies where deviation s from min,max, and target is allowed. Provides minimum service level (sl). Used for safety stock policy sl. Target service level used of policy sl. inv_policy 537 AWS Supply Chain Column max_sl Data type Required Description User Guide double No qty_uom string No min_order_qty max_order_qty double double order_qty_multiple double No No No holding_cost_percent double No eff_start_date timestamp Yes1 eff_end_date timestamp Yes1 Provides maximum service level (sl). Used for safety stock policy. Quantity UOM associated with this inventory policy. Minimum order quantity. Maximum order quantity. Order quantity computed in multiples of this value. Annualized holding cost of inventory in percent. Dates from when the record is effective. Dates till when the record is effective. inv_policy 538 AWS Supply Chain Column Data type Required Description User Guide salvage_value_percentage double No segment_id 2 string No demand_planning_enabled string inventory_planning_enabled string mrp_enabled string purchased_item string source source_event_id string string No No No No No No Product cost that can be expected to recovered at the end of Long Term Horizon. ID of segment associated with the inventory policy Identifies parts used for demand planning. Identifies parts used for inventory planning. Identifies parts enabled for planning in MRP. Identifies parts that are purchased. Source of data. ID of the event created in the source system. inv_policy 539 AWS Supply Chain Column Data type Required Description User Guide source_update_dttm timestamp No Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for string and timestamp date type values are: SCN_RESERVED_NO_VALUE_PROVIDED for string; and for timestamp , 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column site_id Category Network FK/Data entity FK/Column site id segment_id Planning segmentation segment_id company_id Organization company dest_geo_id Organization geography vendor_tpartner_id Organization trading_partner product_group_id Product product_hierarchy product_id Product product id id id id id segmentation Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. segmentation 540 AWS Supply Chain Name segmentation User Guide Column segment_id, creation_date, site_id, product_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Data type Required Description Column segment_id creation_date company_id2 site_id2 string timestamp string string Yes Yes No Yes product_id2 string Yes1 segment_description string No segmentation 541 Segment ID. Date and time that the segment was created. Displays the company ID. Overrides policies specified for the region for this node in the product hierarchy. Overrides policies specified for the product- group for this node in the geo hierarchy. Segment description. AWS Supply Chain Column Data type Required Description User Guide segment_type string No segment_value double No source string No eff_start_date timestamp Yes1 eff_end_date timestamp Yes1 source_event_id string No Type of segmentation, for example, value based, demand variabili ty based, or demand speed based.
|
supplychain-ug-126
|
supplychain-ug.pdf
| 126 |
string string Yes Yes No Yes product_id2 string Yes1 segment_description string No segmentation 541 Segment ID. Date and time that the segment was created. Displays the company ID. Overrides policies specified for the region for this node in the product hierarchy. Overrides policies specified for the product- group for this node in the geo hierarchy. Segment description. AWS Supply Chain Column Data type Required Description User Guide segment_type string No segment_value double No source string No eff_start_date timestamp Yes1 eff_end_date timestamp Yes1 source_event_id string No Type of segmentation, for example, value based, demand variabili ty based, or demand speed based. Metric associate d with the segment calculated when the segment is generated. Value depends on segment_t ype. Information about the segment creator. Effective start date of the calendar. Effective end date of the calendar. ID of the event created in the source system. segmentation 542 AWS Supply Chain Column Data type Required Description User Guide source_update_dttm timestamp No Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for string and timestamp date type values are SCN_RESERVED_NO_VALUE_PROVIDED for string; and for timestamp , 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column site_id Category Network site FK/Data entity FK/Column company_id Organization company product_id Product product sourcing_rules Primary key (PK) id id id The table below lists the colum names that are uniquely identified in the data entity. Name sourcing_rules Column sourcing_rule_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: sourcing_rules 543 AWS Supply Chain User Guide Column Data type Required Description sourcing_rule_id company_id2 product_id2 to_site_id2 from_site_id2 product_group_id2 sourcing_rule_type string string string string string string string Yes No No No No No No tpartner_id2 string No Sourcing rule ID. Displays the company ID. Product ID to be sourced. Site ID into which product will be sourced. Site ID from which product will be sourced. Product group ID. Type of sourcing rule. The supported sourcing rule types are transfer, buy, and manufactu re. Only lower case is allowed. Trading partner ID is used depending on sourcing rule type. For example, when sourcing rule sourcing_rules 544 AWS Supply Chain Column Data type Required Description User Guide tpartner_location string No transportation_lane_id string No type is Buy, Buy is the Vendor ID and you can use this vendor ID along with other attributes to find additiona l details from vendor_pr oduct and other entities. The location of the trading partner. For example, Seattle, China, New Mexico, and so on. Transportation lane ID is used depending on sourcing rule type. For example, when sourcing type is Transfer, you can use this ID along with other attribute s to choose the correct transport ation_lane. sourcing_rules 545 AWS Supply Chain Column sourcing_priority2 sourcing_ratio Data type Required Description User Guide int double No No Priority of sourcing rule. Proportion of product to be sourced from this product/ group, to_site, from_site/ tpartner_id combination. All sources for a product, site should add to 1 for a specific time period (or application normalizes the ratio to 1). Quantity UOM associated with sourcing rule. Minimum quantity for the sourcing rule. Maximum quantity for the sourcing rule. Quantity is in multiples of this value. qty_uom string No min_qty double No max_qty double No qty_multiple double No sourcing_rules 546 AWS Supply Chain Column eff_start_date Data type Required Description User Guide timestamp Yes1 eff_end_date timestamp Yes1 source production_process_id string string No No source_event_id string No source_update_dttm timestamp No Effective start date of the calendar. Effective end date of the calendar. Source of data. Type of process operation. For example, stop machine. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for timestamp is, 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with a foreign key: sourcing_rules 547 AWS Supply Chain User Guide Category Network to_site_id, from_site _id FK/Data entity FK/Column site company_id Organization company product_id Product product product_group_id Product product_hierarchy tpartner_id Organization trading_partner Network transporatation_lane id id id id id id Operation production_process production_process _id transportation_lan e_id production_process _id sourcing_schedule Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name sourcing_schedule Column sourcing_schedule_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Column Data type Required Description sourcing_schedule_id string Yes Sourcing schedule ID. sourcing_schedule 548 Data type Required Description User Guide AWS Supply Chain Column
|
supplychain-ug-127
|
supplychain-ug.pdf
| 127 |
Chain User Guide Category Network to_site_id, from_site _id FK/Data entity FK/Column site company_id Organization company product_id Product product product_group_id Product product_hierarchy tpartner_id Organization trading_partner Network transporatation_lane id id id id id id Operation production_process production_process _id transportation_lan e_id production_process _id sourcing_schedule Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name sourcing_schedule Column sourcing_schedule_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: Column Data type Required Description sourcing_schedule_id string Yes Sourcing schedule ID. sourcing_schedule 548 Data type Required Description User Guide AWS Supply Chain Column company_id2 tpartner_id2 status from_site_id2 to_site_id2 string string string string string No No No No No schedule_type string No eff_start_date timestamp Yes1 Displays the company ID. Trading partner ID. Status of the supply schedule. For example, active, inactive. Origin site ID. For example, hub, vendor. Destination site ID. For example, hub or a customer in the network. Type of schedule. For example, inbound ordering, outbound shipping. Date-time when schedule becomes effective. sourcing_schedule 549 AWS Supply Chain Column eff_end_date Data type Required Description User Guide timestamp Yes1 source source_event_id string string No No source_update_dttm timestamp No Date-time till when schedule is effective. Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for timestamp is, 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column from_site_id, to_site_id Category Network FK/Data entity FK/Column site company_id Organization company tpartner_id Organization trading_partner sourcing_schedule_details Primary key (PK) sourcing_schedule_details id id id 550 AWS Supply Chain User Guide The table below lists the colum names that are uniquely identified in the data entity. Name Column sourcing_schedule_details sourcing_schedule_detail_id, sourcing_ schedule_id The table below lists the column names supported by the data entity: Column Data type Required Description sourcing_schedule_detail_id string sourcing_schedule_id company_id1 product_id1 string string string Yes Yes No No product_group_id1 string No day_of_week string No Schedule detail ID. Sourcing schedule ID. Displays the company ID. Product ID used if schedule details are for a specific product. Product group ID used if schedule details are for a product group. Day of the week when the supply schedule is active. Values can be integer or string: Sun: 0 Mon: 1 Tue: 2 sourcing_schedule_details 551 AWS Supply Chain Column Data type Required Description User Guide week_of_month string No time_of_day timestamp No date timestamp No Wed: 3 Thu: 4 Fri: 5 Sat: 6 To be used when ordering X times in a month. To be used in conjunction with day_of_we ek. If used multiple times in a month, use multiple rows. If supply schedule detail is for a specific time in a day, use this field to enter that information. Only time value is used. If supply schedule detail is for a specific date, use this field to enter that informati on. Only date value is used. source string No Source of data. sourcing_schedule_details 552 AWS Supply Chain Column Data type Required Description User Guide source_event_id string No source_update_dttm timestamp No ID of the event created in the source system. Date time stamp of the update made in the source system. 1Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company product_id Product product product_group_id Product product_hierarchy id id id reservation Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name reservation Column reservation_id, reservation_detail_id The table below lists the column names supported by the reservation data entity: reservation 553 Data type Required Description User Guide AWS Supply Chain Column reservation_id reservation_detail_id reservation_type company_id1 status product_id1 site_id1 quantity quantity_uom string string string string string string string double string Yes Yes No No No No No No No reservation_date timestamp No is_deleted string No requisition_id1 string No Reservation ID. Reservation detail ID. Type of reservati on. For example, procurement or build-to-stock. Company ID. Status of the reservation. Product ID. Site ID. Reservation quantity. Quantity UOM associated with reservation. Date when the reservation is generated. Yes or No indicator to indicate whether the reservation is deleted or not. Source object identifier reservation 554 AWS Supply Chain Column Data type Required Description User Guide requisition_line_id1 string No rfq_id1 string No rfq_line_id1 string No order_id1 string No order_line_id1 string No reference to inbound order type. Source object identifier reference to inbound order line. Source object identifier reference to inbound order type RFQ. Source object identifier reference to inbound order line of type RFQ. Source object identifier reference to inbound order.
|
supplychain-ug-128
|
supplychain-ug.pdf
| 128 |
Product ID. Site ID. Reservation quantity. Quantity UOM associated with reservation. Date when the reservation is generated. Yes or No indicator to indicate whether the reservation is deleted or not. Source object identifier reservation 554 AWS Supply Chain Column Data type Required Description User Guide requisition_line_id1 string No rfq_id1 string No rfq_line_id1 string No order_id1 string No order_line_id1 string No reference to inbound order type. Source object identifier reference to inbound order line. Source object identifier reference to inbound order type RFQ. Source object identifier reference to inbound order line of type RFQ. Source object identifier reference to inbound order. Source object identifier reference to inbound order line. reservation 555 AWS Supply Chain Column Data type Required Description User Guide order_line_schedule_id1 string No stock_transfer_1_order_id string stock_transfer_1_order_line_id string stock_transfer_2_order_id string stock_transfer_2_order_line_id string source_update_dttm timestamp source_event_id string source flex_1 flex_2 flex_3 reservation string string string string No No No No No No No No No No Source object identifier reference to inbound order line schedule. Stock transfer order ID. Stock transfer order line ID. Stock transfer order ID. Stock transfer order line ID. Date time stamp of the update made in the source system. ID of the event created in the source system. Source of data. Reservation flexible field 1 Reservation flexible field 2 Reservation flexible field 3 556 Data type Required Description User Guide string string No No Reservation flexible field 4 Reservation flexible field 5 AWS Supply Chain Column flex_4 flex_5 1Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column site_id Category Network site FK/Data entity FK/Column company_id Organization company product_id Product product id id id requisition_id, rfq_id Inbound inbound_order_line order_id requisition_line_id, rfq_line_id Inbound inbound_order_line id order_line_schedul e_id Inbound inbound_order_line _schedule id supply_planning_parameters Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. supply_planning_parameters 557 AWS Supply Chain Name Column User Guide supply_planning_parameters product_id, product_group_id, site_id, eff_start_date, eff_end_date, connection_id The table below lists the column names supported by the supply_planning_parameters data entity: Column product_id1 product_group_id1 Data type Required Description string string Yes Yes ID of product For future Use. Please populate SCN_RESER VED_NO_VA LUE_PROVIDED for now. For future Use. Please populate SCN_RESER VED_NO_VA LUE_PROVIDED for now. name of the supply planner who manages a product or a product group For future Use. For future Use site_id1 string Yes planner_name string No demand_time_fence_days forecast_consumption_backwa rd_days int int No No supply_planning_parameters 558 AWS Supply Chain Column forecast_consumption_forwar d_days Data type Required Description int No For future Use. User Guide eff_start_date timestamp Yes eff_end_date timestamp Yes connection_id string Yes effective start date time effective end date time Unique identifie r for the data source (i.e. connection). Auto populated by ASC. 1Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column product_id Product product product_group_id Product product_hierarchy site_id Network site id id id Operation This section lists the data entities within the operation category. Topics • process_header Operation 559 User Guide AWS Supply Chain • process_operation • process_product • production_process • work_order_plan process_header Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name process_header Column process_id The table below lists the column names supported by the data entity: Column process_id Data type Required Description string Yes type string No company_id1 site_id1 process_header string string No No Process ID. For example, order, work order, maintenance order, or process inquiry. Type of process. For example, customer order, maintenance, or repair, etc. Company ID. Site or plant ID. 560 AWS Supply Chain Column site_location Data type Required Description User Guide string No planning_group string No execution_group string No program_group string No status revision string string No No Name of the location or section in site or plant. Group planning the work. This field will be an organization entity in the source system. Group executing the work. This field will be an organization entity in the source system. Long running program or project name used for group work. For example, maintenance campaign. Status of the process. Revision number associated with planning or program group. process_header 561 AWS Supply Chain Column Data type Required Description User Guide latest_start_date timestamp description priority string string planned_cost double currency_uom string No No No No No planned_completion_date timestamp No planned_closing_date timestamp No planned_release_date timestamp No planned_start_date timestamp No actual_completion_date timestamp No Latest start date for the process. Process descripti on. Priority of the process. Total planned costs for the process. Currency in which value is specified. Planned completion date of the process. Planned closing date of the process. Date when the process is planned to be released. Planned start date for the process. Actual completio n date of the process. process_header
|
supplychain-ug-129
|
supplychain-ug.pdf
| 129 |
AWS Supply Chain Column Data type Required Description User Guide latest_start_date timestamp description priority string string planned_cost double currency_uom string No No No No No planned_completion_date timestamp No planned_closing_date timestamp No planned_release_date timestamp No planned_start_date timestamp No actual_completion_date timestamp No Latest start date for the process. Process descripti on. Priority of the process. Total planned costs for the process. Currency in which value is specified. Planned completion date of the process. Planned closing date of the process. Date when the process is planned to be released. Planned start date for the process. Actual completio n date of the process. process_header 562 AWS Supply Chain Column Data type Required Description User Guide actual_closing_date timestamp No actual_release_date timestamp actual_start_date timestamp process_url string No No No source_update_dttm timestamp No source_event_id string source flex_1 flex_2 flex_3 flex_4 string string string string string No No No No No No Actual close date of the process. Actual release date for process. Actual start date for process. URL to access process record in source system. Date time stamp of the update made in the source system. ID of the event created in the source system. Source of data. Process flexible field 1 Process flexible field 2 Process flexible field 3 Process flexible field 4 process_header 563 User Guide Data type Required Description string No Process flexible field 5 AWS Supply Chain Column flex_5 1Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column site_id Category Network site FK/Data entity FK/Column id id company_id Organization company process_operation Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column process_operation process_operation_id, process_id The table below lists the column names supported by the process_operation data entity: Column Data type Required Description process_operation_id process_id1 process_operation string string Yes Yes Type of process operation. Process ID. For example, 564 AWS Supply Chain Column Data type Required Description User Guide company_id1 type string string No No site_location string No status operation_name operation_sequence string string string No No No planned_start_dttm timestamp No planned_end_dttm timestamp No 1Foreign key process_operation process, work order, or maintenance order. Company ID. Type of operation within the process. For example, open machine. Name of the location or section in site or plant. Status of the process. Name of the operation. Sequence of the operation within the process. Planned start date-time of operation. Planned end date-time of operation. 565 AWS Supply Chain Foreign key (FK) User Guide The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column process_id Operation process_header process_id company_id Organization company id process_product Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column process_product process_product_id, process_id The table below lists the column names supported by the data entity: Column Data type Required Description process_product_id1 string Yes process_id1 string Yes process_operation_id1 string No ID associated with the process and product. Process ID. For example, order, work order, maintenance order, or process inquiry. Process operational process_product 566 AWS Supply Chain Column company_id1 product_id1 type Data type Required Description User Guide string string string No No No product_value double No currency_uom status string string requested_availability_date timestamp No No No quantity_submitted double No ID. This is an optional field. Company ID. Product ID of the requested product. Type associate d within the process. For example, consumption or production. Monetary value of product being requested. Currency UOM of the product. Status of the product process. Date when the material was requested to be available. Quantity submitted as part of the process for product. process_product 567 AWS Supply Chain Column Data type Required Description User Guide quantity_confirmed double No quantity_consumed double No reservation_id1 string reservation_detail_id1 string quantity_uom process_product_url string string No No No No source_update_dttm timestamp No Quantity confirmed against the request. Quantity consumed against the quantity on this process/work order. Link to reservati on ID associated with this record. Link to reservati on detail ID associated with this record. Unit of measure for quantity. URL to access process product record in source system. Date time stamp of the update made in the source system. process_product 568 AWS Supply Chain Column Data type Required Description User Guide source_event_id string allocation_status string allocation_type string string string string string string string flex_1 flex_2 flex_3 flex_4 flex_5 reservation_type 1Foreign key Foreign key (FK) No No No No No No No No No ID of the event created in the source system. Status of the allocation for the product. Type of allocatio n for the product. Process flexible field 1. Process flexible field 2. Process flexible field 3. Process flexible field 4. Process flexible field 5. Type of reservati on of the product. The table below lists the columns with the associated foreign
|
supplychain-ug-130
|
supplychain-ug.pdf
| 130 |
Chain Column Data type Required Description User Guide source_event_id string allocation_status string allocation_type string string string string string string string flex_1 flex_2 flex_3 flex_4 flex_5 reservation_type 1Foreign key Foreign key (FK) No No No No No No No No No ID of the event created in the source system. Status of the allocation for the product. Type of allocatio n for the product. Process flexible field 1. Process flexible field 2. Process flexible field 3. Process flexible field 4. Process flexible field 5. Type of reservati on of the product. The table below lists the columns with the associated foreign key. process_product 569 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column name product_id Product product company_id Organization company id id process_id Operation process_header process_id process_operation_id Operation process_operation process_operation_id reservation_id Planning reservation reservation_id reservation_detail_id Planning reservation reservation_detail_id production_process Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column production_process production_process_id The table below lists the column names supported by the data entity: Column Data type Required Description production_process_id string Yes production_process_type string No ID associated with the process and product. Type of the specific productio n process. For example, production_process 570 AWS Supply Chain Column Data type Required Description User Guide production_process_name string No product_id1 string No company_id1 string No site_id1 string No start_location string end_location string No No setup_time double No assembly, machining. Name of the specific productio n process. For example, milling, drilling, welding. Product associated with the production process. Company ID associated with the production process. Site ID where the production process is taking place. Location where the process starts. Location where the process ends. Time to setup the process. production_process 571 AWS Supply Chain Column Data type Required Description User Guide setup_time_uom string No operation_time double No operation_time_uom string No frozen_horizon double No frozen_horizon_uom string No unit_cost double No cost_uom source string string source_update_dttm timestamp No No No Unit of measure of the setup time. Total time to complete the process. Unit of measure of the operation time. Time period when there are no changes to the production process. Unit of measure for the frozen horizon. Cost of the production process. Unit of measure of the productio n process cost. Source of data. Date time stamp of the update made in the source system. production_process 572 AWS Supply Chain Column Data type Required Description User Guide source_event_id string No ID of the event created in the source system. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column name product_id Product product company_id Organization company site_id Network site id id id work_order_plan Primary key (PK) The table below lists the column names that are uniquely identified in the data entity. Name work_order_plan Column process_id, product_id, business_process_id, business_process_sequence The table below lists the column names supported by the data entity: Column Data type Required Description process_id1 string Yes Process ID. For example, order, work work_order_plan 573 AWS Supply Chain User Guide Column Data type Required Description process_product_id string preferred_source string product_id string business_process_id string No No Yes Yes order, maintenan ce order, or process inquiry. ID associated with the process and product. Describes if the product is sourced from inventory (that is, stocked to forecasted) or from direct purchase (for non-stocked products). Product ID (material) in the work order. Business process identifier. For example, PO, PR, RFQ and so on. Product ID (material) in the work order. The plan should include both the purchasing and distribution business processes. work_order_plan 574 AWS Supply Chain Column site_id Data type Required Description User Guide string No The site linked to the business process. This field is optional for purchasing process and mandatory for distribution related processes. Business process sequence. Unit in days. Additional notes on work order plan. Plan flexible field 1. Plan flexible field 2. Plan flexible field 3. Plan flexible field 4. Plan flexible field 5. ID of the event created in the source system. Date time stamp of the update made in the source system. 575 Yes Yes No No No No No No No No business_process_s equence duration notes flex_1 flex_2 flex_3 flex_4 flex_5 int int string string string string string string source_event_id string source_update_dttm timestamp 1Foreign key Foreign key (FK) work_order_plan AWS Supply Chain User Guide The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column process_id Insights process_header id Inventory management This section lists the data entities within the inventory management category. Topics • inv_level inv_level Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name inv_level Column snapshot_date, site_id, product_id, inv_condi tion, lot_number The table below lists the column names supported by the data entity: Column
|
supplychain-ug-131
|
supplychain-ug.pdf
| 131 |
int int string string string string string string source_event_id string source_update_dttm timestamp 1Foreign key Foreign key (FK) work_order_plan AWS Supply Chain User Guide The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column process_id Insights process_header id Inventory management This section lists the data entities within the inventory management category. Topics • inv_level inv_level Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name inv_level Column snapshot_date, site_id, product_id, inv_condi tion, lot_number The table below lists the column names supported by the data entity: Column snapshot_date Data type Required Description timestamp Yes1 site_id2 string Yes1 Inventory management 576 Date and time when the inventory snapshot was taken. Site ID of the inventory. AWS Supply Chain Column product_id2 Data type Required Description User Guide string Yes1 company_id2 on_hand_inventory string double No Yes allocated_inventory double No bound_inventory quantity_uom double string No No Product ID of the inventory displayed. Company ID. Physical inventory available at the site. Inventory allocated for some process. Inventory bound to some process. Quantity unit of measure for inventory. inv_level 577 AWS Supply Chain Column inv_condition Data type Required Description User Guide string Yes 1 Condition of the inventory . Inventory in different conditions are displayed in different rows. You can also enter your own value. Reserved inventory condition values in AWS Supply Chain are as follows: • Unrestricted - Inventory is available. • Inspection - Below quality or any other inspection. • Returns - Inventory goes to return area. • Blocked - Inventory is blocked for a reason. inv_level 578 AWS Supply Chain Column Data type Required Description User Guide lot_number string Yes1 expiry_date timestamp source_update_dttm timestamp source_event_id string tpartner_id string No No No No • InTransfer - Used during inventory stock transfer. • Restricted - Restricte d for other reasons but not blocked. Lot number of the inventory. Expiry date of the inventory. Date time stamp of the update made in the source system. ID of the event created in the source system. Unique identifie r for a trading partner. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string date type value is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. inv_level 579 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column product_id Product product company_id Organization company site_id Network site tpartner_id Organization trading_partner id id id id Inbound This section lists the data entities within the inbound category. Topics • inbound_order • inbound_order_line • inbound_order_line_schedule • shipment • shipment_stop • shipment_stop_order • shipment_lot inbound_order Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name inbound_order Column id, tpartner_id The table below lists the column names supported by the data entity: Inbound 580 Data type Required Description User Guide AWS Supply Chain Column id company_id2 order_creation_date timestamp order_type string string string Yes 1 No No No order_status to_site_id2 tpartner_id2 string string string No No Yes1 inbound_order 581 Object ID. Company ID. Order creation date. Displays the type of order. Reserved order types in AWS Supply Chain: • PO - Purchase order • TO - Transfer order • MO - Manufacturing order • BO - Blanket order • CO - Consumption order Status of the order. Site where the order will arrive. Trading partner that the order will be sent to. AWS Supply Chain Column Data type Required Description User Guide order_currency_uom string vendor_currency_uom string No No exchange_rate double No exchange_rate_date timestamp No incoterm incoterm2 string string incoterm_location_1 string No No No Currency UOM that the company uses. Currency UOM that the vendor uses. Exchange rate used for conversion. Date and time when exchange rate was calculated. Three letter incoterm code. Place of ownership transfer. Incoterm location 1. Can be a site_id or the location used on order/ EDI. inbound_order 582 AWS Supply Chain Column Data type Required Description User Guide incoterm_location_2 string No submitted_date timestamp No agreement_start_date timestamp No agreement_end_date timestamp No shipping_instr_code string payment_terms_code string No No Incoterm location 2. Can be a site_id or the location used on order/ EDI. Date and time when order was submitted to vendor. If PO is associate d with contract or agreement , then start datetime of contract. If PO is associate d with contract or agreement , then end datetime of contract. Code for shipping instructions. Code for payment instructions. inbound_order 583 AWS Supply Chain Column Data type Required Description User Guide std_terms_agreement string No std_terms_agreement_ver string No agreement_number string No inbound_order_url string No source_update_dttm timestamp No source_event_id string source string No No Agreement between company and vendor. Version of agreement between company and vendor. Number associated with contract or agreement. URL to access inbound
|
supplychain-ug-132
|
supplychain-ug.pdf
| 132 |
time when order was submitted to vendor. If PO is associate d with contract or agreement , then start datetime of contract. If PO is associate d with contract or agreement , then end datetime of contract. Code for shipping instructions. Code for payment instructions. inbound_order 583 AWS Supply Chain Column Data type Required Description User Guide std_terms_agreement string No std_terms_agreement_ver string No agreement_number string No inbound_order_url string No source_update_dttm timestamp No source_event_id string source string No No Agreement between company and vendor. Version of agreement between company and vendor. Number associated with contract or agreement. URL to access inbound order record in source system. Date time stamp of the update made in the source system. ID of the event created in the source system. Source of data. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key inbound_order 584 AWS Supply Chain Foreign key (FK) The table below lists the columns with the associated foreign key. User Guide Column Category FK/Data entity FK/Column tpartner_id Organization trading_partner company_id Organization company to_site_id Network site id id id inbound_order_line Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column inbound_order_line id, order_id, tpartner_id, product_id The table below lists the column names supported by the data entity: Column id order_id2 company_id2 tpartner_id2 Data type Required Description string string string string Yes1 Yes1 No Yes1 Order line ID. The value must be unique. ID of parent order. Company ID. Partner that the order will be sent to. inbound_order_line 585 AWS Supply Chain Column Data type Required Description User Guide line_creation_date timestamp No product_id2 product_group_id2 supplier_product_id order_type external_line_number string string string string string Yes1 No No No No status string No from_site_id2 to_site_id2 vendor_status string string string No No No Line creation date. Product ID. Product group ID. Product number used by supplier. Type of order. Alternate line number if used by customer system. Status of the line, for example, canceled, closed, or open. Site where order line originates. Site where the order will arrive. Status of the line in the vendor system.. inbound_order_line 586 AWS Supply Chain Column cost Data type Required Description User Guide double No cost_uom string No submitted_cost double No submitted_cost_vendor double No shipping_cost double No tax_cost double quantity_submitted double No Yes Cost of the product in company's currency, after all discounts. Cost UOM in company's currency. Cost of the product at the time of submission, in company's currency. Cost of the product at the time of submission, in vendor's currency. Inbound shipping cost from vendor to company. Tax cost for the product. Quantity submitted to vendor. inbound_order_line 587 AWS Supply Chain Column Data type Required Description User Guide quantity_confirmed double No quantity_received double No quantity_uom string No submitted_date timestamp No expected_delivery_date timestamp No confirmation_date timestamp No earliest_ship_date timestamp No Quantity confirmed by the vendor. Quantity received into inventory. Quantity UOM for the order line. Date and time when the order was submitted to vendor. Date when the order is expected to be delivered. Date and time when the order was confirmed by the vendor. Earliest date and time when the vendor can ship products in this order. inbound_order_line 588 AWS Supply Chain Column Data type Required Description User Guide latest_ship_date timestamp No earliest_delivery_date timestamp No latest_delivery_date timestamp No incoterm incoterm2 string string incoterm_location_1 string No No No Latest date and time when the vendor can ship products in this order. Earliest date and time when the vendor can deliver products in this order. Latest date and time when the vendor can deliver products in this order. Three letter incoterm code. Place of ownership transfer. Incoterm location 1. Can be a site_id or the location used on order/ EDI. inbound_order_line 589 AWS Supply Chain Column Data type Required Description User Guide incoterm_location_2 string No requisition_number string order_receive_date timestamp reservation_id2 string reference_object string No No No No Incoterm location 2. Can be a site_id or the location used on order/ EDI. Requisition number. Date and time when the order is unloaded into the company location. Reservation ID associated with the line. If record is created by or in response to another object / entity, then enter the entity name. For example, inbound_order, outbound_order inbound_order_line 590 AWS Supply Chain Column Data type Required Description User Guide reference_object_type string No reference_object_id reference_detail_id string string No No inbound_order_line_url string No source_update_dttm timestamp No source_event_id string source string No No If activity is created by or in response to a specific type of object, specify the type here. For example, PO (Purchase Order) vs TO (Transfer Order) ID of associated reference object. ID of associated reference object ID's detail/line, if any. URL to access inbound order line record in source system. Date time stamp
|
supplychain-ug-133
|
supplychain-ug.pdf
| 133 |
another object / entity, then enter the entity name. For example, inbound_order, outbound_order inbound_order_line 590 AWS Supply Chain Column Data type Required Description User Guide reference_object_type string No reference_object_id reference_detail_id string string No No inbound_order_line_url string No source_update_dttm timestamp No source_event_id string source string No No If activity is created by or in response to a specific type of object, specify the type here. For example, PO (Purchase Order) vs TO (Transfer Order) ID of associated reference object. ID of associated reference object ID's detail/line, if any. URL to access inbound order line record in source system. Date time stamp of the update made in the source system. ID of the event created in the source system. Source of data. inbound_order_line 591 AWS Supply Chain Column Data type Required Description User Guide sap_lips__vbeln string No sap_vttp__tknum string No Delivery Number. Predicate key for SAP mapping. Upsert key for VTTP, LIKP. Shipment Number. Predicate key for SAP mapping. Upsert key for VTTK. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column tpartner_id Organization trading_partner company_id Organization company product_id Product product from_site_id Network site product_group_id Product product_hierarchy order_id Inbound inbound_order id id id id id id inbound_order_line 592 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column reservation_id Planning reservation reservation_id inbound_order_line_schedule Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column inbound_order_line_schedule id, order_id, order_line_id, product_id The table below lists the column names supported by the data entity: Column id order_id2 order_line_id2 company_id2 status Data type Required Description string string string string string Yes 1 Yes 1 Yes No No Order line ID. The value must be unique. ID of parent order. ID of parent order line. Company ID. Status of line, for example, submitted, or confirmed. The following are the reserved inbound_order_line_schedule 593 AWS Supply Chain Column Data type Required Description User Guide values for AWS Supply Chain. • Can celled - Populated in SAP mapping. Also used for deleted. • Open - Not populated in SAP mapping. • Closed - Not populated in SAP mapping. • InTransit - Not populated in SAP mapping. • Confirmed - Not populated in SAP mapping. Note Null is also an accepted value, or you can enter your own value. inbound_order_line_schedule 594 AWS Supply Chain Column Data type Required Description User Guide schedule_creation_date timestamp No product_id2 external_line_number string string expected_delivery_date timestamp Yes 1 No No confirmation_date timestamp No goods_issue_date timestamp No material_availability_date timestamp No Schedule creation date. Product ID. External line number. Expected delivery date of the products. Date and time when the vendor confirmed the order line schedule, or order. Date and time when the material was available at origin to ship. Date and time when the material was available at origin to ship. inbound_order_line_schedule 595 AWS Supply Chain Column ship_date Data type Required Description User Guide timestamp No delivery_date timestamp No quantity_submitted double No quantity_confirmed double No quantity_received double No sap_lips__vbeln string No Date and time when vendor will ship products in this order-line- schedule. Date and time when the vendor can deliver products in this schedule. Quantity submitted to vendor (POs) or for transfer. Quantity confirmed by the vendor. Quantity received into inventory at the destination. Delivery Number. Predicate key for SAP mapping. Upsert key for VTTP inbound_order_line_schedule 596 AWS Supply Chain Column Data type Required Description User Guide sap_vttp__tknum string No source_event_id string No source_update_dttm timestamp No Shipment Number. Predicate key for SAP mapping. Upsert key for VTTK ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_id order_id Product Inbound product inbound_order order_line_id Inbound inbound_order_line id id id id inbound_order_line_schedule 597 AWS Supply Chain shipment Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name shipment Column id, supplier_tpartner_id, product_id, order_id, order_line_id, package_id The table below lists the column names supported by the data entity: Column id creation_date Data type Required Description string timestamp Yes No No packaging_hierarchy_type string supplier_tpartner_id2 string Yes1 supplier_description company_id2 shipment string string No No Shipment ID. Creation date. Information on how the shipment is structured, for example, container , pallet, carton, or pallet. Supplier partner ID of the vendor. Partner description. Company ID. 598 AWS Supply Chain Column customer_description ship_from_site_id2 Data type Required Description User
|
supplychain-ug-134
|
supplychain-ug.pdf
| 134 |
table below lists the colum names that are uniquely identified in the data entity. Name shipment Column id, supplier_tpartner_id, product_id, order_id, order_line_id, package_id The table below lists the column names supported by the data entity: Column id creation_date Data type Required Description string timestamp Yes No No packaging_hierarchy_type string supplier_tpartner_id2 string Yes1 supplier_description company_id2 shipment string string No No Shipment ID. Creation date. Information on how the shipment is structured, for example, container , pallet, carton, or pallet. Supplier partner ID of the vendor. Partner description. Company ID. 598 AWS Supply Chain Column customer_description ship_from_site_id2 Data type Required Description User Guide string string No No ship_from_site_description string No ship_from_site_address_1 string No ship_from_site_address_2 string No ship_from_site_address_city ship_from_site_address_state string string ship_from_site_address_country string ship_from_site_address_zip ship_to_site_id2 string string No No No No No Customer description. Site where this shipment starts from. Site descripti on for outbound shipments. Address of ship-from site. Address of ship-from site. Site shipping city. Site shipping state. Site shipping country. Site shipping postal code. Site where this shipment ends. shipment 599 AWS Supply Chain Column Data type Required Description User Guide ship_to_site_description string No ship_to_site_address_1 ship_to_site_address_2 ship_to_site_address_city ship_to_site_address_state ship_to_site_address_country ship_to_site_address_zip origin_port destination_port transportation_mode routing_sequence string string string string string string string string string string No No No No No No No No No No Site descripti on for inbound shipments. Address of ship-to site. Address of ship-to site. Site shipping city. Site shipping state. Site shipping country. Site shipping postal code. Port of loading. Port of destination. Mode of transport. Routing sequence ID from the ASN. shipment 600 Data type Required Description User Guide AWS Supply Chain Column routing_description carrier_id2 carrier_description service_level transportation_id transportation_description conveyance_id bill_of_lading_number master_bill_of_lading_number string string string string string string string string string No No No No No No No No No carrier_reference_number string No shipper_reference_number string No Routing description. ID of the carrier. Carrier description. Service level of shipment. Vessel code or trailer number. Vessel description. Trip number. Bill of lading number. Master bill of lading number. Carrier reference number. Shipper reference number. shipment 601 AWS Supply Chain Column equipment_code equipment_number seal_number equipment_type package_type package_quantity weight_qualifier weight weight_uom Data type Required Description User Guide string string string string string double string double string No No No No No No No No No Equipment code. Equipment number. Seal number. Type of equipment. Type of package. Quantity of the package. Code specifyin g the type of weight in EDI, for example, consolidated weight. Weight of the product. Weight UOM of the product. Status of the shipment. shipment_status string No shipment 602 AWS Supply Chain Column Data type Required Description User Guide planned_ship_date timestamp No actual_ship_date timestamp No planned_delivery_date timestamp No actual_delivery_date timestamp No carrier_eta_date timestamp No latest_milestone string No latest_milestone_date timestamp No Planned shipping date. Actual shipping date. Planned delivery date. Actual delivery date. ETA date from the carrier. Text or string field required to capture event or status related to the milestone _date, for example, arrived at consolidation center. Latest milestone date. shipment 603 AWS Supply Chain Column incoterms line_id product_id2 product_description tp_product_id upc units_shipped uom hts_code order_id2 order_type order_customer_tpartner_id order_supplier_tpartner_id Data type Required Description User Guide string No string string string string string double string string string string string string No Yes No No No No No No Yes1 No No No Three letter incoterm code. Shipment line ID. Product ID. Product description. Trading partner product ID. UPC Units shipped. UOM. Harmonize d Tariff Schedule code. Order ID. Order type. Customer ID of the order. Supplier ID of the order. shipment 604 AWS Supply Chain Column order_line_id2 ship_to_site2 package_id Data type Required Description User Guide string string string Yes1 No Yes1 source_update_dttm timestamp No source_event_id string No source volume string double No No volume_uom string No Order line ID. Final ship to location. Package ID. Date time stamp of the update made in the source system. ID of the event created in the source system. Source of data. Volume of the shipment. Volume unit of measureme nt of the shipment. shipment 605 AWS Supply Chain Column Data type Required Description User Guide sap_vttp__vbeln string No sap_but021_fs__addrnumber string No sap_t001w__adrnr string No sap_vttk__bev1_rpmowa string No Delivery Number. Predicate key for SAP mapping. Upsert key for LIKP, LIPS. Address Number. Predicate key for ADRC (for Ship-to Address). Address Number. Predicate key for SAP mapping. Upsert key for ADRC. Vehicle number. Predicate key for SAP mapping. Upsert key for Equi. shipment 606 AWS Supply Chain Column Data type Required Description User Guide units_received double No Represent the received quantity for a shipment for users who track receipts at a shipment level. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category
|
supplychain-ug-135
|
supplychain-ug.pdf
| 135 |
Address Number. Predicate key for ADRC (for Ship-to Address). Address Number. Predicate key for SAP mapping. Upsert key for ADRC. Vehicle number. Predicate key for SAP mapping. Upsert key for Equi. shipment 606 AWS Supply Chain Column Data type Required Description User Guide units_received double No Represent the received quantity for a shipment for users who track receipts at a shipment level. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column supplier_tpartner_id Organization trading_partner company_id Organization company ship_from_site_id, ship_to_site_id, ship_to_site Network site product_id order_id Product Inbound product inbound_order order_line_id Inbound inbound_order_line id id id id id id shipment 607 AWS Supply Chain shipment_stop Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name shipment_stop Column shipment_stop_id, shipment_id The table below lists the column names supported by the data entity: Data type Required Description Column shipment_stop_id shipment_id1 sequence company_id1 site_id1 string string int string string Yes Yes No No No No Shipment stop ID. Shipment ID. Sequence of the shipment. Company ID. Site ID. Planned start date and time for the shipment arrival. Planned end date and time for the shipments arrival. planned_arrival_start_dttm timestamp planned_arrival_end_dttm timestamp No shipment_stop 608 AWS Supply Chain Column Data type Required Description User Guide planned_departure_start_dttm timestamp No planned_departure_end_dttm timestamp No actual_arrival_start_dttm timestamp No actual_arrival_end_dttm timestamp No actual_departure_start_dttm timestamp No actual_departure_end_dttm timestamp No Planned start date and time for the shipment departure. Planned end date and time for the shipment departure. Actual start date and time for the shipment arrival. Actual end date and time for the shipments arrival. Actual start date and time for the shipment departure. Actual end date and time for the shipment departure. shipment_stop 609 AWS Supply Chain Column Data type Required Description User Guide appointment_number string No Note AWS Supply Chain web application will display this column as appointme nt_number. delivery_number string No source_event_id string No source_update_dttm timestamp No Appointment number. Delivery number of the shipment. ID of the event created in the source system. Date time stamp of the update made in the source system. 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company site_id Network site id id shipment_stop 610 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column shipment_id Inbound shipment id shipment_stop_order Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column shipment_stop_order shipment_stop_order_id, shipment_stop_id, shipment_id The table below lists the column names supported by the data entity: Column Data type Required Description shipment_stop_order_id shipment_stop_id1 shipment_id1 company_id1 site_id1 inbound_order_id1 inbound_order_line_id1 string string string string string string string Yes Yes Yes No No No No Shipment stop order ID. Shipment stop ID. Shipment ID. Company ID. Site ID. Inbound order ID. Inbound order line ID. shipment_stop_order 611 AWS Supply Chain Column Data type Required Description User Guide inbound_order_line_schedule_id1 string No action quantity string No double No quantity_uom string No source_event_id string No source_update_dttm timestamp No 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Inbound order line schedule ID. Pickup or drop off shipment. Quantity associated with action and order. Quantity UOM of the shipment. ID of the event created in the source system. Date time stamp of the update made in the source system. shipment_stop_order 612 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column company_id Organization company site_id Network site shipment_id Inbound shipment id id id shipment_stop_id Inbound shipment_stop shipment_stop_id inbound_order_id Inbound inbound_order_line order_id inbound_order_line _id Inbound inbound_order_line id inbound_order_line _schedule_id Inbound inbound_order_line _schedule id shipment_lot Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name shipment_lot Column id, product_id, tpartner_id, order_id, shipment_id, order_line_id, package_id The table below lists the column names supported by the data entity: Column id Data type Required Description string Yes Shipment ID. Unique shipment identifier. shipment_lot 613 AWS Supply Chain Column product_id2 Data type Required Description User Guide string Yes serial_number string No lot_qty double Yes Product ID. Unique product identifier. Unique serial number assigned to the lot. Serial numbers are often used for tracking and traceabil ity purposes, particularly in industrie s where lot- level tracking is crucial. Quantity or number of units within the specific lot. It allows you to track the size or volume of each lot. Manufactu ring date. mfg_date expiry_date timestamp No timestamp No Expiry date. shipment_lot 614 AWS Supply Chain Column tpartner_id2 order_id shipment_id2 order_line_id2 package_id2 Data type Required Description User Guide string No1 string string string string No1 Yes1
|
supplychain-ug-136
|
supplychain-ug.pdf
| 136 |
User Guide string Yes serial_number string No lot_qty double Yes Product ID. Unique product identifier. Unique serial number assigned to the lot. Serial numbers are often used for tracking and traceabil ity purposes, particularly in industrie s where lot- level tracking is crucial. Quantity or number of units within the specific lot. It allows you to track the size or volume of each lot. Manufactu ring date. mfg_date expiry_date timestamp No timestamp No Expiry date. shipment_lot 614 AWS Supply Chain Column tpartner_id2 order_id shipment_id2 order_line_id2 package_id2 Data type Required Description User Guide string No1 string string string string No1 Yes1 No1 No1 Partner that is sending the shipment. For example, shipments generated under POs, this will be vendors. Order ID. Shipment ID. Unique shipment identifier. Order line ID. Package ID. One shipment can have multiple packages in EDI. ID of the event created in the source system. source_event_id string No shipment_lot 615 AWS Supply Chain Column Data type Required Description User Guide source_update_dttm timestamp No Date timestamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key 1Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column product_id tpartner_id order_id Inbound Inbound Inbound shipment_id Inbound order_line_id Inbound package_id Inbound Outbound fulfillment shipment shipment shipment shipment shipment shipment product_id supplier_tpartner_id order_id id order_line_id package_id This section lists the data entities within the outbound fulfillment category. Topics Outbound fulfillment 616 User Guide AWS Supply Chain • outbound_order_line • outbound_shipment outbound_order_line Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name Column outbound_order_line id,cust_order_id, product_id The table below lists the column names supported by the data entity: Column id cust_order_id company_id2 order_date product_id2 product_group_id2 Data type Required Description string string string timestamp string string Yes1 Yes1 No No Yes1 No Outbound order line ID. Outbound order ID. Company ID. Date and time when customer order was placed. Product ID. Product group ID. outbound_order_line 617 AWS Supply Chain Column Data type Required Description User Guide customer_tpartner_id2 string No status string No init_quantity_requested double No final_quantity_requested double No quantity_uom string No requested_delivery_date timestamp No promised_delivery_date timestamp No actual_delivery_date timestamp No Trading partner ID for customer. Status of the customer order. Original order quantity. Final quantity after any cancellations or changes. Quantity unit of measure for the order line. Requested delivery date for order line. Delivery date promised for order lines. Actual delivery date for order line. outbound_order_line 618 AWS Supply Chain Column list_price Data type Required Description User Guide double No sold_price double No discount double No discount_code string No currency_uom tax incoterm1 string double string No No No incoterm2 string No List price for product in order lines.. Selling price for product in order line, after any promotion s, price changes, discounts, and so on. Discount applied for order line for this product. Discount code used on order line. UUOM for currency. Tax amount for order line. Place of ownership transfer. Place of ownership transfer. outbound_order_line 619 AWS Supply Chain Column Data type Required Description User Guide ship_from_site_id2 string No ship_to_site_id2 string No ship_to_site_address_1 ship_to_site_address_2 ship_to_site_address_city ship_to_site_address_state ship_to_site_address_country ship_to_site_address_zip string string string string string string No No No No No No availability_status string No Site ID where the product is shipped from. Site ID where the product is shipped to. Address of ship-to site. Address of ship-to site. City of ship- to site. State of ship- to site. Country of ship-to site. Postal code of ship-to site. In-stock availability status of the product at the time of order. outbound_order_line 620 AWS Supply Chain Column Data type Required Description User Guide quantity_promised double No quantity_delivered double No channel_id string No sap_2lis_11_vahdr__vbeln string No sap_2lis_11_vaitm__kunnr string No Quantity promised on order line. Quantity delivered against this order line. Channel ID that was used to place this order. Reference document number. Predicate key for SAP mapping. Upsert key for VEDA. Sold to party. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. outbound_order_line 621 AWS Supply Chain Column Data type Required Description User Guide sap_2lis_11_vaitm__vkorg string No sap_2lis_11_vaitm__vtweg string No sap_2lis_11_vaitm__spart string No sap_2lis_11_vaitm__pkunre string No Sales organizat ion. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Distribut ion channel. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Division. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Bill-to party. Predicate key for SAP mapping. outbound_order_line 622 AWS Supply Chain Column source source_event_id Data type Required Description User Guide string string No No source_update_dttm timestamp No Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must
|
supplychain-ug-137
|
supplychain-ug.pdf
| 137 |
No sap_2lis_11_vaitm__vtweg string No sap_2lis_11_vaitm__spart string No sap_2lis_11_vaitm__pkunre string No Sales organizat ion. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Distribut ion channel. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Division. Predicate key for SAP mapping. Upsert key for 0CUST_SAL ES_ATTR. Bill-to party. Predicate key for SAP mapping. outbound_order_line 622 AWS Supply Chain Column source source_event_id Data type Required Description User Guide string string No No source_update_dttm timestamp No Source of data. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_id Product product product_group_id Product product_hierarchy customer_tpartner_id Organization trading_partner ship_from_site_id, ship_to_site_id Network site id id id id id outbound_order_line 623 AWS Supply Chain outbound_shipment Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name Column outbound_shipment id, cust_order_id, cust_order_line_id, product_i d The table below lists the column names supported by the data entity: Data type Required Description Column id company_id2 cust_order_id2 cust_order_line_id2 product_id2 shipped_qty string string string string string double cust_shipment_status string Yes 1 No Yes 1 Yes 1 Yes 1 No No Outbound shipment ID. Company ID. Customer order ID. Customer order line ID. Product ID. Shipment quantity. Status of the shipment, for example, canceled, open, closed, or delivered. outbound_shipment 624 AWS Supply Chain Column Data type Required Description User Guide expected_ship_date timestamp No actual_ship_date timestamp No from_site_id2 to_site_id2 string string No No expected_delivery_date timestamp No actual_delivery_date timestamp No shipping_cost double No Date product was expected to ship from the company location. Date product was actually shipped from the company location. Site ID where the product is shipped from. Destination site ID for outbound shipments. Expected delivery date of the products to the customer. Displays when the product was actually delivered to the customer. Final shipping cost. outbound_shipment 625 AWS Supply Chain Column Data type Required Description User Guide tracking_number string No bill_weight double No sap_2lis_08trtlp__vbeln string No sap_2lis_08trtlp__posnr string No sap_2lis_08trtlp__tknum string No source source_event_id string string No No Tracking number associated with the shipment. Shipped weight of product used for billing. Delivery number. Predicate key for SAP mapping. Upsert key for 2LIS_12_VCITM. Delivery item number. Predicate key for SAP mapping. Upsert key for 2LIS_12_VCITM. Shipment item number. Predicate key for SAP mapping. Upsert key for 2LIS_08TRTK. Source of data. ID of the event created in the source system. outbound_shipment 626 AWS Supply Chain Column Data type Required Description User Guide source_update_dttm timestamp No tpartner_id service_level string string No No Date time stamp of the update made in the source system. Unique identifie r for a trading partner. Focuses on the quality and speed of the shipment. For example, Standard, next day, two-day, expedited, and so on. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_ VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company product_id Product product cust_order_line_id OutboundFulfillment outbound_order_line id id id outbound_shipment 627 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column cust_order_id OutboundFulfillment outbound_order_line cust_order_id from_site_id, to_site_id Network site tpartner_id Organization trading_partner id id Cost management This section lists the data entities within the cost management category. Topics • customer_cost customer_cost Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name customer_cost Column cost_id, incurred_date The table below lists the column names supported by the data entity: Column cost_id Data type Required Description string Yes1 A unique identifier for each cost record associated with an user. Cost management 628 AWS Supply Chain Column customer_id2 Data type Required Description User Guide string Yes incurred_date timestamp Yes1 order_id2 string No shipment_id2 cost_type string string No No amount double No The unique identifier for the user incurring the cost. The date and time when the cost was incurred. Displays the timestamp of cost. The unique identifier of the user order associated with the cost. Unique identifier of the outbound shipment. Displays the cost type. For example, handling, packing, storage, and shipping. The amount of cost incurred by the user. customer_cost 629 AWS Supply Chain Column Data type Required Description User Guide amount_uom string No tax 1 tax 2 tax 3 tax_uom currency_uom payment_status string string string string string string No No No No No No Unit of measure for the amount of cost incurred by the user. Tax amount incurred by the user. Tax
|
supplychain-ug-138
|
supplychain-ug.pdf
| 138 |
the cost was incurred. Displays the timestamp of cost. The unique identifier of the user order associated with the cost. Unique identifier of the outbound shipment. Displays the cost type. For example, handling, packing, storage, and shipping. The amount of cost incurred by the user. customer_cost 629 AWS Supply Chain Column Data type Required Description User Guide amount_uom string No tax 1 tax 2 tax 3 tax_uom currency_uom payment_status string string string string string string No No No No No No Unit of measure for the amount of cost incurred by the user. Tax amount incurred by the user. Tax amount incurred by the user. Tax amount incurred by the user. Unit of measure for the tax amount. Unit of measure for the currency. The status of the payment. For example, Pending Paid. customer_cost 630 AWS Supply Chain Column incoterm Data type Required Description User Guide string No A set of internati onally recognize d rules which define the responsibilities of sellers and buyers in the export transacti on. For example, FOB, ExWorks, DDP. Source of data. ID of the event created in the source system. For example, PO receipt, Shipment schedule, and so on. Date time stamp of the update made in the source system. The discount associated for a specific cost ID. The additiona l discount associated for a specific cost ID. source source_event_id string string No No source_update_dttm timestamp No discount_1 double No discount_2 double No customer_cost 631 AWS Supply Chain Column discount_3 Data type Required Description User Guide double No The additiona l discount associated for a specific cost ID. Unique identifie r for the order line. online_order_id string No 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_ VALUE_PROVIDED and the default value for timestamp date type value is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column customer_id Organization trading_partner order_id Outbound fulfillment outbound_order_line shipment_id Outbound fulfillment outbound_shipment order_line_id Outbound fulfillment outbound_order_line id id id id Plan This section lists the data entities within the plan category. Topics • supply_plan Plan 632 AWS Supply Chain supply_plan Primary key (PK) User Guide The table below lists the colum names that are uniquely identified in the data entity. Name supply_plan Column supply_plan_id The table below lists the column names supported by the data entity: Column supply_plan_id company_id1 plan_uuid Data type Required Description string string string Yes No No snapshot_date timestamp No creation_date timestamp No status string No supply_plan 633 Supply plan ID. Company ID. Unique plan identifier generated by the applicati on. To be only used if this ID is separate from supply_plan_id. Date and time till when data is collected. Date and time till when plan was created. Supply plan status. Data type Required Description User Guide string No AWS Supply Chain Column tpartner_id1 product_id1 product_group_id1 to_site_id1 from_site_id1 string string string string No No No No No No No plan_need_by_date timestamp plan_quantity double commit_date timestamp commit_quantity double No Trading partner ID. For example, contract Manufacturer, or supplier in n-tier network. Product ID. Product group ID. Site where the order will arrive. Site where order line originates. Future date and time by when supply is needed at to_site_id. Planned quantity Date committed by tpartner against the plan_date. Quantity committed by tpartner. supply_plan 634 AWS Supply Chain Column Data type Required Description User Guide supply_upside double No plan_type string No plan_window_start timestamp No plan_window_end timestamp No source production_process_id1 string string No No Upside capacity published by the supplier. Type of plan. For example, Forecast Commit, Supplier Plan. If plan correspon ds to a planning bucket or window in application, this field stores the start of the planning window. If plan correspon ds to a planning bucket or window in application, this field stores the end of the planning window. Source of data. ID associated with a specific production process. supply_plan 635 AWS Supply Chain Column Data type Required Description User Guide plan_cycle_sequence double No quantity_uom string plan_id string No No plan_sequence_id string No Sequence number of the plan cycle for a particular order. UOM associate d with the quantity. Recurring plan that covers multiple supply plan records. Unique identifie r or sequence number assigned to each individual supply plan or supply plan version. supply_plan 636 AWS Supply Chain Column plan_cost Data type Required Description User Guide double No Estimated or projected cost associated with a particular supply plan. This cost includes various factors such as raw material costs, labor costs, transportation costs, storage costs, and any other relevant expenses involved in executing the supply plan. It provides a financial measure to assess the viability and feasibility of the planned supply activities. Date when
|
supplychain-ug-139
|
supplychain-ug.pdf
| 139 |
UOM associate d with the quantity. Recurring plan that covers multiple supply plan records. Unique identifie r or sequence number assigned to each individual supply plan or supply plan version. supply_plan 636 AWS Supply Chain Column plan_cost Data type Required Description User Guide double No Estimated or projected cost associated with a particular supply plan. This cost includes various factors such as raw material costs, labor costs, transportation costs, storage costs, and any other relevant expenses involved in executing the supply plan. It provides a financial measure to assess the viability and feasibility of the planned supply activities. Date when you are required to execute a plan under a specific supply_plan generated by supply planning. required_date timestamp No supply_plan 637 AWS Supply Chain Column Data type Required Description User Guide production_process_id string No source_event_id string No source_update_dttm timestamp No total_supply_quantity double No projected_inventory_level double No target_inventory_level double No ID associated with a specific production process. ID of the event created in the source system. Date time stamp of the update made in the source system. The total supply expected to be delivered on the plan_need _by_date. Inventory quantity projected based on the plan_need _by_date. The target inventory level on the required_ date. 1Foreign key Foreign key (FK) supply_plan 638 AWS Supply Chain User Guide The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_id Product product status Organization trading_partner product_group_id Product product_hierarchy Network site id id id id id Operation production_process production_process _id to_site_id, from_site _id production_process _id Forecast This section lists the data entities within the forecast category. Topics • supplementary_time_series • forecast supplementary_time_series Note If you cannot locate the supplementary_time_series data entity, your instance might be using an older data model version. You can contact AWS Support to upgrade your data model version or create a new data connection. Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Forecast 639 AWS Supply Chain Name Column forecast_supplementary_time_series id User Guide The table below lists the column names supported by the data entity: Column id Data type Required Description string Yes product_id 2 string No product_group_id string No order_date timestamp Yes1 channel_id string No Unique identifie r with each supplementary data entry. Unique identifie r for a specific product. Corresponds to product_id in the outbound_ order_line dataset. Product hierarchy or grouping. The timestamp indicating the date and time when the date for the respectiv e time-series was recorded. Unique identifie r for a specific product. supplementary_time_series 640 AWS Supply Chain Column Data type Required Description User Guide customer_tpartner_id 2 string No site_id 2 ship_to_site_id 2 string string ship_to_site_address_zip string geo_id 2 string No No No No Corresponds to product_id in the outbound_ order_line dataset. Unique identifie r for a specific user. Correspon ds to customer_ tpartner_id field in outbound_ order_line dataset. Unique identifier for a specific site or location. Unique identifie r for a specific site or location. This corresponds to the ship_to_s ite_id in the outbound_ order_line dataset. Postal code of ship_to_site_id. Geographical hierarchy ID. supplementary_time_series 641 AWS Supply Chain Column Data type Required Description User Guide ship_from_site_id 2 string No ship_from_site_address_zip string No time_series_name string Yes Corresponds to the ship_from _site_id in the outbound_ order_line dataset. Postal code of ship_from _site_id. The time_seri es_name must start with a letter, should be 2 to 56 characters long, and can contain letters, numbers, and underscores. No other special characters are allowed. supplementary_time_series 642 AWS Supply Chain Column Data type Required Description User Guide time_series_value string Yes source_event_id string No source_update_dttm timestamp No Value correspon ding to the specific time series. This could represent quantities, metric, or string that is relevant to the type of the data. Demand planning only supports numerical value as additional forecast input. ID of the event created in the source system. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. supplementary_time_series 643 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column product_id site_id Product Network product site customer_tpartner_id Organization trading_partner id id id ship_to_site_id Outbound fulfilment outbound_order_line ship_to_site_id geo_id Organization geography id ship_from_site_id Outbound fulfilment outbound_order_line ship_from_site_id forecast Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name forecast Column snapshot_date, product_id, site_id, region_id , product_group_id, forecast_start_dttm, forecast_end_dttm The table below lists the column names supported by the data entity: Column Data type Required Description snapshot_date timestamp Yes Date up to when data was captured to generate forecasts. forecast 644 AWS Supply Chain Column Data type Required Description User
|
supplychain-ug-140
|
supplychain-ug.pdf
| 140 |
FK/Data entity FK/Column product_id site_id Product Network product site customer_tpartner_id Organization trading_partner id id id ship_to_site_id Outbound fulfilment outbound_order_line ship_to_site_id geo_id Organization geography id ship_from_site_id Outbound fulfilment outbound_order_line ship_from_site_id forecast Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name forecast Column snapshot_date, product_id, site_id, region_id , product_group_id, forecast_start_dttm, forecast_end_dttm The table below lists the column names supported by the data entity: Column Data type Required Description snapshot_date timestamp Yes Date up to when data was captured to generate forecasts. forecast 644 AWS Supply Chain Column Data type Required Description User Guide creation_date timestamp No company_id2 product_id2 site_id2 source region_id2 product_group_id2 reg_agg_type mean p10 p20 string string string string string string string double double double No Yes1 Yes1 No Yes1 Yes1 No No No No Date when a forecast was created. Company ID. Product or product group level for the forecast. Site ID that the forecast is generated for . Source of the data. Geographical region ID. Product group ID. Type of regional aggregation. Mean value of forecast. P10 quantile of forecast. P20 quantile of forecast. forecast 645 AWS Supply Chain Column Data type Required Description User Guide p30 p40 p50 p60 p70 p80 p90 double double double double double double double No No No No No No No forecast_start_dttm timestamp Yes forecast_end_dttm timestamp Yes default_price double No forecast_price double No P30 quantile of forecast. P40 quantile of forecast. P50 quantile of forecast. P60 quantile of forecast. P70 quantile of forecast. P80 quantile of forecast. P90 quantile of forecast. Forecast start date and time. Forecast end date and time. Default MSRP of the product that is forecast. Price at which the ASIN was forecast to be sold. forecast 646 AWS Supply Chain Column Data type Required Description User Guide num_causals int causal_start timestamp causal_end timestamp user_override double user_id string No No No No No act_qty double No channel_id string No Number of casuals applied to forecast. Start date of causal. End date of causal. User override of forecast quantity. ID of the user that overrode the forecast. Actual order quantity sold in the forecast period. Unique identifie r for a specific channel. Corresponds to channel_id in the outbound_ order_line dataset. tpartner_id 2 string No Tpartner ID. forecast 647 AWS Supply Chain Column Data type Required Description User Guide user_override_p10 double No user_override_p20 double No user_override_p30 double No user_override_p40 double No user_override_p50 double No user_override_p60 double No user_override_p70 double No Override value for the P10 quantile of forecast. Override value for the P20 quantile of forecast. Override value for the P30 quantile of forecast. Override value for the P40 quantile of forecast. Override value for the P50 quantile of forecast. Override value for the P60 quantile of forecast. Override value for the P70 quantile of forecast. forecast 648 AWS Supply Chain Column Data type Required Description User Guide user_override_p80 double No user_override_p90 double No postal_code tpartner_type quantity_uom demand_plan_id plan_sequence_id string string string string string No No No No No plan_type string No Override value for the P80 quantile of forecast. Override value for the P90 quantile of forecast. Trading partner's postal code. Trading partner type. Quantity unit of measure. Demand plan ID. Unique identifie r or sequence number assigned to each individua l demand plan or demand plan version. Type of forecast or plan. forecast 649 AWS Supply Chain Column Data type Required Description User Guide plan_window_start timestamp No plan_window_end timestamp No ship_to_site_id source_event_id string string No No source_update_dttm timestamp No If plan correspon ds to a planning bucket or window in application, this field stores the start of the planning window. If plan correspon ds to a planning bucket or window in application, this field stores the end of the planning window. Site to which an order is shipped. ID of the event created in the source system. Date time stamp of the update made in the source system. forecast 650 AWS Supply Chain Column status Data type Required Description User Guide string No Status defining whether the plan generated in demand planning was created, saved, or published. Represents the name of the demand plan associated with the forecast plan_name string No 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_id Product product region_id Organization geography product_group_id Product product_hierarchy site_id Network site tpartner_id Organization trading_partner id id id id id id forecast 651 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column ship_to_site_id Outbound outbound_order_line ship_to_site_id Reference This section lists the data entities within the reference category. Topics • reference_field • calendar • uom_conversion reference_field Primary key (PK) The table below lists the colum
|
supplychain-ug-141
|
supplychain-ug.pdf
| 141 |
from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the columns with the associated foreign key. Column Category FK/Data entity FK/Column company_id Organization company product_id Product product region_id Organization geography product_group_id Product product_hierarchy site_id Network site tpartner_id Organization trading_partner id id id id id id forecast 651 AWS Supply Chain User Guide Column Category FK/Data entity FK/Column ship_to_site_id Outbound outbound_order_line ship_to_site_id Reference This section lists the data entities within the reference category. Topics • reference_field • calendar • uom_conversion reference_field Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name reference_field Column object_name, object_field, object_field_value, object_field_desc The table below lists the column names supported by the data entity: Column company_id2 object_name Data type Required Description string string No Yes1 Company ID. For example, sites, or transportation lanes. Reference 652 AWS Supply Chain Column object_field Data type Required Description User Guide string object_field_value string object_field_desc string Yes1 Yes1 Yes1 For example, site_type, or trans_mode. For example, site_type:01, or trans_mode:01. For example, site_type:01:DC, or trans_mod e:01:Surface. 1You must enter a value. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company id calendar Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name calendar calendar Column calendar_id, date, eff_start_date, eff_end_date 653 AWS Supply Chain User Guide The table below lists the column names supported by the data entity: Column Data type Required Description calendar_id company_id2 name calendar_type string string string string description string date year day week month timestamp int int int int is_working string is_holiday string eff_start_date timestamp eff_end_date timestamp Yes1 No No No No Yes Yes Yes Yes Yes No No Yes1 Yes1 Calendar ID. Company ID. Calendar name. Type of Calender, based on customer data. Calendar description. Date associated with each calendar record. Calendar year. Calendar day. Calendar week. Calendar month. Boolean value that checks if the date is working. Boolean value that checks if this date is a holiday. Effective start date of the calendar. Effective end date of the calendar. calendar 654 Data type Required Description User Guide AWS Supply Chain Column source string source_update_dttm timestamp No No Source of data. Date time stamp of the update made in the source system. 1You must enter a value. When you ingest data from SAP or EDI, the default values for string and timestamp date type values are SCN_RESERVED_NO_VALUE_PROVIDED for string; and for timestamp, 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company id uom_conversion Primary key (PK) The table below lists the colum names that are uniquely identified in the data entity. Name uom_conversion Column uom, conversion_uom_id, eff_start_date, eff_end_date The table below lists the column names supported by the data entity: uom_conversion 655 Data type Required Description User Guide string Yes AWS Supply Chain Column uom company_id2 uom_code uom_description uom_type string string string string conversion_uom_id string conversion_factor double eff_start_date timestamp eff_end_date timestamp source string source_update_dttm timestamp No No No No Yes Yes Yes1 Yes1 No No Unit of measure (UOM). For example, weight_uom, currency_uom. Company ID. Alternate code for UOM. UOM descripti on. UOM type, for example, currency, weight, volume, or unit. UOM ID for conversion. Conversion factor. Effective start date and time. Effective end date and time. Source of data. Date time stamp of the update made in the source system. uom_conversion 656 AWS Supply Chain User Guide 1You must enter a value. When you ingest data from SAP or EDI, the default value for timestamp date type value is 1900-01-01 00:00:00 for start date, and 9999-12-31 23:59:59 for end date. 2Foreign key Foreign key (FK) The table below lists the column names with the associated data entity and category: Column Category FK/Data entity FK/Column company_id Organization company id uom_conversion 657 AWS Supply Chain User Guide Get support for AWS Supply Chain If you are an administrator and need to contact support for AWS Supply Chain, choose one of the following options: • If you have an Support account, go to Support Center and submit a ticket. • Open the AWS Management Console and choose AWS Supply Chain, Support, Create case. It's helpful to provide the following information: • Your AWS Supply Chain instance ID/ARN. • Your AWS Region. • A detailed description of your issue. 658 AWS Supply Chain User Guide Document history The following table describes the documentation releases for AWS Supply Chain. Change Description
|
supplychain-ug-142
|
supplychain-ug.pdf
| 142 |
support for AWS Supply Chain If you are an administrator and need to contact support for AWS Supply Chain, choose one of the following options: • If you have an Support account, go to Support Center and submit a ticket. • Open the AWS Management Console and choose AWS Supply Chain, Support, Create case. It's helpful to provide the following information: • Your AWS Supply Chain instance ID/ARN. • Your AWS Region. • A detailed description of your issue. 658 AWS Supply Chain User Guide Document history The following table describes the documentation releases for AWS Supply Chain. Change Description Date Supply Planning update Demand Planning update Documented the order adjustment and firming feature updates. Documented the data validation, and demand pattern and recommendation feature updates. April 25, 2025 April 25, 2025 Supply Planning update Added information about multi-sourcing under sourcing April 4, 2025 Supply Planning update rule. Documented the Supply Demand Pegging feature within the workflow for managing manufacturing plans. March 24, 2025 Demand Planning update Chain format now supports 6 levels of lineage relationship. March 5, 2025 Amazon Q in AWS Supply Chain Demand Planning updates You can use Amazon Q in AWS Supply Chain an interactive generative artificia l intelligence (GenAI) assistant to operate your supply chain more efficiently. Demand Planning introduces two new features, a new self- service tool called Forecast November 10, 2024 August 20, 2024 659 AWS Supply Chain User Guide Region updates Sustainability updates Work order insights update model analyzer and Forecast lock. There are also updates on how accuracy metrics is calculated. Demand Planning and Supply Planning are supported in Europe (Ireland) Region. Added information on how to create and send Emission data request forms to partners. Added a new Troubleshooting topic and added information on the data entities used to display user interface column values for work orders, procurement, and logistics. August 12, 2024 July 22, 2024 July 8, 2024 Supply Planning configura tion update You can carry over the unmet demand from the current July 1, 2024 time period to the next time period. Organization Labels You can customize the work order labels. April 30, 2024 Forecast validation in Demand Planning Demand Planning will monitor and update you on the forecast quality or accuracy. April 29, 2024 660 AWS Supply Chain User Guide Auto-association in Data lake Multi-factor authentication Configuring work order insights You can use the AWS Supply Chain auto-association feature to upload your raw data and automatically associate your raw data with AWS Supply Chain data model. As a Sustainability partner, you can use multi-factor authentication to enhance your account security. As an administrator, you can create multiple processes and milestones to track your work orders. March 27, 2024 March 20, 2024 March 4, 2024 Forecasts based on demand drivers in Demand Planning To enhance forecast accuracy while configuring your February 22, 2024 Sustainability Supply Planning forecast, you can use demand drivers. Using Sustainability, you can request data from your partners who have accepted your invitation to join your network. You can use Supply Planning to help accurately plan inventory to meet the demand. January 15, 2024 January 15, 2024 661 AWS Supply Chain N-Tier Visibility Work Order Insights Demand Planning updates N-Tier Visibility enables you to share component level forecasts generated from a supply plan, with your trading partners and get their supply commitments. You can use the Work Order Insights to view the work orders for materials as they flow through your supply chain process and identify work orders with risks, resolve issues, or provide recommend ations to increase the efficienc y of the overall supply chain process. Added information on Product lifecycle in the Demand Planning chapter. User Guide January 15, 2024 November 8, 2023 October 31, 2023 Updated data entities used by Insights Consolidated all the required and optional data entities October 25, 2023 Demand Planning updates Updated information on regions support Demand Planning updates used by Insights in one table. Added information on Product lineage in the Demand Planning chapter. Demand Planning is now also supported in Asia Pacific (Sydney) Region. Added information on Overall Influence Factors and Accuracy Metrics in the Demand Planning chapter. October 2, 2023 September 12, 2023 August 18, 2023 662 AWS Supply Chain User Guide Demand Planning updates Updated information on regions support General availability release July 24, 2023 July 19, 2023 April 3, 2023 Updated the Demand Planning chapter to match the new Demand Planning user interface. AWS Supply Chain is now also supported in Asia Pacific (Sydney) Region, and Europe (Ireland) Region Regions but AWS Supply Chain Demand Planning is not supported on these two new regions. Added a chapter on data entities supported in AWS Supply Chain and updated the configuring to S/4 HANA and ECC sections. Initial release Initial release of the AWS Supply
|
supplychain-ug-143
|
supplychain-ug.pdf
| 143 |
2023 662 AWS Supply Chain User Guide Demand Planning updates Updated information on regions support General availability release July 24, 2023 July 19, 2023 April 3, 2023 Updated the Demand Planning chapter to match the new Demand Planning user interface. AWS Supply Chain is now also supported in Asia Pacific (Sydney) Region, and Europe (Ireland) Region Regions but AWS Supply Chain Demand Planning is not supported on these two new regions. Added a chapter on data entities supported in AWS Supply Chain and updated the configuring to S/4 HANA and ECC sections. Initial release Initial release of the AWS Supply Chain User Guide November 29, 2022 663
|
support-api-001
|
support-api.pdf
| 1 |
API Reference AWS Support API Version 2013-04-15 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Support API Reference AWS Support: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Support Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 3 AddAttachmentsToSet ................................................................................................................................. 4 Request Syntax ........................................................................................................................................ 4 Request Parameters ................................................................................................................................ 4 Response Syntax ...................................................................................................................................... 5 Response Elements ................................................................................................................................. 5 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 6 AddCommunicationToCase ......................................................................................................................... 8 Request Syntax ........................................................................................................................................ 8 Request Parameters ................................................................................................................................ 8 Response Syntax ...................................................................................................................................... 9 Response Elements ................................................................................................................................. 9 Errors ....................................................................................................................................................... 10 See Also .................................................................................................................................................. 10 CreateCase ................................................................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 Request Parameters .............................................................................................................................. 13 Response Syntax ................................................................................................................................... 15 Response Elements ............................................................................................................................... 15 Errors ....................................................................................................................................................... 15 See Also .................................................................................................................................................. 16 DescribeAttachment .................................................................................................................................. 17 Request Syntax ...................................................................................................................................... 17 Request Parameters .............................................................................................................................. 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 DescribeCases .............................................................................................................................................. 20 Request Syntax ...................................................................................................................................... 20 Request Parameters .............................................................................................................................. 21 Response Syntax ................................................................................................................................... 22 API Version 2013-04-15 iii AWS Support API Reference Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 DescribeCommunications .......................................................................................................................... 25 Request Syntax ...................................................................................................................................... 25 Request Parameters .............................................................................................................................. 25 Response Syntax ................................................................................................................................... 26 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 27 See Also .................................................................................................................................................. 28 DescribeCreateCaseOptions ..................................................................................................................... 29 Request Syntax ...................................................................................................................................... 29 Request Parameters .............................................................................................................................. 29 Response Syntax ................................................................................................................................... 30 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 DescribeServices ......................................................................................................................................... 33 Request Syntax ...................................................................................................................................... 33 Request Parameters .............................................................................................................................. 33 Response Syntax ................................................................................................................................... 34 Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 34 See Also .................................................................................................................................................. 35 DescribeSeverityLevels .............................................................................................................................. 36 Request Syntax ...................................................................................................................................... 36 Request Parameters .............................................................................................................................. 36 Response Syntax ................................................................................................................................... 36 Response Elements ............................................................................................................................... 37 Errors ....................................................................................................................................................... 37 See Also .................................................................................................................................................. 37 DescribeSupportedLanguages ................................................................................................................. 39 Request Syntax ...................................................................................................................................... 39 Request Parameters .............................................................................................................................. 39 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 40 API Version 2013-04-15 iv AWS Support API Reference Errors ....................................................................................................................................................... 40 See Also .................................................................................................................................................. 41 DescribeTrustedAdvisorCheckRefreshStatuses ..................................................................................... 42 Request Syntax ...................................................................................................................................... 42 Request Parameters .............................................................................................................................. 42 Response Syntax ................................................................................................................................... 43 Response Elements ............................................................................................................................... 43 Errors ....................................................................................................................................................... 43 See Also .................................................................................................................................................. 44 DescribeTrustedAdvisorCheckResult ....................................................................................................... 45 Request Syntax ...................................................................................................................................... 45 Request Parameters .............................................................................................................................. 46 Response Syntax ................................................................................................................................... 46 Response Elements ............................................................................................................................... 47 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 48 DescribeTrustedAdvisorChecks ................................................................................................................ 49 Request Syntax ...................................................................................................................................... 49 Request Parameters .............................................................................................................................. 49 Response Syntax ................................................................................................................................... 50 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 51 See Also .................................................................................................................................................. 51 DescribeTrustedAdvisorCheckSummaries .............................................................................................. 52 Request Syntax ...................................................................................................................................... 52 Request Parameters .............................................................................................................................. 52 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 53 See Also .................................................................................................................................................. 54 RefreshTrustedAdvisorCheck .................................................................................................................... 55 Request Syntax ...................................................................................................................................... 55 Request Parameters .............................................................................................................................. 55 Response Syntax ................................................................................................................................... 56 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 56 API Version 2013-04-15 v AWS Support API Reference See Also .................................................................................................................................................. 57 ResolveCase ................................................................................................................................................. 58 Request Syntax ...................................................................................................................................... 58 Request Parameters .............................................................................................................................. 58 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 59 See Also .................................................................................................................................................. 59 Data Types ..................................................................................................................................... 61 Attachment .................................................................................................................................................. 63 Contents .................................................................................................................................................. 63 See Also .................................................................................................................................................. 63 AttachmentDetails ...................................................................................................................................... 64 Contents .................................................................................................................................................. 64 See Also .................................................................................................................................................. 64 CaseDetails ................................................................................................................................................... 65 Contents .................................................................................................................................................. 66 See Also .................................................................................................................................................. 68 Category ....................................................................................................................................................... 69 Contents .................................................................................................................................................. 69 See Also .................................................................................................................................................. 69 Communication ........................................................................................................................................... 70 Contents .................................................................................................................................................. 70 See Also .................................................................................................................................................. 71 CommunicationTypeOptions .................................................................................................................... 72 Contents .................................................................................................................................................. 72 See Also .................................................................................................................................................. 72 DateInterval ................................................................................................................................................. 74 Contents .................................................................................................................................................. 74 See Also .................................................................................................................................................. 74 RecentCaseCommunications .................................................................................................................... 75 Contents .................................................................................................................................................. 75 See Also .................................................................................................................................................. 75 Service .......................................................................................................................................................... 76 Contents .................................................................................................................................................. 76 See Also .................................................................................................................................................. 76 API Version 2013-04-15 vi AWS Support API Reference SeverityLevel ............................................................................................................................................... 77 Contents .................................................................................................................................................. 77 See Also .................................................................................................................................................. 78 SupportedHour ........................................................................................................................................... 79 Contents .................................................................................................................................................. 79 See Also .................................................................................................................................................. 79 SupportedLanguage ................................................................................................................................... 80 Contents .................................................................................................................................................. 80 See Also .................................................................................................................................................. 80 TrustedAdvisorCategorySpecificSummary ............................................................................................ 81 Contents .................................................................................................................................................. 81 See Also .................................................................................................................................................. 81 TrustedAdvisorCheckDescription ............................................................................................................. 82 Contents .................................................................................................................................................. 82 See Also .................................................................................................................................................. 82 TrustedAdvisorCheckRefreshStatus ........................................................................................................ 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 84 TrustedAdvisorCheckResult ...................................................................................................................... 85 Contents .................................................................................................................................................. 85 See Also .................................................................................................................................................. 86 TrustedAdvisorCheckSummary ................................................................................................................ 87 Contents .................................................................................................................................................. 87 See Also .................................................................................................................................................. 88 TrustedAdvisorCostOptimizingSummary ............................................................................................... 89 Contents .................................................................................................................................................. 89 See Also .................................................................................................................................................. 89 TrustedAdvisorResourceDetail ................................................................................................................. 90 Contents .................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 TrustedAdvisorResourcesSummary ......................................................................................................... 92 Contents .................................................................................................................................................. 92 See Also .................................................................................................................................................. 92 Common Parameters ..................................................................................................................... 93 Common Errors .............................................................................................................................. 96 API Version 2013-04-15 vii AWS Support Welcome API Reference The AWS Support API Reference is intended for programmers
|
support-api-002
|
support-api.pdf
| 2 |
See Also .................................................................................................................................................. 81 TrustedAdvisorCheckDescription ............................................................................................................. 82 Contents .................................................................................................................................................. 82 See Also .................................................................................................................................................. 82 TrustedAdvisorCheckRefreshStatus ........................................................................................................ 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 84 TrustedAdvisorCheckResult ...................................................................................................................... 85 Contents .................................................................................................................................................. 85 See Also .................................................................................................................................................. 86 TrustedAdvisorCheckSummary ................................................................................................................ 87 Contents .................................................................................................................................................. 87 See Also .................................................................................................................................................. 88 TrustedAdvisorCostOptimizingSummary ............................................................................................... 89 Contents .................................................................................................................................................. 89 See Also .................................................................................................................................................. 89 TrustedAdvisorResourceDetail ................................................................................................................. 90 Contents .................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 TrustedAdvisorResourcesSummary ......................................................................................................... 92 Contents .................................................................................................................................................. 92 See Also .................................................................................................................................................. 92 Common Parameters ..................................................................................................................... 93 Common Errors .............................................................................................................................. 96 API Version 2013-04-15 vii AWS Support Welcome API Reference The AWS Support API Reference is intended for programmers who need detailed information about the Support operations and data types. You can use the API to manage your support cases programmatically. The AWS Support API uses HTTP methods that return results in JSON format. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. You can also use the Support API to access features for AWS Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. You can manage your support cases with the following Support API operations: • The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Support cases, retrieve information about cases, and resolve cases. • The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases. • The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation. You can also use the AWS Support API to call the Trusted Advisor operations. For more information, see AWS Trusted Advisor in the AWS Support User Guide. For authentication of requests, Support uses Signature Version 4 Signing Process. For more information about this service and the endpoints to use, see About the AWS Support API in the AWS Support User Guide. API Version 2013-04-15 1 AWS Support API Reference This document was last published on May 14, 2025. API Version 2013-04-15 2 AWS Support Actions The following actions are supported: • AddAttachmentsToSet • AddCommunicationToCase • CreateCase • DescribeAttachment • DescribeCases • DescribeCommunications • DescribeCreateCaseOptions • DescribeServices • DescribeSeverityLevels • DescribeSupportedLanguages • DescribeTrustedAdvisorCheckRefreshStatuses • DescribeTrustedAdvisorCheckResult • DescribeTrustedAdvisorChecks • DescribeTrustedAdvisorCheckSummaries • RefreshTrustedAdvisorCheck • ResolveCase API Reference API Version 2013-04-15 3 AWS Support API Reference AddAttachmentsToSet Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "attachments": [ { "data": blob, "fileName": "string" } ], "attachmentSetId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. attachments One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment. AddAttachmentsToSet API Version 2013-04-15 4 AWS Support API Reference In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png. Type: Array of Attachment objects attachmentSetId The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. Type: String Response Syntax { "attachmentSetId": "string", "expiryTime": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. attachmentSetId The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists. Type: String
|
support-api-003
|
support-api.pdf
| 3 |
If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. Type: String Response Syntax { "attachmentSetId": "string", "expiryTime": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. attachmentSetId The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists. Type: String expiryTime The time and date when the attachment set expires. Type: String Response Syntax API Version 2013-04-15 5 AWS Support Errors API Reference For information about the errors that are common to all actions, see Common Errors. AttachmentLimitExceeded The limit for the number of attachment sets created in a short period of time has been exceeded. HTTP Status Code: 400 AttachmentSetExpired The expiration time of the attachment set has passed. The set expires 1 hour after it is created. HTTP Status Code: 400 AttachmentSetIdNotFound An attachment set with the specified ID could not be found. HTTP Status Code: 400 AttachmentSetSizeLimitExceeded A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment. HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2013-04-15 6 API Reference AWS Support • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 7 AWS Support API Reference AddCommunicationToCase Adds additional customer communication to an Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "attachmentSetId": "string", "caseId": "string", "ccEmailAddresses": [ "string" ], "communicationBody": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. attachmentSetId The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet Type: String AddCommunicationToCase API Version 2013-04-15 8 AWS Support caseId API Reference The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String ccEmailAddresses The email addresses in the CC line of an email to be added to the support case. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. communicationBody The body of an email communication to add to the support case. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. Response Syntax { "result": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. result True if AddCommunicationToCase succeeds. Otherwise, returns an error. Type: Boolean Response Syntax API Version 2013-04-15 9 AWS Support Errors API Reference For information about the errors that are common to all actions, see Common Errors. AttachmentSetExpired The expiration time of the attachment set has passed. The set expires 1 hour after it is created. HTTP Status Code: 400 AttachmentSetIdNotFound An attachment set with the specified ID could not be found. HTTP Status Code: 400 CaseIdNotFound The requested caseId couldn't be located. HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2013-04-15 10 AWS Support • AWS SDK for Python • AWS
|
support-api-004
|
support-api.pdf
| 4 |
Code: 400 CaseIdNotFound The requested caseId couldn't be located. HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2013-04-15 10 AWS Support • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 11 AWS Support CreateCase API Reference Creates a case in the Support Center. This operation is similar to how you create a case in the Support Center Create Case page. The Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: • Submit a request from the Support Center Create Case page. • Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Support case number. You can use the DescribeCases operation and specify the case number to get existing Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to get the displayId. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "attachmentSetId": "string", "categoryCode": "string", "ccEmailAddresses": [ "string" ], "communicationBody": "string", "issueType": "string", "language": "string", CreateCase API Version 2013-04-15 12 AWS Support API Reference "serviceCode": "string", "severityCode": "string", "subject": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. attachmentSetId The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation. Type: String categoryCode The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String ccEmailAddresses A list of email addresses that AWS Support copies on case correspondence. AWS Support identifies the account that creates the case when you specify your AWS credentials in an HTTP POST method or use the AWS SDKs. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. communicationBody The communication body text that describes the issue. This text appears in the Description field on the AWS Support Center Create Case page. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. Request Parameters API Version 2013-04-15 13 AWS Support issueType API Reference The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical. Type: String language The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. Type: String serviceCode The code for the AWS service. You can use the DescribeServices operation to get the possible serviceCode values. Type: String severityCode A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with AWS Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode. For more information, see SeverityLevel and Choosing a Severity in the AWS Support User Guide. Note The availability of severity levels depends on the support plan for the AWS account. Type: String subject The title of the support case. The title appears in the Subject field on the AWS Support Center Create Case page. Type: String Request Parameters API Version 2013-04-15 14 AWS Support Response Syntax { "caseId": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. caseId The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String Errors For information about the errors that are common to all actions, see Common Errors. AttachmentSetExpired The expiration time of the attachment set has passed. The set expires 1 hour after
|
support-api-005
|
support-api.pdf
| 5 |
Type: String Request Parameters API Version 2013-04-15 14 AWS Support Response Syntax { "caseId": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. caseId The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String Errors For information about the errors that are common to all actions, see Common Errors. AttachmentSetExpired The expiration time of the attachment set has passed. The set expires 1 hour after it is created. HTTP Status Code: 400 AttachmentSetIdNotFound An attachment set with the specified ID could not be found. HTTP Status Code: 400 CaseCreationLimitExceeded The case creation limit for the account has been exceeded. HTTP Status Code: 400 InternalServerError An internal server error occurred. Response Syntax API Version 2013-04-15 15 AWS Support HTTP Status Code: 500 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 16 AWS Support API Reference DescribeAttachment Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "attachmentId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. attachmentId The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation. Type: String DescribeAttachment API Version 2013-04-15 17 API Reference AWS Support Response Syntax { "attachment": { "data": blob, "fileName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. attachment This object includes the attachment content and file name. In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png. Type: Attachment object Errors For information about the errors that are common to all actions, see Common Errors. AttachmentIdNotFound An attachment with the specified ID could not be found. HTTP Status Code: 400 DescribeAttachmentLimitExceeded The limit for the number of DescribeAttachment requests in a short period of time has been exceeded. HTTP Status Code: 400 Response Syntax API Version 2013-04-15 18 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 19 AWS Support DescribeCases API Reference Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return. The response returns the following in JSON format: • One or more CaseDetails data types. • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request might return an error. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan,
|
support-api-006
|
support-api.pdf
| 6 |
The response returns the following in JSON format: • One or more CaseDetails data types. • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request might return an error. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "afterTime": "string", "beforeTime": "string", "caseIdList": [ "string" ], "displayId": "string", "includeCommunications": boolean, "includeResolvedCases": boolean, "language": "string", "maxResults": number, "nextToken": "string" } DescribeCases API Version 2013-04-15 20 AWS Support Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. afterTime The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String beforeTime The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String caseIdList A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. displayId The ID displayed for a case in the AWS Support Center user interface. Type: String includeCommunications Specifies whether to include communications in the DescribeCases response. By default, communications are included. Type: Boolean includeResolvedCases Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included. Request Parameters API Version 2013-04-15 21 AWS Support Type: Boolean language API Reference The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. Type: String maxResults The maximum number of results to return before paginating. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. nextToken A resumption point for pagination. Type: String Response Syntax { "cases": [ { "caseId": "string", "categoryCode": "string", "ccEmailAddresses": [ "string" ], "displayId": "string", "language": "string", "recentCommunications": { "communications": [ { "attachmentSet": [ { "attachmentId": "string", "fileName": "string" } ], "body": "string", Response Syntax API Version 2013-04-15 22 AWS Support API Reference "caseId": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "string" }, "serviceCode": "string", "severityCode": "string", "status": "string", "subject": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. cases The details for the cases that match the request. Type: Array of CaseDetails objects nextToken A resumption point for pagination. Type: String Errors For information about the errors that are common to all actions, see Common Errors. CaseIdNotFound The requested caseId couldn't be located. Response Elements API Version 2013-04-15 23 AWS Support HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 24 AWS Support API Reference DescribeCommunications Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS
|
support-api-007
|
support-api.pdf
| 7 |
for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "afterTime": "string", "beforeTime": "string", "caseId": "string", "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DescribeCommunications API Version 2013-04-15 25 AWS Support afterTime API Reference The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. Type: String beforeTime The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. Type: String caseId The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String maxResults The maximum number of results to return before paginating. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. nextToken A resumption point for pagination. Type: String Response Syntax { "communications": [ { "attachmentSet": [ { "attachmentId": "string", "fileName": "string" } Response Syntax API Version 2013-04-15 26 AWS Support API Reference ], "body": "string", "caseId": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. communications The communications for the case. Type: Array of Communication objects nextToken A resumption point for pagination. Type: String Errors For information about the errors that are common to all actions, see Common Errors. CaseIdNotFound The requested caseId couldn't be located. HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 Response Elements API Version 2013-04-15 27 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 28 AWS Support API Reference DescribeCreateCaseOptions Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "categoryCode": "string", "issueType": "string", "language": "string", "serviceCode": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. categoryCode The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String DescribeCreateCaseOptions API Version 2013-04-15 29 AWS Support issueType API Reference The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical. Type: String language The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. Type: String serviceCode The code for the AWS service. You can use the DescribeServices operation to get the possible serviceCode values. Type: String Response Syntax { "communicationTypes": [ { "datesWithoutSupport": [ { "endDateTime": "string", "startDateTime": "string" } ], "supportedHours": [ { "endTime": "string", "startTime": "string" } ], "type": "string" } ], "languageAvailability": "string" Response Syntax API Version 2013-04-15 30 AWS Support } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. communicationTypes A JSON-formatted array that contains the available communication
|
support-api-008
|
support-api.pdf
| 8 |
language. Type: String serviceCode The code for the AWS service. You can use the DescribeServices operation to get the possible serviceCode values. Type: String Response Syntax { "communicationTypes": [ { "datesWithoutSupport": [ { "endDateTime": "string", "startDateTime": "string" } ], "supportedHours": [ { "endTime": "string", "startTime": "string" } ], "type": "string" } ], "languageAvailability": "string" Response Syntax API Version 2013-04-15 30 AWS Support } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. communicationTypes A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs. Type: Array of CommunicationTypeOptions objects Array Members: Minimum number of 1 item. Maximum number of 100 items. languageAvailability Language availability can be any of the following: • available • best_effort • unavailable Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. Response Elements API Version 2013-04-15 31 AWS Support HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 32 AWS Support DescribeServices API Reference Returns the current list of AWS services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that appear in the Service and Category lists on the Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "language": "string", "serviceCodeList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. language The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. DescribeServices API Version 2013-04-15 33 AWS Support Type: String serviceCodeList API Reference A JSON-formatted list of service codes available for AWS services. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Response Syntax { "services": [ { "categories": [ { "code": "string", "name": "string" } ], "code": "string", "name": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. services A JSON-formatted list of AWS services. Type: Array of Service objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-04-15 34 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 35 AWS Support API Reference DescribeSeverityLevels Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
|
support-api-009
|
support-api.pdf
| 9 |
for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 35 AWS Support API Reference DescribeSeverityLevels Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "language": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. language The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. Type: String Response Syntax { "severityLevels": [ DescribeSeverityLevels API Version 2013-04-15 36 AWS Support API Reference { "code": "string", "name": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. severityLevels The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. Type: Array of SeverityLevel objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Response Elements API Version 2013-04-15 37 AWS Support • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 38 AWS Support API Reference DescribeSupportedLanguages Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "categoryCode": "string", "issueType": "string", "serviceCode": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. categoryCode The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. issueType The type of issue for the case. You can specify customer-service or technical. DescribeSupportedLanguages API Version 2013-04-15 39 AWS Support Type: String API Reference Length Constraints: Minimum length of 9. Maximum length of 22. serviceCode The code for the AWS service. You can use the DescribeServices operation to get the possible serviceCode values. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Response Syntax { "supportedLanguages": [ { "code": "string", "display": "string", "language": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. supportedLanguages A JSON-formatted array that contains the available ISO 639-1 language codes. Type: Array of SupportedLanguage objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-04-15 40 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException API Reference You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS
|
support-api-010
|
support-api.pdf
| 10 |
Members: Minimum number of 0 items. Maximum number of 100 items. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-04-15 40 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException API Reference You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 41 AWS Support API Reference DescribeTrustedAdvisorCheckRefreshStatuses Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "checkIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. checkIds The IDs of the Trusted Advisor checks to get the status. DescribeTrustedAdvisorCheckRefreshStatuses API Version 2013-04-15 42 AWS Support Note API Reference If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error. Type: Array of strings Response Syntax { "statuses": [ { "checkId": "string", "millisUntilNextRefreshable": number, "status": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. statuses The refresh status of the specified Trusted Advisor checks. Type: Array of TrustedAdvisorCheckRefreshStatus objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error occurred. Response Syntax API Version 2013-04-15 43 AWS Support HTTP Status Code: 500 ThrottlingException API Reference You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 44 AWS Support API Reference DescribeTrustedAdvisorCheckResult Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: • TrustedAdvisorCategorySpecificSummary • TrustedAdvisorResourceDetail • TrustedAdvisorResourcesSummary In addition, the response contains these fields: • status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available. • timestamp - The time of the last refresh of the check. • checkId - The unique identifier for the check. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "checkId": "string", DescribeTrustedAdvisorCheckResult API Version 2013-04-15 45 AWS Support "language": "string" } Request Parameters
|
support-api-011
|
support-api.pdf
| 11 |
AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "checkId": "string", DescribeTrustedAdvisorCheckResult API Version 2013-04-15 45 AWS Support "language": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. checkId The unique identifier for the Trusted Advisor check. Type: String language The ISO 639-1 code for the language that you want your check results to appear in. The Support API currently supports the following languages for Trusted Advisor: • Chinese, Simplified - zh • Chinese, Traditional - zh_TW • English - en • French - fr • German - de • Indonesian - id • Italian - it • Japanese - ja • Korean - ko • Portuguese, Brazilian - pt_BR • Spanish - es Type: String Response Syntax { "result": { Request Parameters API Version 2013-04-15 46 AWS Support API Reference "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "checkId": "string", "flaggedResources": [ { "isSuppressed": boolean, "metadata": [ "string" ], "region": "string", "resourceId": "string", "status": "string" } ], "resourcesSummary": { "resourcesFlagged": number, "resourcesIgnored": number, "resourcesProcessed": number, "resourcesSuppressed": number }, "status": "string", "timestamp": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. result The detailed results of the Trusted Advisor check. Type: TrustedAdvisorCheckResult object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2013-04-15 47 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException API Reference You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 48 AWS Support API Reference DescribeTrustedAdvisorChecks Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. • The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "language": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. language The ISO 639-1 code for the language that you want your checks to appear in. DescribeTrustedAdvisorChecks API Version 2013-04-15 49 AWS Support API Reference The Support API currently supports the following languages for Trusted Advisor: • Chinese, Simplified - zh • Chinese, Traditional - zh_TW • English - en • French - fr • German - de • Indonesian - id • Italian - it • Japanese - ja • Korean - ko • Portuguese, Brazilian - pt_BR • Spanish - es Type: String Response Syntax { "checks": [ { "category": "string", "description": "string", "id": "string", "metadata": [ "string" ], "name": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-04-15 50 AWS Support checks Information about
|
support-api-012
|
support-api.pdf
| 12 |
Traditional - zh_TW • English - en • French - fr • German - de • Indonesian - id • Italian - it • Japanese - ja • Korean - ko • Portuguese, Brazilian - pt_BR • Spanish - es Type: String Response Syntax { "checks": [ { "category": "string", "description": "string", "id": "string", "metadata": [ "string" ], "name": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-04-15 50 AWS Support checks Information about all available Trusted Advisor checks. Type: Array of TrustedAdvisorCheckDescription objects API Reference Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-04-15 51 AWS Support API Reference DescribeTrustedAdvisorCheckSummaries Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "checkIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. checkIds The IDs of the Trusted Advisor checks. Type: Array of strings DescribeTrustedAdvisorCheckSummaries API Version 2013-04-15 52 API Reference AWS Support Response Syntax { "summaries": [ { "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "checkId": "string", "hasFlaggedResources": boolean, "resourcesSummary": { "resourcesFlagged": number, "resourcesIgnored": number, "resourcesProcessed": number, "resourcesSuppressed": number }, "status": "string", "timestamp": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. summaries The summary information for the requested Trusted Advisor checks. Type: Array of TrustedAdvisorCheckSummary objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-04-15 53 AWS Support InternalServerError An internal server error occurred. HTTP Status Code: 500 ThrottlingException API Reference You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 54 AWS Support API Reference RefreshTrustedAdvisorCheck Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About
|
support-api-013
|
support-api.pdf
| 13 |
a TrustedAdvisorCheckRefreshStatus object. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide. Request Syntax { "checkId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. checkId The unique identifier for the Trusted Advisor check to refresh. RefreshTrustedAdvisorCheck API Version 2013-04-15 55 AWS Support Note API Reference Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error. Type: String Response Syntax { "status": { "checkId": "string", "millisUntilNextRefreshable": number, "status": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. status The current refresh status for a check, including the amount of time until the check is eligible for refresh. Type: TrustedAdvisorCheckRefreshStatus object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error occurred. HTTP Status Code: 500 Response Syntax API Version 2013-04-15 56 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 57 AWS Support ResolveCase API Reference Resolves a support case. This operation takes a caseId and returns the initial and final state of the case. Note • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. • If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support. Request Syntax { "caseId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. caseId The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String Response Syntax { "finalCaseStatus": "string", "initialCaseStatus": "string" ResolveCase API Version 2013-04-15 58 API Reference AWS Support } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. finalCaseStatus The status of the case after the ResolveCase request was processed. Type: String initialCaseStatus The status of the case when the ResolveCase request was sent. Type: String Errors For information about the errors that are common to all actions, see Common Errors. CaseIdNotFound The requested caseId couldn't be located. HTTP Status Code: 400 InternalServerError An internal server error occurred. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-04-15 59 API Reference AWS Support • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-04-15 60 AWS Support Data Types API Reference The AWS Support API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • Attachment • AttachmentDetails • CaseDetails • Category • Communication • CommunicationTypeOptions • DateInterval • RecentCaseCommunications • Service • SeverityLevel • SupportedHour • SupportedLanguage • TrustedAdvisorCategorySpecificSummary • TrustedAdvisorCheckDescription • TrustedAdvisorCheckRefreshStatus • TrustedAdvisorCheckResult • TrustedAdvisorCheckSummary • TrustedAdvisorCostOptimizingSummary • TrustedAdvisorResourceDetail • TrustedAdvisorResourcesSummary API Version 2013-04-15 61 AWS Support API Reference API Version 2013-04-15 62 AWS Support Attachment API
|
support-api-014
|
support-api.pdf
| 14 |
API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • Attachment • AttachmentDetails • CaseDetails • Category • Communication • CommunicationTypeOptions • DateInterval • RecentCaseCommunications • Service • SeverityLevel • SupportedHour • SupportedLanguage • TrustedAdvisorCategorySpecificSummary • TrustedAdvisorCheckDescription • TrustedAdvisorCheckRefreshStatus • TrustedAdvisorCheckResult • TrustedAdvisorCheckSummary • TrustedAdvisorCostOptimizingSummary • TrustedAdvisorResourceDetail • TrustedAdvisorResourcesSummary API Version 2013-04-15 61 AWS Support API Reference API Version 2013-04-15 62 AWS Support Attachment API Reference An attachment to a case communication. The attachment consists of the file name and the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text Contents data The content of the attachment file. Type: Base64-encoded binary data object fileName The name of the attachment file. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Attachment API Version 2013-04-15 63 AWS Support AttachmentDetails API Reference The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation. Contents attachmentId The ID of the attachment. Type: String fileName The file name of the attachment. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AttachmentDetails API Version 2013-04-15 64 AWS Support CaseDetails API Reference A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields: • caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47. • categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices. • displayId - The identifier for the case on pages in the AWS Support Center. • language - The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. • nextToken - A resumption point for pagination. • recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated. • serviceCode - The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices. • severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical. • status - The status of the case in the AWS Support Center. Valid values: • all-open • customer-action-completed • opened • pending-customer-action • reopened • resolved • unassigned • work-in-progress • subject - The subject line of the case. • submittedBy - The email address of the account that submitted the case. • timeCreated - The time the case was created, in ISO-8601 format. CaseDetails API Version 2013-04-15 65 AWS Support Contents caseId API Reference The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String categoryCode The category of problem for the support case. Type: String ccEmailAddresses The email addresses that receive copies of communication about the case. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. displayId The ID displayed for the case in the AWS Support Center. This is a numeric string. Type: String language The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language. Type: String recentCommunications The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications. Type: RecentCaseCommunications object Contents API Version 2013-04-15 66 AWS Support serviceCode API Reference The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices. Type: String severityCode The code for the severity level returned by the call to DescribeSeverityLevels. Type: String status The status
|
support-api-015
|
support-api.pdf
| 15 |
for the language parameter if you want support in that language. Type: String recentCommunications The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications. Type: RecentCaseCommunications object Contents API Version 2013-04-15 66 AWS Support serviceCode API Reference The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices. Type: String severityCode The code for the severity level returned by the call to DescribeSeverityLevels. Type: String status The status of the case. Valid values: • all-open • customer-action-completed • opened • pending-customer-action • reopened • resolved • unassigned • work-in-progress Type: String subject The subject line for the case in the AWS Support Center. Type: String submittedBy The email address of the account that submitted the case. Type: String timeCreated The time that the case was created in the AWS Support Center. Contents API Version 2013-04-15 67 AWS Support Type: String See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-04-15 68 AWS Support Category API Reference A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service. Contents code The category code for the support case. Type: String name The category name for the support case. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Category API Version 2013-04-15 69 AWS Support Communication API Reference A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication. Contents attachmentSet Information about the attachments to the case communication. Type: Array of AttachmentDetails objects body The text of the communication between the customer and AWS Support. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. caseId The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 Type: String submittedBy The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, "AdminRole (Role) <janedoe@example.com>). Entries from the AWS Support team display "Amazon Web Services," and don't show an email address. Type: String timeCreated The time the communication was created. Type: String Communication API Version 2013-04-15 70 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-04-15 71 AWS Support API Reference CommunicationTypeOptions A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain communication channel. It is contained in the response from a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the following fields: • datesWithoutSupport - A JSON-formatted list containing date and time ranges for periods without support in UTC time. Date and time format is RFC 3339 : 'yyyy-MM- dd'T'HH:mm:ss.SSSZZ'. • supportedHours - A JSON-formatted list containing time ranges when support are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'. • type - A string value indicating the communication type that the aforementioned rules apply to. At the moment the type value can assume one of 3 values at the moment chat, web and call. Contents datesWithoutSupport A JSON-formatted list containing date and time ranges for periods without support Type: Array of DateInterval objects supportedHours A JSON-formatted list containing time ranges when support is available. Type: Array of SupportedHour objects type A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CommunicationTypeOptions API Version 2013-04-15 72 AWS Support • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 73 AWS Support DateInterval API Reference Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. Contents endDateTime End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. Type: String Length Constraints: Minimum length of 8. Maximum length of 30. startDateTime A JSON object containing start and date time
|
support-api-016
|
support-api.pdf
| 16 |
Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CommunicationTypeOptions API Version 2013-04-15 72 AWS Support • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 73 AWS Support DateInterval API Reference Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. Contents endDateTime End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. Type: String Length Constraints: Minimum length of 8. Maximum length of 30. startDateTime A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy- MM-dd'T'HH:mm:ss.SSSZZ'. Type: String Length Constraints: Minimum length of 8. Maximum length of 30. See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DateInterval API Version 2013-04-15 74 AWS Support API Reference RecentCaseCommunications The five most recent communications associated with the case. Contents communications The five most recent communications associated with the case. Type: Array of Communication objects nextToken A resumption point for pagination. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RecentCaseCommunications API Version 2013-04-15 75 AWS Support Service API Reference Information about an AWS service returned by the DescribeServices operation. Contents categories A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase. Type: Array of Category objects code The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name. Type: String name The friendly name for an AWS service. The code element contains the corresponding code. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Service API Version 2013-04-15 76 AWS Support SeverityLevel API Reference A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the AWS Support User Guide. Contents code The code for case severity level. Valid values: low | normal | high | urgent | critical Type: String name The name of the severity level that corresponds to the severity level code. Note The values returned by the API are different from the values that appear in the AWS Support Center. For example, the API uses the code low, but the name appears as General guidance in Support Center. The following are the API code names and how they appear in the console: • low - General guidance • normal - System impaired • high - Production system impaired • urgent - Production system down • critical - Business-critical system down For more information, see Choosing a severity in the AWS Support User Guide. Type: String SeverityLevel API Version 2013-04-15 77 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-04-15 78 AWS Support SupportedHour API Reference Time range object with startTime and endTime range in RFC 3339 format. 'HH:mm:ss.SSS'. Contents endTime End Time. RFC 3339 format 'HH:mm:ss.SSS'. Type: String startTime Start Time. RFC 3339 format 'HH:mm:ss.SSS'. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SupportedHour API Version 2013-04-15 79 AWS Support API Reference SupportedLanguage A JSON-formatted object that contains the available ISO 639-1 language code, language name and langauge display value. The language code is what should be used in the CreateCase call. Contents code 2 digit ISO 639-1 code. e.g. en Type: String display Language display value e.g. ENGLISH Type: String language Full language description e.g. ENGLISH Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SupportedLanguage API Version 2013-04-15 80 AWS Support API Reference TrustedAdvisorCategorySpecificSummary The container for summary information that relates to the category
|
support-api-017
|
support-api.pdf
| 17 |
name and langauge display value. The language code is what should be used in the CreateCase call. Contents code 2 digit ISO 639-1 code. e.g. en Type: String display Language display value e.g. ENGLISH Type: String language Full language description e.g. ENGLISH Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SupportedLanguage API Version 2013-04-15 80 AWS Support API Reference TrustedAdvisorCategorySpecificSummary The container for summary information that relates to the category of the Trusted Advisor check. Contents costOptimizing The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category. Type: TrustedAdvisorCostOptimizingSummary object See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrustedAdvisorCategorySpecificSummary API Version 2013-04-15 81 AWS Support API Reference TrustedAdvisorCheckDescription The description and metadata for a Trusted Advisor check. Contents category The category of the Trusted Advisor check. Type: String description The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup). Type: String id The unique identifier for the Trusted Advisor check. Type: String metadata The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. Type: Array of strings name The display name for the Trusted Advisor check. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: TrustedAdvisorCheckDescription API Version 2013-04-15 82 AWS Support • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 83 AWS Support API Reference TrustedAdvisorCheckRefreshStatus The refresh status of a Trusted Advisor check. Contents checkId The unique identifier for the Trusted Advisor check. Type: String millisUntilNextRefreshable The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh. Type: Long status The status of the Trusted Advisor check for which a refresh has been requested: • none - The check is not refreshed or the non-success status exceeds the timeout • enqueued - The check refresh requests has entered the refresh queue • processing - The check refresh request is picked up by the rule processing engine • success - The check is successfully refreshed • abandoned - The check refresh has failed Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrustedAdvisorCheckRefreshStatus API Version 2013-04-15 84 AWS Support API Reference TrustedAdvisorCheckResult The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult. Contents categorySpecificSummary Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. Type: TrustedAdvisorCategorySpecificSummary object checkId The unique identifier for the Trusted Advisor check. Type: String flaggedResources The details about each resource listed in the check result. Type: Array of TrustedAdvisorResourceDetail objects resourcesSummary Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. Type: TrustedAdvisorResourcesSummary object status The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". Type: String timestamp The time of the last refresh of the check. Type: String TrustedAdvisorCheckResult API Version 2013-04-15 85 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-04-15 86 AWS Support API Reference TrustedAdvisorCheckSummary A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined. Contents categorySpecificSummary Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. Type: TrustedAdvisorCategorySpecificSummary object checkId The unique identifier for the Trusted Advisor check. Type: String resourcesSummary Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. Type: TrustedAdvisorResourcesSummary object status The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". Type: String timestamp The time of the last refresh of the check. Type: String hasFlaggedResources Specifies whether the Trusted Advisor check has flagged resources. Type: Boolean TrustedAdvisorCheckSummary API Version 2013-04-15 87 AWS Support
|
support-api-018
|
support-api.pdf
| 18 |
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. Type: TrustedAdvisorCategorySpecificSummary object checkId The unique identifier for the Trusted Advisor check. Type: String resourcesSummary Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. Type: TrustedAdvisorResourcesSummary object status The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". Type: String timestamp The time of the last refresh of the check. Type: String hasFlaggedResources Specifies whether the Trusted Advisor check has flagged resources. Type: Boolean TrustedAdvisorCheckSummary API Version 2013-04-15 87 AWS Support See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-04-15 88 AWS Support API Reference TrustedAdvisorCostOptimizingSummary The estimated cost savings that might be realized if the recommended operations are taken. Contents estimatedMonthlySavings The estimated monthly savings that might be realized if the recommended operations are taken. Type: Double estimatedPercentMonthlySavings The estimated percentage of savings that might be realized if the recommended operations are taken. Type: Double See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrustedAdvisorCostOptimizingSummary API Version 2013-04-15 89 AWS Support API Reference TrustedAdvisorResourceDetail Contains information about a resource identified by a Trusted Advisor check. Contents metadata Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. Type: Array of strings resourceId The unique identifier for the identified resource. Type: String status The status code for the resource identified in the Trusted Advisor check. Type: String isSuppressed Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user. Type: Boolean region The AWS Region in which the identified resource is located. Type: String See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: TrustedAdvisorResourceDetail API Version 2013-04-15 90 AWS Support • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2013-04-15 91 AWS Support API Reference TrustedAdvisorResourcesSummary Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. Contents resourcesFlagged The number of AWS resources that were flagged (listed) by the Trusted Advisor check. Type: Long resourcesIgnored The number of AWS resources ignored by Trusted Advisor because information was unavailable. Type: Long resourcesProcessed The number of AWS resources that were analyzed by the Trusted Advisor check. Type: Long resourcesSuppressed The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user. Type: Long See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrustedAdvisorResourcesSummary API Version 2013-04-15 92 AWS Support API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2013-04-15 93 AWS Support API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all
|
support-api-019
|
support-api.pdf
| 19 |
requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2013-04-15 93 AWS Support API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2013-04-15 94 AWS Support Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2013-04-15 95 AWS Support API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2013-04-15 96 AWS Support RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2013-04-15 97
|
support-ug-001
|
support-ug.pdf
| 1 |
User Guide AWS Support API Version 2025-05-13 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Support User Guide AWS Support: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Support Table of Contents User Guide Get started with AWS Support ....................................................................................................... 1 Create support cases and case management ......................................................................................... 1 Creating a support case ......................................................................................................................... 2 Describing your problem ....................................................................................................................... 4 Choosing a severity ................................................................................................................................. 5 Example: Create a support case for account and billing ................................................................ 7 Troubleshooting .................................................................................................................................... 13 Create a service quota increase .............................................................................................................. 14 Update, resolve, and reopen your cases ............................................................................................... 15 Update an existing support case ....................................................................................................... 16 Resolve a support case ........................................................................................................................ 17 Reopen a resolved case ....................................................................................................................... 18 Creating a related case ........................................................................................................................ 19 Case history ............................................................................................................................................ 21 Working with AWS SDKs .......................................................................................................................... 21 About the AWS Support API ......................................................................................................... 23 Support case management ...................................................................................................................... 23 AWS Trusted Advisor ................................................................................................................................. 24 Endpoints ..................................................................................................................................................... 24 Support in AWS SDKs ............................................................................................................................... 25 AWS Support Plans ....................................................................................................................... 26 Features of AWS Support Plans .............................................................................................................. 26 Changing AWS Support Plans ................................................................................................................. 28 Related information ............................................................................................................................. 29 AWS Trusted Advisor ..................................................................................................................... 30 Get started with Trusted Advisor Recommendations ......................................................................... 31 Sign in to the Trusted Advisor console ............................................................................................ 31 View check categories .......................................................................................................................... 33 View specific checks ............................................................................................................................. 34 Filter your checks .................................................................................................................................. 36 Refresh check results ........................................................................................................................... 37 Download check results ....................................................................................................................... 38 Organizational view .............................................................................................................................. 39 Preferences ............................................................................................................................................. 39 API Version 2025-05-13 iii AWS Support User Guide Get started with the Trusted Advisor API ............................................................................................. 40 Using Trusted Advisor as a web service ................................................................................................ 41 Get the list of available Trusted Advisor checks ............................................................................ 42 Refresh the list of available Trusted Advisor checks ..................................................................... 43 Poll a Trusted Advisor check for status changes ............................................................................ 43 Request a Trusted Advisor check result ........................................................................................... 45 Show details of a Trusted Advisor check ......................................................................................... 46 Organizational view for AWS Trusted Advisor ..................................................................................... 46 Prerequisites ........................................................................................................................................... 47 Enable organizational view ................................................................................................................. 47 Refresh Trusted Advisor checks ......................................................................................................... 48 Create organizational view reports ................................................................................................... 49 View the report summary ................................................................................................................... 53 Download an organizational view report ........................................................................................ 54 Disable organizational view ................................................................................................................ 59 Using IAM policies to allow access to organizational view .......................................................... 61 Using other AWS services to view Trusted Advisor reports ......................................................... 64 View Trusted Advisor checks powered by AWS Config ...................................................................... 73 Troubleshooting .................................................................................................................................... 73 View your Security Hub controls in Trusted Advisor .......................................................................... 74 Prerequisites ........................................................................................................................................... 75 View your Security Hub findings ....................................................................................................... 76 Refresh your Security Hub findings .................................................................................................. 77 Disable Security Hub from Trusted Advisor .................................................................................... 78 Troubleshooting .................................................................................................................................... 79 Opt in AWS Compute Optimizer for Trusted Advisor checks ............................................................ 82 Related information ............................................................................................................................. 83 Get started with AWS Trusted Advisor Priority ................................................................................... 83 Prerequisites ........................................................................................................................................... 84 Enable Trusted Advisor Priority ......................................................................................................... 85 View prioritized recommendations ................................................................................................... 85 Acknowledge a recommendation ...................................................................................................... 88 Dismiss a recommendation ................................................................................................................. 91 Resolve a recommendation ................................................................................................................ 93 Reopen a recommendation ................................................................................................................. 94 Download recommendation details .................................................................................................. 96 API Version 2025-05-13 iv AWS Support User Guide Register delegated administrators .................................................................................................... 97 Deregister delegated administrators ................................................................................................ 97 Manage Trusted Advisor Priority notifications ............................................................................... 98 Disable Trusted Advisor Priority ........................................................................................................ 99 Get started with AWS Trusted Advisor Engage (Preview) .................................................................. 99 Prerequisites ........................................................................................................................................ 100 View the Engagements Dashboard ................................................................................................. 101 View the Catalog of Engagement Types ....................................................................................... 102 Request an Engagement ................................................................................................................... 102 Edit an Engagement .......................................................................................................................... 104 Submit Attachments and Notes ...................................................................................................... 106 Change the Engagement Status ..................................................................................................... 107 Differentiate Between Recommended and Requested Engagements ...................................... 108 Search Engagements ......................................................................................................................... 109 Trusted Advisor check reference ........................................................................................................... 109 Cost optimization ............................................................................................................................... 110 Performance ........................................................................................................................................ 152 Security ................................................................................................................................................. 201 Fault tolerance .................................................................................................................................... 248 Service limits ....................................................................................................................................... 362 Operational Excellence ...................................................................................................................... 383 Change log for AWS Trusted Advisor .................................................................................................. 426 Revised checks ..................................................................................................................................... 427 Deprecated AWS Security Hub checks ........................................................................................... 427 New check: Amazon RDS Continuous Backup Not Enabled ...................................................... 428 New check: AWS CloudTrail Management Events Logging ........................................................ 428 Updated the Auto Scaling Group Resources check ..................................................................... 429 Updated the IAM Access Analyzer External Access check .......................................................... 429 Added 1 new check ............................................................................................................................ 429 Updated 3 checks ............................................................................................................................... 430 Added 4 checks ................................................................................................................................... 430 Updated 3 checks ............................................................................................................................... 430 Added 9 new checks .......................................................................................................................... 430 Updated 1 Security check and added 1 Security check ............................................................. 431 Updated 6 Security checks ............................................................................................................... 431 Updated 1 fault tolerance checks ................................................................................................... 431 API Version 2025-05-13 v
|
support-ug-002
|
support-ug.pdf
| 2 |
Deprecated AWS Security Hub checks ........................................................................................... 427 New check: Amazon RDS Continuous Backup Not Enabled ...................................................... 428 New check: AWS CloudTrail Management Events Logging ........................................................ 428 Updated the Auto Scaling Group Resources check ..................................................................... 429 Updated the IAM Access Analyzer External Access check .......................................................... 429 Added 1 new check ............................................................................................................................ 429 Updated 3 checks ............................................................................................................................... 430 Added 4 checks ................................................................................................................................... 430 Updated 3 checks ............................................................................................................................... 430 Added 9 new checks .......................................................................................................................... 430 Updated 1 Security check and added 1 Security check ............................................................. 431 Updated 6 Security checks ............................................................................................................... 431 Updated 1 fault tolerance checks ................................................................................................... 431 API Version 2025-05-13 v AWS Support User Guide Updated 9 checks ............................................................................................................................... 432 Removed 5 checks and added 1 check .......................................................................................... 432 Removed fault tolerance checks ..................................................................................................... 433 New fault tolerance check ................................................................................................................ 433 Updated fault tolerance and security checks ............................................................................... 433 New fault tolerance check ................................................................................................................ 433 Updated fault tolerance check ........................................................................................................ 434 Updated security check ..................................................................................................................... 434 New security and performance checks .......................................................................................... 434 New security check ............................................................................................................................ 434 New fault tolerance and cost optimization checks ..................................................................... 435 New fault tolerance checks .............................................................................................................. 435 New checks for Amazon RDS ........................................................................................................... 435 New AWS Trusted Advisor API ......................................................................................................... 435 Trusted Advisor check removal ........................................................................................................ 436 Integration of AWS Config checks into Trusted Advisor ............................................................ 436 New fault tolerance checks .............................................................................................................. 436 New service limits check ................................................................................................................... 437 New fault tolerance check ................................................................................................................ 437 New fault tolerance and performance checks .............................................................................. 437 New fault tolerance checks .............................................................................................................. 437 New fault tolerance checks .............................................................................................................. 438 Region Expansion of Amazon ECS Fault Tolerance Checks ........................................................ 438 New fault tolerance checks .............................................................................................................. 438 New fault tolerance checks .............................................................................................................. 434 Updates to the Trusted Advisor integration with AWS Security Hub ....................................... 439 New fault tolerance checks for AWS Resilience Hub .................................................................. 435 Update to the Trusted Advisor console ......................................................................................... 440 New checks for Amazon EC2 ........................................................................................................... 440 Added Security Hub checks to Trusted Advisor ........................................................................... 440 Added checks from AWS Compute Optimizer .............................................................................. 441 Updates to the Exposed Access Keys check .................................................................................. 441 Updated checks for AWS Direct Connect ...................................................................................... 442 AWS Security Hub controls added to the AWS Trusted Advisor console ................................. 443 New checks for Amazon EC2 and AWS Well-Architected ........................................................... 443 Updated check name for Amazon OpenSearch Service ............................................................. 444 API Version 2025-05-13 vi AWS Support User Guide Added checks for Amazon Elastic Block Store volume storage ................................................ 444 Added checks for AWS Lambda ...................................................................................................... 444 Trusted Advisor check removal ........................................................................................................ 445 Updated checks for Amazon Elastic Block Store ......................................................................... 445 Trusted Advisor check removal ........................................................................................................ 446 Trusted Advisor check removal ........................................................................................................ 447 AWS Support App in Slack ......................................................................................................... 448 Prerequisites .............................................................................................................................................. 449 Manage access to the AWS Support App widget ........................................................................ 449 Manage access to the AWS Support App ...................................................................................... 451 Authorize a Slack workspace ................................................................................................................. 457 Authorize multiple accounts ............................................................................................................ 459 Configure a Slack channel ..................................................................................................................... 460 Update your Slack channel configuration ..................................................................................... 465 Create support cases in Slack ............................................................................................................... 466 Reply to support cases in Slack ............................................................................................................ 472 Join a live chat session with AWS Support ........................................................................................ 474 Search for support cases in Slack ........................................................................................................ 480 Use your search results ..................................................................................................................... 482 Resolve support cases in Slack ............................................................................................................. 483 Reopen support cases in Slack ............................................................................................................. 484 Request service quota increases ........................................................................................................... 485 Delete a Slack channel configuration from the AWS Support App ............................................... 488 Delete a Slack workspace configuration from the AWS Support App .......................................... 488 AWS Support App in Slack commands ............................................................................................... 489 Slack channel commands ................................................................................................................. 489 Live chat channel commands .......................................................................................................... 490 View AWS Support App correspondences in the AWS Support Center Console ......................... 491 Create AWS CloudFormation resources for the AWS Support App in Slack ................................. 491 AWS Support App and AWS CloudFormation templates ........................................................... 492 Create Slack configuration resources for your organization ...................................................... 492 Learn more about CloudFormation ................................................................................................ 497 Create AWS Support App resources by using Terraform ............................................................ 497 Security ........................................................................................................................................ 499 Data protection ........................................................................................................................................ 500 Security for support cases ..................................................................................................................... 501 API Version 2025-05-13 vii AWS Support User Guide Identity and access management ......................................................................................................... 502 Audience ............................................................................................................................................... 502 Authenticating with identities ......................................................................................................... 503 Managing access using policies ....................................................................................................... 506 How AWS Support works with IAM ................................................................................................ 508 Identity-based policy examples ....................................................................................................... 510 Using service-linked roles ................................................................................................................. 512 AWS managed policies ...................................................................................................................... 520 Manage access to AWS Support Center ........................................................................................ 581 Manage access to AWS Support Plans ........................................................................................... 588 Manage access to AWS Trusted Advisor ........................................................................................ 592 Example Service Control Policies for AWS Trusted Advisor ....................................................... 605 Troubleshooting .................................................................................................................................. 606 Incident response ..................................................................................................................................... 609 Logging and monitoring in AWS Support and AWS Trusted Advisor ............................................ 609 Compliance validation ............................................................................................................................ 610 Resilience ................................................................................................................................................... 611 Infrastructure security ............................................................................................................................. 611 Configuration and vulnerability analysis ............................................................................................ 612 Code examples ............................................................................................................................. 613 Basics .......................................................................................................................................................... 621 Hello Support ...................................................................................................................................... 621 Learn the basics .................................................................................................................................. 629 Actions .................................................................................................................................................. 686 Monitoring and logging for
|
support-ug-003
|
support-ug.pdf
| 3 |
................................................................................................................. 512 AWS managed policies ...................................................................................................................... 520 Manage access to AWS Support Center ........................................................................................ 581 Manage access to AWS Support Plans ........................................................................................... 588 Manage access to AWS Trusted Advisor ........................................................................................ 592 Example Service Control Policies for AWS Trusted Advisor ....................................................... 605 Troubleshooting .................................................................................................................................. 606 Incident response ..................................................................................................................................... 609 Logging and monitoring in AWS Support and AWS Trusted Advisor ............................................ 609 Compliance validation ............................................................................................................................ 610 Resilience ................................................................................................................................................... 611 Infrastructure security ............................................................................................................................. 611 Configuration and vulnerability analysis ............................................................................................ 612 Code examples ............................................................................................................................. 613 Basics .......................................................................................................................................................... 621 Hello Support ...................................................................................................................................... 621 Learn the basics .................................................................................................................................. 629 Actions .................................................................................................................................................. 686 Monitoring and logging for Support ......................................................................................... 756 Monitoring Support cases with EventBridge ...................................................................................... 756 Creating an EventBridge rule for AWS Support cases ................................................................ 757 Example AWS Support events ......................................................................................................... 758 See also ................................................................................................................................................ 761 Logging AWS Support API calls with AWS CloudTrail ...................................................................... 761 AWS Support information in CloudTrail ........................................................................................ 761 AWS Trusted Advisor information in CloudTrail logging ............................................................ 762 Understanding AWS Support log file entries ............................................................................... 763 Logging AWS Support App API calls with CloudTrail ....................................................................... 765 AWS Support App information in CloudTrail ............................................................................... 765 Understanding AWS Support App log file entries ....................................................................... 766 API Version 2025-05-13 viii AWS Support User Guide Monitoring and logging for Support Plans ............................................................................... 771 Logging AWS Support Plans API calls with AWS CloudTrail ........................................................... 771 AWS Support Plans information in CloudTrail ............................................................................. 772 Understanding AWS Support Plans log file entries ..................................................................... 773 Logging console actions for changes to your Support plan ...................................................... 779 Monitoring and logging for Trusted Advisor ............................................................................. 783 Monitoring Trusted Advisor check results with EventBridge .......................................................... 784 Creating CloudWatch alarms to monitor Trusted Advisor metrics ................................................ 786 Prerequisites ........................................................................................................................................ 786 CloudWatch metrics for Trusted Advisor ....................................................................................... 791 Trusted Advisor metrics and dimensions ....................................................................................... 797 Logging AWS Trusted Advisor console actions with AWS CloudTrail ............................................ 798 Trusted Advisor information in CloudTrail .................................................................................... 799 Example: Trusted Advisor Log File Entries .................................................................................... 801 Troubleshooting resources .......................................................................................................... 806 Service-specific troubleshooting ........................................................................................................... 806 Document history ........................................................................................................................ 811 Earlier updates .......................................................................................................................................... 840 AWS Glossary ............................................................................................................................... 844 API Version 2025-05-13 ix AWS Support User Guide Getting started with AWS Support Support offers a range of plans that provide access to tools and expertise that support the success and operational health of your AWS solutions. All support plans provide 24/7 access to customer service, AWS documentation, technical papers, and support forums. For technical support and more resources to plan, deploy, and improve your AWS environment, you can choose a support plan for your AWS use case. Notes • To create a support case in the AWS Management Console, see Creating a support case. • For more information about the different AWS Support plans, see Compare AWS Support plans and Changing AWS Support Plans. • Support plans offer different response times for your support cases. See Choosing a severity and Response times. Topics • Creating support cases and case management • Creating a service quota increase • Updating, resolving, and reopening your case • Using AWS Support with an AWS SDK Creating support cases and case management In the AWS Management Console, you can create three types of customer cases in Support: • Account and billing support cases are available to all AWS customers. You can get help with billing and account questions. • Service limit increase requests are available to all AWS customers. For more information about the default service quotas, formerly referred to as limits, see AWS service quotas in the AWS General Reference. Create support cases and case management API Version 2025-05-13 1 AWS Support User Guide • Technical support cases connect you to technical support for help with service-related technical issues and, in some cases, third-party applications. If you have Basic Support, you can't create a technical support case. Notes • To change your support plan, see Changing AWS Support Plans. • To close your account, see Closing an Account in the AWS Billing User Guide. • To find common troubleshooting topics for AWS services, see Troubleshooting resources. • If you're a customer of an AWS Partner that is part of the AWS Partner Network, and you use Resold Support, contact your AWS Partner directly for any billing related issues. AWS Support can't assist with non-technical issues for Resold Support, such as billing and account management. For more information, see the following topics: • How AWS Partners can determine AWS Support plans in an organization • AWS Partner-Led Support Creating a support case You can create a support case in the Support Center of the AWS Management Console. Notes • You can sign in to Support Center as an AWS Identity and Access Management (IAM) user. For more information, see Manage access to AWS Support Center. • If you can't sign in to Support Center and create a support case, you can use the Contact Us page instead. You
|
support-ug-004
|
support-ug.pdf
| 4 |
Support, such as billing and account management. For more information, see the following topics: • How AWS Partners can determine AWS Support plans in an organization • AWS Partner-Led Support Creating a support case You can create a support case in the Support Center of the AWS Management Console. Notes • You can sign in to Support Center as an AWS Identity and Access Management (IAM) user. For more information, see Manage access to AWS Support Center. • If you can't sign in to Support Center and create a support case, you can use the Contact Us page instead. You can use this page to get help with billing and account issues. To create a support case 1. Sign in to the AWS Support Center Console. Creating a support case API Version 2025-05-13 2 AWS Support Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. 2. Choose Create case. 3. Choose one of the following options: • Account and billing • Technical User Guide ) • For service quota increases, choose Looking for service limit increases? and then follow the instructions for Creating a service quota increase. 4. Choose the Service, Category, and Severity. Tip You can use the recommended solutions that appear for commonly asked questions. 5. Choose Next step: Additional information 6. On the Additional information page, for Subject, enter a title about your issue. 7. For Description, follow the prompts to describe your case, such as the following: • Error messages that you received • Troubleshooting steps that you followed • How you're accessing the service: • AWS Management Console • AWS Command Line Interface (AWS CLI) • API operations 8. (Optional) Choose Attach files to add any relevant files to your case, such as error logs or screenshots. You can attach up to three files. Each file can be up to 5 MB. 9. Choose Next step: Solve now or contact us. 10. On the Contact us page, choose your preferred language. 11. Choose your preferred contact method. You can choose one of the following options: Creating a support case API Version 2025-05-13 3 AWS Support User Guide a. Web – Receive a reply in Support Center. b. Chat – Start a live chat with a support agent. If you can't connect to a chat, see Troubleshooting. c. Phone – Receive a phone call from a support agent. If you choose this option, enter the following information: • Country or region • Phone number • (Optional) Extension Notes • The contact options that appear depend on the type of case and your support plan. • You can choose Discard draft to clear your support case draft. 12. (Optional) If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, the Additional contacts option appears. You can enter the email addresses of people to notify when the status of the case changes. If you're signed in as an IAM user, include your email address. If you're signed in with your root account email address and password, you don't need to include your email address Note If you have the Basic Support plan, the Additional contacts option isn't available. However, the Operations contact specified in the Alternate Contacts section of the My Account page receives copies of the case correspondence, but only for the specific case types of account and billing, and technical. 13. Review your case details and then choose Submit. Your case ID number and summary appear. Describing your problem Make your description as detailed as possible. Include relevant resource information, along with anything else that might help us understand your issue. For example, to troubleshoot performance, include timestamps and logs. For feature requests or general guidance questions, include a Describing your problem API Version 2025-05-13 4 AWS Support User Guide description of your environment and purpose. In all cases, follow the Description Guidance that appears on your case submission form. When you provide as much detail as possible, you increase the chances that your case can be resolved quickly. Choosing a severity You might be inclined to always create a support case at the highest severity that your support plan allows. However, we recommend that you choose the highest severities for cases that can't be worked around or that directly affect production applications. For information about building your services so that losing single resources doesn't affect your applications, see the Building Fault- Tolerant Applications on AWS technical paper. The following table lists the severity levels, response times, and example problems. Notes • You can't change the severity code for a support case after you create one. If your situation changes, work with the Support agent for your support case. • For more information about the severity level, see the AWS Support API Reference. Severity
|
support-ug-005
|
support-ug.pdf
| 5 |
that you choose the highest severities for cases that can't be worked around or that directly affect production applications. For information about building your services so that losing single resources doesn't affect your applications, see the Building Fault- Tolerant Applications on AWS technical paper. The following table lists the severity levels, response times, and example problems. Notes • You can't change the severity code for a support case after you create one. If your situation changes, work with the Support agent for your support case. • For more information about the severity level, see the AWS Support API Reference. Severity level First-res ponse Severity code time Description and support plan General guidance low 24 hours System impaired normal 12 hours You have a general development question, or you want to request a feature. (*Developer, Business, Enterprise On-Ramp, or Enterprise Support plan) Non-critical functions of your application are behaving abnormally, or you have a time- sensitive development question. (*Developer, Business, Enterprise On-Ramp, or Enterprise Support plan) Choosing a severity API Version 2025-05-13 5 AWS Support User Guide Severity level First-res ponse Severity code time Description and support plan Production system impaired high 4 hours Production system down urgent 1 hour Important functions of your application are impaired or degraded. (Business, Enterprise On-Ramp, or Enterprise Support plan) Your business is significantly impacted. Important functions of your application aren't available. (Business, Enterprise On-Ramp, or Enterprise Support plan) Business-critical system down critical 15 minutes Your business is at risk. Critical functions of your application aren't available (Enterprise Support plan). Note that this is 30 minutes for the Enterprise On-Ramp Support plan. Response times We make every reasonable effort to respond to your initial request within the indicated timeframe. For information about the scope of support for each Support plan, see AWS Support features. If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, you have 24/7 access for technical support. *For Developer Support, response targets for support cases are calculated in business hours. Business hours are generally defined as 08:00 to 18:00 in the customer country, excluding holidays and weekends. These times can vary in countries with multiple time zones. The customer country information appears in the Contact Information section of the My Account page in the AWS Management Console. Note If you choose Japanese as your preferred contact language for support cases, support in Japanese may be available as follows: • If you need customer service for non-technical support cases, or if you have a Developer Support plan and need technical support, support in Japanese is available during Choosing a severity API Version 2025-05-13 6 AWS Support User Guide business hours in Japan defined as 09:00 AM to 06:00 PM Japan Standard Time (GMT+9), excluding holidays and weekends. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Japanese. If you choose Chinese as your preferred contact language for support cases, support in Chinese may be available as follows: • If you need customer service for non-technical support cases, support in Chinese is available 09:00 AM to 06:00 PM (GMT+8), excluding holidays and weekends. • If you have a Developer Support plan, technical support in Chinese is available during business hours generally defined as 8:00 AM to 6:00 PM in your country as set in My Account, excluding holidays and weekends. These times may vary in countries with multiple time zones. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Chinese. If you choose Korean as your preferred contact language for support cases, support in Korean may be available as follows: • If you need customer service for non-technical support cases, support in Korean is available during business hours in Korea defined as 09:00 AM to 06:00 PM Korean Standard Time (GMT+9), excluding holidays and weekends. • If you have a Developer Support plan, technical support in Korean is available during business hours generally defined as 8:00 AM to 6:00 PM in your country as set in My Account, excluding holidays and weekends. These times may vary in countries with multiple time zones. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Korean. Example: Create a support case for account and billing The following example is a support case for a billing and account issue. Example: Create a support case for account and billing API Version 2025-05-13 7 AWS Support User Guide 1. Create case – Choose the type of case to create. In this example, the case type is Account and billing. Example: Create a support case for account and billing API Version 2025-05-13 8 AWS Support Note User Guide If you have the Basic Support plan, you can't create a technical support case. 2.
|
support-ug-006
|
support-ug.pdf
| 6 |
technical support is available 24/7 in Korean. Example: Create a support case for account and billing The following example is a support case for a billing and account issue. Example: Create a support case for account and billing API Version 2025-05-13 7 AWS Support User Guide 1. Create case – Choose the type of case to create. In this example, the case type is Account and billing. Example: Create a support case for account and billing API Version 2025-05-13 8 AWS Support Note User Guide If you have the Basic Support plan, you can't create a technical support case. 2. Service – If your question affects multiple services, choose the service that's most applicable. 3. Category – Choose the category that best fits your use case. When you choose a category, links to information that might resolve your problem appear below. 4. Severity – Customers with a paid support plan can choose the General guidance (1-day response time) or System impaired (12-hour response time) severity level. Customers with a Business Support plan can also choose Production system impaired (4-hour response) or Production system down (1-hour response). Customers with an Enterprise On-Ramp or Enterprise Support plan can choose Business-critical system down (15-minute response for Enterprise Support and 30-minute response for Enterprise On-Ramp). Response times are for first response from AWS Support. These response times don't apply to subsequent responses. For third-party issues, response times can be longer, depending on the availability of skilled personnel. For more information, see Choosing a severity. Note Based on your category choice, you might be prompted for more information. After you specify the case type and classification, you can specify the description and how you want to be contacted. Example: Create a support case for account and billing API Version 2025-05-13 9 AWS Support User Guide 1. Subject – Enter a title that briefly describes your issue. Example: Create a support case for account and billing API Version 2025-05-13 10 AWS Support User Guide 2. Description – Describe your support case. This is the most important information that you provide to Support. For some service and category combinations, a prompt appears with related information. Use these links to help resolve your issue. For more information, see Describing your problem. 3. Attachments – Attach screenshots and other files that can help support agents resolve your case faster. You can attach up to three files. Each file can be up to 5 MB. After you add your case details, you can choose how you want to be contacted. 1. Preferred contact language – Choose your preferred language. Currently you can choose Chinese, English, Japanese, or Korean. The customized contact options in your preferred language will be shown by your support plan. 2. Choose a contact method. The contact options that appear depend on the type of case and your support plan. • If you choose Web, you can read and respond to the case progress in Support Center. • Choose Chat or Phone. If you choose Phone, you're prompted for a callback number. 3. Choose Submit when your information is complete and you're ready to create the case. Example: Create a support case for account and billing API Version 2025-05-13 11 AWS Support Note User Guide If you choose Japanese as your preferred contact language for support cases, support in Japanese may be available as follows: • If you need customer service for non-technical support cases, or if you have a Developer Support plan and need technical support, support in Japanese is available during business hours in Japan defined as 09:00 AM to 06:00 PM Japan Standard Time (GMT+9), excluding holidays and weekends. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Japanese. If you choose Chinese as your preferred contact language for support cases, support in Chinese may be available as follows: • If you need customer service for non-technical support cases, support in Chinese is available 09:00 AM to 06:00 PM (GMT+8), excluding holidays and weekends. • If you have a Developer Support plan, technical support in Chinese is available during business hours generally defined as 8:00 AM to 6:00 PM in your country as set in My Account, excluding holidays and weekends. These times may vary in countries with multiple time zones. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Chinese. If you choose Korean as your preferred contact language for support cases, support in Korean may be available as follows: • If you need customer service for non-technical support cases, support in Korean is available during business hours in Korea defined as 09:00 AM to 06:00 PM Korean Standard Time (GMT+9), excluding holidays and weekends. • If you have a Developer Support plan, technical support
|
support-ug-007
|
support-ug.pdf
| 7 |
My Account, excluding holidays and weekends. These times may vary in countries with multiple time zones. • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Chinese. If you choose Korean as your preferred contact language for support cases, support in Korean may be available as follows: • If you need customer service for non-technical support cases, support in Korean is available during business hours in Korea defined as 09:00 AM to 06:00 PM Korean Standard Time (GMT+9), excluding holidays and weekends. • If you have a Developer Support plan, technical support in Korean is available during business hours generally defined as 8:00 AM to 6:00 PM in your country as set in My Account, excluding holidays and weekends. These times may vary in countries with multiple time zones. Example: Create a support case for account and billing API Version 2025-05-13 12 AWS Support User Guide • If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, technical support is available 24/7 in Korean. Troubleshooting If you have difficulty when you create or manage your support case, see the following troubleshooting information. I want to reopen a live chat for my case You can reply to your existing support case to open another chat window. For more information, see Updating an existing support case. I can't connect to a live chat If you chose the Chat option but you can't connect to the chat window, first perform the following checks: • Ensure that you've configured your browser to allow pop-up windows in Support Center. Note Review the settings for your browser. For more information, see the Chrome Help and Firefox Support websites. • Ensure that you've configured your network so that you can use AWS Support: • Your network can access the *.connect.us-east-1.amazonaws.com endpoint. Note For AWS GovCloud (US), the endpoint is *.connect-fips.us- east-1.amazonaws.com. • Your firewall supports web socket connections. If you still can’t connect to the chat window, contact AWS Support using email or phone contact options. Troubleshooting API Version 2025-05-13 13 AWS Support User Guide Creating a service quota increase To improve the performance of your service, request increases to your service quotas (formerly referred to as limits). Note You can also use the Service Quotas service to request increases directly for your services. Currently, Service Quotas doesn't support service quotas for all services. For more information, see What is Service Quotas? in the Service Quotas User Guide. To create a support case for service quota increases 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. 2. Choose Create case. 3. Choose Looking for service limit increases? 4. To request an increase, follow the prompts. Possible options include the following: ) • Limit type • Severity Note Based on your category choice, the prompts might request more information. 5. 6. 7. 8. For Requests, choose the Region. For Limit, choose the service limit type. For New limit value, enter the value that you want. (Optional) To request another increase, choose Add another request. Create a service quota increase API Version 2025-05-13 14 AWS Support User Guide 9. For Case description, describe your support case. 10. For Contact options page, choose your preferred language and how you want to be contacted. You can choose one of the following options: • Web – Receive a reply in Support Center. • Chat – Start a live chat with a support agent. If you can't connect to a chat, see Troubleshooting. • Phone – Receive a phone call from a support agent. If you choose this option, enter the following information: • Country/Region • Phone number • (Optional) Extension 11. Choose Submit. Your case ID number and summary appear. Updating, resolving, and reopening your case After you create your support case, you can monitor the status of your case in Support Center. A new case begins in the Unassigned state. When a support agent begins work on a case, the status changes to Work in Progress. The support agent might respond to your case to ask for more information (Pending Customer Action) or to let you know that the case is being investigated (Pending Amazon Action). When your case is updated, you receive email with the correspondence and a link to the case in Support Center. Use the link in the email message to navigate to the support case. You can't respond to case correspondences by email. Notes • You must sign in to the AWS account that submitted the support case. If you sign in as an AWS Identity and Access Management (IAM) user, you must have the required permissions to view support cases. For more information, see Manage access to
|
support-ug-008
|
support-ug.pdf
| 8 |
or to let you know that the case is being investigated (Pending Amazon Action). When your case is updated, you receive email with the correspondence and a link to the case in Support Center. Use the link in the email message to navigate to the support case. You can't respond to case correspondences by email. Notes • You must sign in to the AWS account that submitted the support case. If you sign in as an AWS Identity and Access Management (IAM) user, you must have the required permissions to view support cases. For more information, see Manage access to AWS Support Center. • If you don't respond to the case within a few days, AWS Support resolves the case automatically. Update, resolve, and reopen your cases API Version 2025-05-13 15 AWS Support User Guide • Support cases that have been in the resolved state for more than 14 days can't be reopened. If you have a similar issue that is related to the resolved case, you can create a related case. For more information, see Creating a related case. Topics • Updating an existing support case • Resolving a support case • Reopening a resolved case • Creating a related case • Case history Updating an existing support case You can update your case to provide more information for the support agent. For example, you can reply to correspondences, start another live chat, add additional email recipients, and so on. However, you can't update the severity of a case after you've created it. For more information, see Choosing a severity. To update an existing support case 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. ) 2. Under Open support cases, choose the Subject of the support case. 3. Choose Reply. In the Correspondence section, you can also make any of the following changes: • Provide information that the support agent requested • Upload file attachments • Change your preferred contact method Update an existing support case API Version 2025-05-13 16 AWS Support User Guide • Add email addresses to receive case updates 4. Choose Submit. Tip If you closed a chat window and you want to start another live chat, add a Reply to your support case, choose Chat, and then choose Submit. A new pop-up chat window opens. Resolving a support case When you're satisfied with the response or your problem is solved, you can resolve the case in Support Center. To resolve a support case 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. ) 2. Under Open support cases, choose the Subject of the support case that you want to resolve. 3. (Optional) Choose Reply and in the Correspondence section, enter why you're resolving the case, and then choose Submit. For example, you can enter information about how you fixed the issue yourself in case you need this information for future reference. 4. Choose Resolve case. 5. In the dialog box, choose Ok to resolve the case. Note If AWS Support resolved your case for you, you can use the feedback link to provide more information about your experience with AWS Support. Resolve a support case API Version 2025-05-13 17 AWS Support Example : Feedback links User Guide The following screenshot shows the feedback links in the correspondence of a case in Support Center. Reopening a resolved case If you're experiencing the same issue again, you can reopen the original case. Provide details about when the issue occurred again and what troubleshooting steps that you tried. Include any related case numbers so that the support agent can refer to previous correspondences. Notes • You can reopen your support case up to 14 days from when your issue was resolved. However, you can't reopen a case that has been inactive for more than 14 days. You can create a new case or a related case. For more information, see Creating a related case. • If you reopen an existing case that has different information than your current issue, the support agent might ask you to create a new case. To reopen a resolved case 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. ) Reopen a resolved case API Version 2025-05-13 18 AWS Support User Guide 2. Choose View all cases and then choose the Subject or the Case ID of the support case that you want to reopen. 3. Choose Reopen case. 4. Under Correspondence, for Reply, enter the case details. 5. 6. (Optional) Choose
|
support-ug-009
|
support-ug.pdf
| 9 |
current issue, the support agent might ask you to create a new case. To reopen a resolved case 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. ) Reopen a resolved case API Version 2025-05-13 18 AWS Support User Guide 2. Choose View all cases and then choose the Subject or the Case ID of the support case that you want to reopen. 3. Choose Reopen case. 4. Under Correspondence, for Reply, enter the case details. 5. 6. (Optional) Choose Choose files to attach files to your case. You can attach up to 3 files. For Contact methods, choose one of the following options: • Web – Get notified by email and the Support Center. • • Chat – Chat online with a support agent. Phone – Receive a phone call from a support agent. 7. (Optional) For Additional contacts, enter email addresses for other people that you want to receive case correspondences. 8. Review your case details and choose Submit. Creating a related case After 14 days of inactivity, you can't reopen a resolved case. If you have a similar issue that is related to the resolved case, you can create a related case. This related case will include a link to the previously resolved case, so that the support agent can review the previous case details and correspondences. If you're experiencing a different issue, we recommend that you create a new case. To create a related case 1. Sign in to the AWS Support Center Console. Tip In the AWS Management Console, you can also choose the question mark icon ( and then choose Support Center. ) 2. Choose View all cases and then choose the Subject or the Case ID of the support case that you want to reopen. 3. Choose Reopen case. Creating a related case API Version 2025-05-13 19 AWS Support User Guide 4. In the dialog box, choose Create related case. The previous case information will be automatically added to your related case. If you have a different issue, choose Create new case. 5. Follow the same steps to create your case. See Creating a support case. Note By default, your related case has the same Type, Category, and Severity of the previous case. You can update the case details as needed. 6. Review your case details and choose Submit. After you create your case, the previous case appears in the Related cases section, such as in the following example. Creating a related case API Version 2025-05-13 20 AWS Support User Guide Case history You can view case history information up to 24 months after you create a case. Using AWS Support with an AWS SDK AWS software development kits (SDKs) are available for many popular programming languages. Each SDK provides an API, code examples, and documentation that make it easier for developers to build applications in their preferred language. Case history API Version 2025-05-13 21 AWS Support User Guide SDK documentation Code examples AWS SDK for C++ AWS SDK for C++ code examples AWS CLI AWS SDK for Go AWS SDK for Java AWS CLI code examples AWS SDK for Go code examples AWS SDK for Java code examples AWS SDK for JavaScript AWS SDK for JavaScript code examples AWS SDK for Kotlin AWS SDK for Kotlin code examples AWS SDK for .NET AWS SDK for PHP AWS SDK for .NET code examples AWS SDK for PHP code examples AWS Tools for PowerShell Tools for PowerShell code examples AWS SDK for Python (Boto3) AWS SDK for Python (Boto3) code examples AWS SDK for Ruby AWS SDK for Rust AWS SDK for Ruby code examples AWS SDK for Rust code examples AWS SDK for SAP ABAP AWS SDK for SAP ABAP code examples AWS SDK for Swift AWS SDK for Swift code examples Example availability Can't find what you need? Request a code example by using the Provide feedback link at the bottom of this page. Working with AWS SDKs API Version 2025-05-13 22 AWS Support User Guide About the AWS Support API The AWS Support API provides access to some of the features in the AWS Support Center. The API provides two different groups of operations: • Support case management operations to manage the entire life cycle of your AWS support cases, from creating a case to resolving it • AWS Trusted Advisor operations to access AWS Trusted Advisor checks Note You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. For more information, see Support. For more information about the operations and data types provided by Support, see the AWS Support API Reference. Topics • Support case management • AWS Trusted Advisor • Endpoints •
|
support-ug-010
|
support-ug.pdf
| 10 |
in the AWS Support Center. The API provides two different groups of operations: • Support case management operations to manage the entire life cycle of your AWS support cases, from creating a case to resolving it • AWS Trusted Advisor operations to access AWS Trusted Advisor checks Note You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. For more information, see Support. For more information about the operations and data types provided by Support, see the AWS Support API Reference. Topics • Support case management • AWS Trusted Advisor • Endpoints • Support in AWS SDKs Support case management You can use the API to perform the following tasks: • Open a support case • Get a list and detailed information about recent support cases • Filter your search for support cases by dates and case identifiers, including resolved cases • Add communications and file attachments to your cases, and add the email recipients for case correspondences. You can attach up to three files. Each file can be up to 5 MB • Resolve your cases Support case management API Version 2025-05-13 23 AWS Support User Guide The AWS Support API supports CloudTrail logging for support case management operations. For more information, see Logging AWS Support API calls with AWS CloudTrail. For code examples that demonstrate how to manage the entire life cycle of a support case, see Code examples for Support using AWS SDKs.. AWS Trusted Advisor You can use the Trusted Advisor operations to perform the following tasks: • Get the names and identifiers for the Trusted Advisor checks • Request that a Trusted Advisor check be run against your AWS account and resources • Get summaries and detailed information for your Trusted Advisor check results • Refresh your Trusted Advisor checks • Get the status of each Trusted Advisor check The AWS Support API supports CloudTrail logging for Trusted Advisor operations. For more information, see AWS Trusted Advisor information in CloudTrail logging. You can use Amazon CloudWatch Events to monitor for changes to your check results for Trusted Advisor. For more information, see Monitoring AWS Trusted Advisor check results with Amazon EventBridge. For example Java code that demonstrates how to use the Trusted Advisor operations, see Using Trusted Advisor as a web service. Endpoints Support is a global service. This means that any endpoint that you use will update your support cases in the Support Center Console. For example, if you use the US East (N. Virginia) endpoint to create a case, you can use the US West (Oregon) or Europe (Ireland) endpoint to add a correspondence to the same case. You can use the following endpoints for the Support API: • US East (N. Virginia) – https://support.us-east-1.amazonaws.com • US West (Oregon) – https://support.us-west-2.amazonaws.com AWS Trusted Advisor API Version 2025-05-13 24 AWS Support User Guide • Europe (Ireland) – https://support.eu-west-1.amazonaws.com Important • If you call the CreateCase operation to create test support cases, then we recommend that you include a subject line, such as TEST CASE-Please ignore. After you're done with your test support case, call the ResolveCase operation to resolve it. • To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information about AWS endpoints, see AWS Support endpoints and quotas in the Amazon Web Services General Reference. Support in AWS SDKs The AWS Command Line Interface (AWS CLI), and the AWS Software Development Kits (SDKs) include support for the Support API. For a list of languages that support the AWS Support API, choose an operation name, such as CreateCase, and in the See Also section, choose your preferred language. Support in AWS SDKs API Version 2025-05-13 25 AWS Support User Guide AWS Support Plans You can change your AWS Support Plans for your account based on your business needs. Topics • Features of AWS Support Plans • Changing AWS Support Plans Features of AWS Support Plans Support offers five support plans: • Basic • Developer • Business • Enterprise On-Ramp • Enterprise Basic Support offers support for account and billing questions and service quota increases. The other plans offer a number of technical support cases with pay-by-the-month pricing and no long- term contracts. All AWS customers automatically have 24x7 access to these features of Basic Support: • One-on-one responses to account and billing questions • Support forums • Service health checks • Documentation, technical papers, and best practice guides Customers with a Developer Support plan have access to these additional features: • Best practice guidance • Client-side diagnostic tools Features of AWS Support Plans API Version 2025-05-13 26 AWS Support User Guide • Building-block architecture support: guidance on
|
support-ug-011
|
support-ug.pdf
| 11 |
and billing questions and service quota increases. The other plans offer a number of technical support cases with pay-by-the-month pricing and no long- term contracts. All AWS customers automatically have 24x7 access to these features of Basic Support: • One-on-one responses to account and billing questions • Support forums • Service health checks • Documentation, technical papers, and best practice guides Customers with a Developer Support plan have access to these additional features: • Best practice guidance • Client-side diagnostic tools Features of AWS Support Plans API Version 2025-05-13 26 AWS Support User Guide • Building-block architecture support: guidance on how to use AWS products, features, and services together • Supports an unlimited number of support cases that can be opened by any user with permissions. In addition, customers with a Business, Enterprise On-Ramp, or Enterprise Support plan have access to these features: • Use-case guidance – What AWS products, features, and services to use to best support your specific needs. • AWS Trusted Advisor – A feature of Support, which inspects customer environments and identifies opportunities to save money, close security gaps, and improve system reliability and performance. You can access all Trusted Advisor checks. • The AWS Support API to interact with Support Center and Trusted Advisor. You can use the AWS Support API to automate support case management and Trusted Advisor operations. • Third-party software support – Help with Amazon Elastic Compute Cloud (Amazon EC2) instance operating systems and configuration. Also, help with the performance of the most popular third- party software components on AWS. Third-party software support isn't available for customers on Basic or Developer Support plans. • Supports an unlimited number of AWS Identity and Access Management (IAM) users who can open technical support cases. In addition, customers with an Enterprise On-Ramp or Enterprise Support plan have access to these features: • Application architecture guidance – Consultative guidance on how services fit together to meet your specific use case, workload, or application. • Infrastructure event management – Short-term engagement with AWS Support to get a deep understanding of your use case. After analysis, provide architectural and scaling guidance for an event. • Technical account manager – Work with a technical account manager (TAM) for your specific use cases and applications. • Management business reviews. Features of AWS Support Plans API Version 2025-05-13 27 AWS Support User Guide For more information about features and pricing for each support plan, see AWS Support and Compare AWS Support plans. Some features, such as 24x7 phone and chat support, aren't available in all languages. Note If you work with an AWS partner and want to learn more about Partner-led Support, see AWS Partner-Led Support Changing AWS Support Plans You can use the AWS Support Plans console to change your support plan for your AWS account. To change your support plan, you must have AWS Identity and Access Management (IAM) permissions or sign in to your account as a root user. For more information, see Manage access to AWS Support Plans and AWS managed policies for AWS Support Plans. To change your support plan 1. Sign in to the AWS Support Plans console at https://console.aws.amazon.com/support/plans/ home. 2. 3. (Optional) On the AWS Support Plans page, compare the support plans. For more information about the pricing, visit the pricing detail page. (Optional) Under AWS Support pricing example, choose See examples, and then choose one of the support plan options to see the estimated cost. 4. When you decide on a plan, choose Review downgrade or Review upgrade for the plan that you want. Notes • If you sign up for a paid support plan, you’re responsible for a minimum one month subscription of AWS Support. For more information, see the AWS Support FAQs. • If you have an Enterprise On-Ramp or Enterprise Support plan, on the Change plan confirmation dialog box, contact Support to change your support plan. 5. In the Change plan confirmation dialog box, you can expand the support items to see the features that you want to add or remove from your account. Changing AWS Support Plans API Version 2025-05-13 28 AWS Support User Guide Under Pricing, you can view the projected one-time charges for the new support plan. 6. Choose Accept and agree. Related information For more information about AWS Support Plans, see the AWS Support FAQs. You can also choose Contact us from the Support Plans console. To close your account, see Closing an Account in the AWS Billing User Guide. Related information API Version 2025-05-13 29 AWS Support User Guide AWS Trusted Advisor Trusted Advisor draws upon best practices learned from serving hundreds of thousands of AWS customers. Trusted Advisor inspects your AWS environment, and then makes recommendations when opportunities exist to save money, improve system availability and performance, or help close security gaps. If
|
support-ug-012
|
support-ug.pdf
| 12 |
plan. 6. Choose Accept and agree. Related information For more information about AWS Support Plans, see the AWS Support FAQs. You can also choose Contact us from the Support Plans console. To close your account, see Closing an Account in the AWS Billing User Guide. Related information API Version 2025-05-13 29 AWS Support User Guide AWS Trusted Advisor Trusted Advisor draws upon best practices learned from serving hundreds of thousands of AWS customers. Trusted Advisor inspects your AWS environment, and then makes recommendations when opportunities exist to save money, improve system availability and performance, or help close security gaps. If you have a Basic or Developer Support plan, you can use the Trusted Advisor console to access all checks in the Service Limits category and five checks in the Security category. If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, you can use the Trusted Advisor console and the AWS Trusted Advisor API to access all Trusted Advisor checks. You also can use Amazon CloudWatch Events to monitor the status of Trusted Advisor checks. For more information, see Monitoring AWS Trusted Advisor check results with Amazon EventBridge. You can access Trusted Advisor in the AWS Management Console. For more information about controlling access to the Trusted Advisor console, see Manage access to AWS Trusted Advisor. For more information, see Trusted Advisor. Topics • Get started with Trusted Advisor Recommendations • Get started with the Trusted Advisor API • Using Trusted Advisor as a web service • Organizational view for AWS Trusted Advisor • View AWS Trusted Advisor checks powered by AWS Config • Viewing AWS Security Hub controls in AWS Trusted Advisor • Opt in AWS Compute Optimizer for Trusted Advisor checks • Get started with AWS Trusted Advisor Priority • Get started with AWS Trusted Advisor Engage (Preview) • AWS Trusted Advisor check reference • Change log for AWS Trusted Advisor API Version 2025-05-13 30 AWS Support User Guide Get started with Trusted Advisor Recommendations You can use the Trusted Advisor Recommendations page of the Trusted Advisor console to review check results for your AWS account and then follow the recommended steps to fix any issues. For example, Trusted Advisor might recommend that you delete unused resources to reduce your monthly bill, such as an Amazon Elastic Compute Cloud (Amazon EC2) instance. You can also use the AWS Trusted Advisor API to perform operations on your Trusted Advisor checks. For more information, see the AWS Trusted Advisor API Reference Topics • Sign in to the Trusted Advisor console • View check categories • View specific checks • Filter your checks • Refresh check results • Download check results • Organizational view • Preferences Sign in to the Trusted Advisor console You can view the checks and the status of each check in the Trusted Advisor console. Note You must have AWS Identity and Access Management (IAM) permissions to access the Trusted Advisor console. For more information, see Manage access to AWS Trusted Advisor. To sign in to the Trusted Advisor console 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Recommendations page, view the summary for each check category: Get started with Trusted Advisor Recommendations API Version 2025-05-13 31 AWS Support User Guide • Action recommended (red) – Trusted Advisor recommends an action for the check. For example, a check that detects a security issue for your IAM resources might recommend urgent steps. • Investigation recommended (yellow) – Trusted Advisor detects a possible issue for the check. For example, a check that reaches a quota for a resource might recommend ways to delete unused resources. • Checks with excluded items (gray) – The number of checks that have excluded items, such as resources that you want a check to ignore. For example, this might be Amazon EC2 instances that you don't want the check to evaluate. 3. You can do the following on the Trusted Advisor Recommendations page: • • • • • To refresh all checks in your account, choose Refresh all checks. To create an .xls file that includes all check results, choose Download all checks. Under Checks summary, choose a check category, such as Security, to view the results. Under Potential monthly savings, you can view how much you can save for your account and the cost optimization checks for recommendations. Under Recent changes, you can view changes to check statuses within the last 30 days. Choose a check name to view the latest results for that check or choose the arrow icon to view the next page. Example : Trusted Advisor Recommendations The following example shows a summary of the check results for an AWS account. Sign in to the Trusted Advisor console API Version 2025-05-13 32 AWS Support View check categories User Guide You can
|
support-ug-013
|
support-ug.pdf
| 13 |
the results. Under Potential monthly savings, you can view how much you can save for your account and the cost optimization checks for recommendations. Under Recent changes, you can view changes to check statuses within the last 30 days. Choose a check name to view the latest results for that check or choose the arrow icon to view the next page. Example : Trusted Advisor Recommendations The following example shows a summary of the check results for an AWS account. Sign in to the Trusted Advisor console API Version 2025-05-13 32 AWS Support View check categories User Guide You can view the check descriptions and results for the following check categories: • Cost optimization – Recommendations that can potentially save you money. These checks highlight unused resources and opportunities to reduce your bill. • Performance – Recommendations that can improve the speed and responsiveness of your applications. • Security – Recommendations for security settings that can make your AWS solution more secure. • Fault tolerance – Recommendations that help increase the resiliency of your AWS solution. These checks highlight redundancy shortfalls and overused resources. • Service limits – Checks the usage for your account and whether your account approaches or exceeds the limit (also known as quotas) for AWS services and resources. • Operational Excellence – Recommendations to help you operate your AWS environment effectively, and at scale. To view check categories 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. In the navigation pane, choose the check category. 3. On the category page, view the summary for each check category: • Action recommended (red) – Trusted Advisor recommends an action for the check. • Investigation recommended (yellow) – Trusted Advisor detects a possible issue for the check. • No problems detected (green) – Trusted Advisor doesn't detect an issue for the check. • Excluded items (gray) – The number of checks that have excluded items, such as resources that you want a check to ignore. 4. For each check, choose the refresh icon ( to refresh this check. ) View check categories API Version 2025-05-13 33 AWS Support 5. Choose the download icon ( to create an .xls file that includes the results for this check. User Guide ) Example : Cost optimization category The following example shows 10 (green) checks that don't have any issues. View specific checks Expand a check to view the full check description, your affected resources, any recommended steps, and links to more information. To view a specific check 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. In the navigation pane, choose a check category. 3. Choose the check name to view the description and the following details: • Alert Criteria – Describes the threshold when a check will change status. • Recommended Action – Describes the recommended actions for this check. • Additional Resources – Lists related AWS documentation. View specific checks API Version 2025-05-13 34 AWS Support User Guide • A table that lists the affected items in your account. You can include or exclude these items from check results. 4. (Optional) To exclude items so that they don't appear in check results: a. b. Select an item and choose Exclude & Refresh. To view all excluded items, choose Excluded items. 5. (Optional) To include items so that the check evaluates them again: a. b. Choose Excluded items, select an item, and then choose Include & Refresh. To view all included items, choose Included items. 6. Choose the settings icon ( In the Preferences dialog box, you can specify the number of items or the properties to display, and then choose Confirm. ). Example : Cost optimization check The following Low Utilization Amazon EC2 Instances check lists the affected instances in the account. This check identifies 38 Amazon EC2 instances that have low usage and recommends that you stop or terminate the resources. View specific checks API Version 2025-05-13 35 AWS Support User Guide Filter your checks On the check category pages, you can specify which check results that you want to view. For example, you might filter by checks that have detected errors in your account so that you can investigate urgent issues first. If you have checks that evaluate items in your account, such as AWS resources, you can use tag filters to only show items that have the specified tag. To filter your checks 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. 3. In the navigation pane or the Trusted Advisor Recommendations page, choose the check category. For Search by keyword, enter a keyword from the check name or description to filter your results. 4. For the View list, specify which checks to view: • All checks – List all checks for this category. Filter your checks API
|
support-ug-014
|
support-ug.pdf
| 14 |
If you have checks that evaluate items in your account, such as AWS resources, you can use tag filters to only show items that have the specified tag. To filter your checks 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. 3. In the navigation pane or the Trusted Advisor Recommendations page, choose the check category. For Search by keyword, enter a keyword from the check name or description to filter your results. 4. For the View list, specify which checks to view: • All checks – List all checks for this category. Filter your checks API Version 2025-05-13 36 AWS Support User Guide • Action recommended – List checks that recommend that you take action. These checks are highlighted in red. • Investigation recommended – List checks that recommend that you take possible action. These checks are highlighted in yellow. • No problems detected – List checks that don't have any issues. These checks are highlighted in green. • Checks with excluded items – List checks that you specified to exclude items from the check results. 5. If you added tags to your AWS resources, such as Amazon EC2 instances or AWS CloudTrail trails, you can filter your results so that the checks only show items that have the specified tag. For Filter by tag, enter a tag key and value, and then choose Apply filter. 6. In the table for the check, the check results only show items that have the specified key and value. 7. To clear the filter by tags, choose Reset. Related information For more information about tagging for Trusted Advisor, see the following topics: • AWS Support enables tagging capabilities for Trusted Advisor • Tagging AWS resources in the AWS General Reference Refresh check results You can refresh checks to get the latest results for your account. If you have a Developer or Basic Support plan, you can sign in to the Trusted Advisor console to refresh the checks. If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, Trusted Advisor automatically refreshes the checks in your account on a weekly basis. To refresh Trusted Advisor checks 1. Navigate to the AWS Trusted Advisor console at https://console.aws.amazon.com/ trustedadvisor. 2. On the Trusted Advisor Recommendations or a check category page, choose Refresh all checks. Refresh check results API Version 2025-05-13 37 AWS Support User Guide You can also refresh specific checks in the following ways: • Choose the refresh icon ( for an individual check. • Use the RefreshTrustedAdvisorCheck API operation. Notes • Trusted Advisor automatically refreshes some checks several times a day, such as the AWS Well-Architected high risk issues for reliability check. It might take a few hours for changes to appear in your account. For these automatically refreshed checks, you can't choose the refresh icon ( to manually refresh your results. ) • If you enabled AWS Security Hub for your account, you can't use the Trusted Advisor console to refresh Security Hub controls. For more information, see Refresh your Security Hub findings. Download check results You can download check results to get an overview of Trusted Advisor in your account. You can download results for all checks or a specific check. To download check results from Trusted Advisor Recommendations 1. Navigate to the AWS Trusted Advisor console at https://console.aws.amazon.com/ trustedadvisor. • • To download all check results, in the Trusted Advisor Recommendations or a check category page, choose Download all checks. To download a check result for a specific check, choose the check name, and then choose the download icon ( Download check results API Version 2025-05-13 38 ) ). AWS Support User Guide 2. Save or open the .xls file. The file contains the same summary information from the Trusted Advisor console, such as the check name, description, status, affected resources, and so on. Organizational view You can set up the organizational view feature to create a report for all member accounts in your AWS organization. For more information, see Organizational view for AWS Trusted Advisor. Preferences On the Manage Trusted Advisor page, you can disable Trusted Advisor. On the Notifications page, you can configure your weekly email messages for the check summary. See Set up notification preferences. On the Your organization page, you can enable or disable trusted access with AWS Organizations. This is required for the Organizational view for AWS Trusted Advisor feature, Trusted Advisor Priority, and Trusted Advisor Engage. Set up notification preferences Specify who can receive the weekly Trusted Advisor email messages for check results and the language. You receive an email notification about your check summary for Trusted Advisor Recommendations once a week. The email notifications for Trusted Advisor Recommendations don't include results for Trusted Advisor Priority. For more information, see Manage Trusted Advisor Priority notifications. To set up notification preferences
|
support-ug-015
|
support-ug.pdf
| 15 |
notification preferences. On the Your organization page, you can enable or disable trusted access with AWS Organizations. This is required for the Organizational view for AWS Trusted Advisor feature, Trusted Advisor Priority, and Trusted Advisor Engage. Set up notification preferences Specify who can receive the weekly Trusted Advisor email messages for check results and the language. You receive an email notification about your check summary for Trusted Advisor Recommendations once a week. The email notifications for Trusted Advisor Recommendations don't include results for Trusted Advisor Priority. For more information, see Manage Trusted Advisor Priority notifications. To set up notification preferences 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. 3. In the navigation pane, under Preferences, choose Notifications. For Recommendations, select whom to notify for your check results. You can add and remove contacts from the Account Settings page in the AWS Billing and Cost Management console. 4. For Language, choose the language for the email message. 5. Choose Save your preferences. Organizational view API Version 2025-05-13 39 AWS Support Set up organizational view User Guide If you set up your account with AWS Organizations, you can create reports for all member accounts in your organization. For more information, see Organizational view for AWS Trusted Advisor. Disable Trusted Advisor When you disable this service, Trusted Advisor won't perform any checks on your account. Anyone who tries to access the Trusted Advisor console or use the API operations will receive an access denied error message. To disable Trusted Advisor 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. In the navigation pane, under Preferences, choose Manage Trusted Advisor. 3. Under Trusted Advisor, turn off Enabled. This action disables Trusted Advisor for all checks in your account. 4. You can then manually delete the AWSServiceRoleForTrustedAdvisor from your account. For more information, see Deleting a service-linked role for Trusted Advisor. Related information For more information about Trusted Advisor, see the following topics: • How do I start using Trusted Advisor? • AWS Trusted Advisor check reference Get started with the Trusted Advisor API The AWS Trusted Advisor API Reference is intended for programmers that need detailed information about the Trusted Advisor API operations and data types. This API provides access to Trusted Advisor recommendations for your account or all the accounts within your AWS Organization. The Trusted Advisor API uses HTTP methods that returns results in JSON format. Get started with the Trusted Advisor API API Version 2025-05-13 40 AWS Support Note User Guide • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Trusted Advisor API • If you call the AWS Trusted Advisor API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, then you receive an Access Denied exception. For more information about changing your support plan, see AWS Support. You can use the AWS Trusted Advisor API to get a list of checks and their descriptions, recommendations, and resources for recommendations. You can also update the lifecycle of recommendations. To manage recommendations, use the following API operations: • Use the ListChecks, ListRecommendations, GetRecommendation, and ListRecommendationResources API operations to view recommendations and corresponding accounts and resources. • Use The UpdateRecommendationLifecycle API operation to update the lifecycle of a recommendation that's managed by Trusted Advisor Priority. • Use The BatchUpdateRecommendationResourceExclusion API operation to include or exclude one or more resources from your Trusted Advisor results. • The ListOrganizationRecommendations, GetOrganizationRecommendation, ListOrganizationRecommendationResources, ListOrganizationRecommendationAccounts, and UpdateOrganizationRecommendationLifecycle API calls support only recommendations that are managed by Trusted Advisor Priority. These recommendations are also referred to as prioritized recommendations. You can view and manage your prioritized recommendations from a management or delegated admin account if you have activated Trusted Advisor Priority. If Priority isn't activated, then you receive an Access Denied exception when you make requests. For more information, see AWS Trusted Advisor in the AWS Support User Guide. For authentication of requests, see the Signature Version 4 Signing Process. Using Trusted Advisor as a web service The AWS Support service enables you to write applications that interact with AWS Trusted Advisor. This topic shows you how to get a list of Trusted Advisor checks, refresh one of them, and then get Using Trusted Advisor as a web service API Version 2025-05-13 41 AWS Support User Guide the detailed results from the check. These tasks are demonstrated in Java. For information about support for other languages, see Tools for Amazon Web Services. Topics • Get the list of available Trusted Advisor checks • Refresh the list of available Trusted Advisor checks • Poll a Trusted Advisor check for status changes • Request a Trusted Advisor check result • Show details of a Trusted Advisor check Get the list of available Trusted Advisor checks The following Java code snippet creates an
|
support-ug-016
|
support-ug.pdf
| 16 |
then get Using Trusted Advisor as a web service API Version 2025-05-13 41 AWS Support User Guide the detailed results from the check. These tasks are demonstrated in Java. For information about support for other languages, see Tools for Amazon Web Services. Topics • Get the list of available Trusted Advisor checks • Refresh the list of available Trusted Advisor checks • Poll a Trusted Advisor check for status changes • Request a Trusted Advisor check result • Show details of a Trusted Advisor check Get the list of available Trusted Advisor checks The following Java code snippet creates an instance of an Support client that you can use to call all Trusted Advisor API operations. Next, the code gets the list of Trusted Advisor checks and their corresponding CheckId values by calling the DescribeTrustedAdvisorChecks API operation. You can use this information to build user interfaces that enable users to select the check they want to run or refresh. private static AWSSupport createClient() { return AWSSupportClientBuilder.defaultClient(); } // Get the List of Available Trusted Advisor Checks public static void getTAChecks() { // Possible language parameters: "en" (English), "ja" (Japanese), "fr" (French), "zh" (Chinese) DescribeTrustedAdvisorChecksRequest request = new DescribeTrustedAdvisorChecksRequest().withLanguage("en"); DescribeTrustedAdvisorChecksResult result = createClient().describeTrustedAdvisorChecks(request); for (TrustedAdvisorCheckDescription description : result.getChecks()) { // Do something with check description. System.out.println(description.getId()); System.out.println(description.getName()); } } Get the list of available Trusted Advisor checks API Version 2025-05-13 42 AWS Support User Guide Refresh the list of available Trusted Advisor checks The following Java code snippet creates an instance of an Support client that you can use to refresh Trusted Advisor data. // Refresh a Trusted Advisor Check // Note: Some checks are refreshed automatically, and they cannot be refreshed by using this operation. // Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error. public static void refreshTACheck(final String checkId) { RefreshTrustedAdvisorCheckRequest request = new RefreshTrustedAdvisorCheckRequest().withCheckId(checkId); RefreshTrustedAdvisorCheckResult result = createClient().refreshTrustedAdvisorCheck(request); System.out.println("CheckId: " + result.getStatus().getCheckId()); System.out.println("Milliseconds until refreshable: " + result.getStatus().getMillisUntilNextRefreshable()); System.out.println("Refresh Status: " + result.getStatus().getStatus()); } Poll a Trusted Advisor check for status changes After you submit the request to run a Trusted Advisor check to generate the latest status data, you use the DescribeTrustedAdvisorCheckRefreshStatuses API operation to request the progress of the check's run, and when new data is ready for the check. The following Java code snippet gets the status of the check requested in the following section, using the value corresponding in the CheckId variable. In addition, the code demonstrates several other uses of the Trusted Advisor service: 1. You can call getMillisUntilNextRefreshable by traversing the objects contained in the DescribeTrustedAdvisorCheckRefreshStatusesResult instance. You can use the value returned to test whether you want your code to proceed with refreshing the check. 2. If timeUntilRefreshable equals zero, you can request a refresh of the check. 3. Using the status returned, you can continue to poll for status changes; the code snippet sets the polling interval to a recommended ten seconds. If the status is either enqueued or in_progress, the loop returns and requests another status. If the call returns successful, the loop terminates. Refresh the list of available Trusted Advisor checks API Version 2025-05-13 43 AWS Support User Guide 4. Finally, the code returns an instance of a DescribeTrustedAdvisorCheckResultResult data type that you can use to traverse the information produced by the check. Note: Use a single refresh request before polling for the status of the request. // Retrieves TA refresh statuses. Multiple checkId's can be submitted. public static List<TrustedAdvisorCheckRefreshStatus> getTARefreshStatus(final String... checkIds) { DescribeTrustedAdvisorCheckRefreshStatusesRequest request = new DescribeTrustedAdvisorCheckRefreshStatusesRequest().withCheckIds(checkIds); DescribeTrustedAdvisorCheckRefreshStatusesResult result = createClient().describeTrustedAdvisorCheckRefreshStatuses(request); return result.getStatuses(); } // Retrieves a TA check status, and checks to see if it has finished processing. public static boolean isTACheckStatusInTerminalState(final String checkId) { // Since we only submitted one checkId to getTARefreshStatus, just retrieve the only element in the list. TrustedAdvisorCheckRefreshStatus status = getTARefreshStatus(checkId).get(0); // Valid statuses are: // 1. "none", the check has never been refreshed before. // 2. "enqueued", the check is waiting to be processed. // 3. "processing", the check is in the midst of being processed. // 4. "success", the check has succeeded and finished processing - refresh data is available. // 5. "abandoned", the check has failed to process. return status.getStatus().equals("abandoned") || status.getStatus().equals("success"); } // Enqueues a Trusted Advisor check refresh. Periodically polls the check refresh status for completion. public static TrustedAdvisorCheckResult getFreshTACheckResult(final String checkId) throws InterruptedException { refreshTACheck(checkId); while(!isTACheckStatusInTerminalState(checkId)) { Thread.sleep(10000); } return getTACheckResult(checkId); } // Retrieves fresh TA check data whenever possible. // Note: Some checks are refreshed automatically, and they cannot be refreshed by using this operation. This method Poll a Trusted Advisor check for status changes API Version 2025-05-13 44 AWS Support User Guide // is only functional for checks that can be refreshed using the RefreshTrustedAdvisorCheck operation. public static void pollForTACheckResultChanges(final String checkId) throws InterruptedException {
|
support-ug-017
|
support-ug.pdf
| 17 |
|| status.getStatus().equals("success"); } // Enqueues a Trusted Advisor check refresh. Periodically polls the check refresh status for completion. public static TrustedAdvisorCheckResult getFreshTACheckResult(final String checkId) throws InterruptedException { refreshTACheck(checkId); while(!isTACheckStatusInTerminalState(checkId)) { Thread.sleep(10000); } return getTACheckResult(checkId); } // Retrieves fresh TA check data whenever possible. // Note: Some checks are refreshed automatically, and they cannot be refreshed by using this operation. This method Poll a Trusted Advisor check for status changes API Version 2025-05-13 44 AWS Support User Guide // is only functional for checks that can be refreshed using the RefreshTrustedAdvisorCheck operation. public static void pollForTACheckResultChanges(final String checkId) throws InterruptedException { String checkResultStatus = null; do { TrustedAdvisorCheckResult result = getFreshTACheckResult(checkId); if (checkResultStatus != null && !checkResultStatus.equals(result.getStatus())) { break; } checkResultStatus = result.getStatus(); // The rule refresh has completed, but due to throttling rules the checks may not be refreshed again // for a short period of time. // Since we only submitted one checkId to getTARefreshStatus, just retrieve the only element in the list. TrustedAdvisorCheckRefreshStatus refreshStatus = getTARefreshStatus(checkId).get(0); Thread.sleep(refreshStatus.getMillisUntilNextRefreshable()); } while(true); // Signal that a TA check has changed check result status here. } Request a Trusted Advisor check result After you select the check for the detailed results that you want, you submit a request by using the DescribeTrustedAdvisorCheckResult API operation. Tip The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check. You can use the DescribeTrustedAdvisorChecks API operation to get the check ID. The following Java code snippet uses the DescribeTrustedAdvisorChecksResult instance referenced by the variable result, which was obtained in the preceding code snippet. Rather than defining a check interactively through a user interface, After you submit the request to run the snippet submits a request for the first check in the list to be run by specifying an index value of 0 in each result.getChecks().get(0) call. Next, the code defines an instance Request a Trusted Advisor check result API Version 2025-05-13 45 AWS Support User Guide of DescribeTrustedAdvisorCheckResultRequest, which it passes to an instance of DescribeTrustedAdvisorCheckResultResult called checkResult. You can use the member structures of this data type to view the results of the check. // Request a Trusted Advisor Check Result public static TrustedAdvisorCheckResult getTACheckResult(final String checkId) { DescribeTrustedAdvisorCheckResultRequest request = new DescribeTrustedAdvisorCheckResultRequest() // Possible language parameters: "en" (English), "ja" (Japanese), "fr" (French), "zh" (Chinese) .withLanguage("en") .withCheckId(checkId); DescribeTrustedAdvisorCheckResultResult requestResult = createClient().describeTrustedAdvisorCheckResult(request); return requestResult.getResult(); } Note: Requesting a Trusted Advisor Check Result doesn't generate updated results data. Show details of a Trusted Advisor check The following Java code snippet iterates over the DescribeTrustedAdvisorCheckResultResult instance returned in the previous section to get a list of resources flagged by the Trusted Advisor check. // Show ResourceIds for flagged resources. for (TrustedAdvisorResourceDetail flaggedResource : result1.getResult().getFlaggedResources()) { System.out.println( "The resource for this ResourceID has been flagged: " + flaggedResource.getResourceId()); } Organizational view for AWS Trusted Advisor Organizational view lets you view Trusted Advisor checks for all accounts in your AWS Organizations. After you enable this feature, you can create reports to aggregate the check results for all member accounts in your organization. The report includes a summary of check results and information about affected resources for each account. For example, you can use the reports to Show details of a Trusted Advisor check API Version 2025-05-13 46 AWS Support User Guide identify which accounts in your organization are using AWS Identity and Access Management (IAM) with the IAM Use check or whether you have recommended actions for Amazon Simple Storage Service (Amazon S3) buckets with the Amazon S3 Bucket Permissions check. Topics • Prerequisites • Enable organizational view • Refresh Trusted Advisor checks • Create organizational view reports • View the report summary • Download an organizational view report • Disable organizational view • Using IAM policies to allow access to organizational view • Using other AWS services to view Trusted Advisor reports Prerequisites You must meet the following requirements to enable organizational view: • Your accounts must be members of an AWS Organization. • Your organization must have all features enabled for Organizations. For more information, see Enabling all features in your organization in the AWS Organizations User Guide. • The management account in your organization must have a Business, Enterprise On-Ramp, or Enterprise Support plan. You can find your support plan from the AWS Support Center or from the Support plans page. See Compare AWS Support plans. • You must sign in as a user in the management account (or assumed equivalent role). Whether you sign in as an IAM user or an IAM role, you must have a policy with the required permissions. See Using IAM policies to allow access to organizational view. Enable organizational view After you meet the prerequisites, follow these steps to enable organizational view. After
|
support-ug-018
|
support-ug.pdf
| 18 |
management account in your organization must have a Business, Enterprise On-Ramp, or Enterprise Support plan. You can find your support plan from the AWS Support Center or from the Support plans page. See Compare AWS Support plans. • You must sign in as a user in the management account (or assumed equivalent role). Whether you sign in as an IAM user or an IAM role, you must have a policy with the required permissions. See Using IAM policies to allow access to organizational view. Enable organizational view After you meet the prerequisites, follow these steps to enable organizational view. After you enable this feature, the following happens: Prerequisites API Version 2025-05-13 47 AWS Support User Guide • Trusted Advisor is enabled as a trusted service in your organization. For more information, see Enabling trusted access with other AWS services in the AWS Organizations User Guide. • The AWSServiceRoleForTrustedAdvisorReporting service-linked-role is created for you in the management account in your organization. This role includes the permissions that Trusted Advisor needs to call Organizations on your behalf. This service-linked role is locked, and you can't delete it manually. For more information, see Using service-linked roles for Trusted Advisor. You enable organizational view from the Trusted Advisor console. To enable organizational view 1. Sign in as an administrator in the organization's management account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, under Preferences, choose Your organization. 3. Under Enable trusted access with AWS Organizations, turn on Enabled. Note Enabling organizational view for the management account doesn’t provide the same checks for all member accounts. For example, if your member accounts all have Basic Support, those accounts won’t have the same checks available as your management account. The AWS Support plan determines which Trusted Advisor checks are available for an account. Refresh Trusted Advisor checks Before you create a report for your organization, we recommend that you refresh the statuses of your Trusted Advisor checks. You can download a report without refreshing your Trusted Advisor checks, but your report might not have the latest information. If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, Trusted Advisor automatically refreshes the checks in your account on a weekly basis. Refresh Trusted Advisor checks API Version 2025-05-13 48 AWS Support Note User Guide If you have accounts in your organization that have a Developer or Basic support plan, a user for those accounts must sign in to the Trusted Advisor console to refresh the checks. You can't refresh checks for all accounts from the organization's management account. To refresh Trusted Advisor checks 1. Navigate to the AWS Trusted Advisor console at https://console.aws.amazon.com/ trustedadvisor. 2. On the Trusted Advisor Recommendations page, choose the Refresh all checks. This refreshes all checks in your account. You can also refresh specific checks in the following ways: • Use the RefreshTrustedAdvisorCheck API operation. • Choose the refresh icon ( for an individual check. Create organizational view reports ) After you enable organizational view, you can create reports so that you can view Trusted Advisor check results for your organization. You can create up to 50 reports. If you create reports beyond this quota, Trusted Advisor deletes the earliest report. You can't recover deleted reports. To create organizational view reports 1. Sign in to the organization's management account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, choose Organizational View. 3. Choose Create report. Create organizational view reports API Version 2025-05-13 49 AWS Support User Guide 4. By default, the report includes all AWS Regions, check categories, checks, and resource statuses. On the Create report page, you can use the filter options to customize your report. For example, you can clear the All option for Region, and then specify the individual Regions to include in the report. a. b. c. d. e. Enter a Name for the report. For Format, choose JSON or CSV. For Region, specify the AWS Regions or choose All. For Check category, choose the check category or choose All. For Checks, choose the specific checks for that category or choose All. Note The Check category filter overrides the Checks filter. For example, if you choose the Security category and then choose a specific check name, your report includes all check results for that category. To create a report for only specific checks, keep the default All value for Check category and then choose your check names. f. For Resource status, choose the status to filter, such as Warning, or choose All. 5. For AWS Organization, select the organizational units (OUs) to include in your report. For more information about OUs, see Managing organizational units in the AWS Organizations User Guide. 6. Choose Create report. Example : Create report filter options The following example creates a JSON
|
support-ug-019
|
support-ug.pdf
| 19 |
Security category and then choose a specific check name, your report includes all check results for that category. To create a report for only specific checks, keep the default All value for Check category and then choose your check names. f. For Resource status, choose the status to filter, such as Warning, or choose All. 5. For AWS Organization, select the organizational units (OUs) to include in your report. For more information about OUs, see Managing organizational units in the AWS Organizations User Guide. 6. Choose Create report. Example : Create report filter options The following example creates a JSON report for the following: • Three AWS Regions • All Security and Performance checks Create organizational view reports API Version 2025-05-13 50 AWS Support User Guide In the following example, the report includes the support-team OU and one AWS account that are part of the organization. Create organizational view reports API Version 2025-05-13 51 AWS Support User Guide Notes • The amount of time it takes to create the report depends on the number of accounts in the organization and the number of resources in each account. • You can't create more than one report at a time unless the current report has been running for more than 6 hours. • Refresh the page if you don't see the report appear on the page. Create organizational view reports API Version 2025-05-13 52 AWS Support User Guide View the report summary After the report is ready, you can view the report summary from the Trusted Advisor console. This lets you quickly view the summary of your check results across your organization. To view the report summary 1. Sign in to the organization's management account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, choose Organizational View. 3. Choose the report name. 4. On the Summary page, view the check statuses for each category. You can also choose Download report. View the report summary API Version 2025-05-13 53 AWS Support User Guide Example : Report summary for an organization Download an organizational view report After your report is ready, download it from the Trusted Advisor console. The report is a .zip file that contains three files: • summary.json – Contains a summary of the check results for each check category. • schema.json – Contains the schema for the specified checks in the report. • A resources file (.json or .csv) – Contains detailed information about the check statuses for resources in your organization. Download an organizational view report API Version 2025-05-13 54 AWS Support User Guide To download an organizational view report 1. Sign in to the organization's management account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, choose Organizational View. The Organizational View page displays the available reports to download. 3. Select a report, choose Download report, and then save the file. You can only download one report at a time. 4. Unzip the file. 5. Use a text editor to open the .json file or a spreadsheet application to open the .csv file. Note You might receive multiple files if your report is 5 MB or larger. Example : summary.json file The summary.json file shows the number of accounts in the organization and the statuses of the checks in each category. Trusted Advisor uses the following color code for check results: Download an organizational view report API Version 2025-05-13 55 AWS Support User Guide • Green – Trusted Advisor doesn't detect an issue for the check. • Yellow – Trusted Advisor detects a possible issue for the check. • Red – Trusted Advisor detects an error and recommends an action for the check. • Blue – Trusted Advisor can't determine the status of the check. In the following example, two checks are Red, one is Green, and one is Yellow. { "numAccounts": 3, "filtersApplied": { "accountIds": ["123456789012","111122223333","111111111111"], "checkIds": "All", "categories": [ "security", "performance" ], "statuses": "All", "regions": [ "us-west-1", "us-west-2", "us-east-1" ], "organizationalUnitIds": [ "ou-xa9c-EXAMPLE1", "ou-xa9c-EXAMPLE2" ] }, "categoryStatusMap": { "security": { "statusMap": { "ERROR": { "name": "Red", "count": 2 }, "OK": { "name": "Green", "count": 1 }, "WARN": { "name": "Yellow", "count": 1 Download an organizational view report API Version 2025-05-13 56 AWS Support User Guide } }, "name": "Security" } }, "accountStatusMap": { "123456789012": { "security": { "statusMap": { "ERROR": { "name": "Red", "count": 2 }, "OK": { "name": "Green", "count": 1 }, "WARN": { "name": "Yellow", "count": 1 } }, "name": "Security" } } } } Example : schema.json file The schema.json file includes the schema for the checks in the report. The following example includes the IDs and properties for the IAM Password Policy (Yw2K9puPzl) and IAM Key Rotation (DqdJqYeRm5) checks. { "Yw2K9puPzl": [ "Password Policy", "Uppercase", "Lowercase", "Number", "Non-alphanumeric", "Status", "Reason" Download an organizational
|
support-ug-020
|
support-ug.pdf
| 20 |
API Version 2025-05-13 56 AWS Support User Guide } }, "name": "Security" } }, "accountStatusMap": { "123456789012": { "security": { "statusMap": { "ERROR": { "name": "Red", "count": 2 }, "OK": { "name": "Green", "count": 1 }, "WARN": { "name": "Yellow", "count": 1 } }, "name": "Security" } } } } Example : schema.json file The schema.json file includes the schema for the checks in the report. The following example includes the IDs and properties for the IAM Password Policy (Yw2K9puPzl) and IAM Key Rotation (DqdJqYeRm5) checks. { "Yw2K9puPzl": [ "Password Policy", "Uppercase", "Lowercase", "Number", "Non-alphanumeric", "Status", "Reason" Download an organizational view report API Version 2025-05-13 57 User Guide AWS Support ], "DqdJqYeRm5": [ "Status", "IAM User", "Access Key", "Key Last Rotated", "Reason" ], ... } Example : resources.csv file The resources.csv file includes information about resources in the organization. This example shows some of the data columns that appear in the report, such as the following: • Account ID of the affected account • The Trusted Advisor check ID • The resource ID • Timestamp of the report • The full name of the Trusted Advisor check • The Trusted Advisor check category • The account ID of the parent organizational unit (OU) or root The resources file only contains entries if a check result exists at the resource level. You might not see checks in the report for the following reasons: Download an organizational view report API Version 2025-05-13 58 AWS Support User Guide • Some checks, such as MFA on Root Account, don't have resources and won't appear in the report. Checks without resources appear in the summary.json file instead. • Some checks only show resources if they are Red or Yellow. If all resources are Green, they might not appear in your report. • If an account isn't enabled for a service that requires the check, the check might not appear in the report. For example, if you're not using Amazon Elastic Compute Cloud Reserved Instances in your organization, the Amazon EC2 Reserved Instance Lease Expiration check won't appear in your report. • The account hasn't refreshed check results. This might happen when users with a Basic or Developer support plan sign in to the Trusted Advisor console for the first time. If you have a Business, Enterprise On-Ramp, or Enterprise Support plan, it can take up to one week from account sign up for users to see check results. For more information, see Refresh Trusted Advisor checks. • If only the organization's management account enabled recommendations for checks, the report won't include resources for other accounts in the organization. For the resources file, you can use common software such as Microsoft Excel to open the .csv file format. You can use the .csv file for one-time analysis of all checks across all accounts in your organization. If you want to use your report with an application, you can download the report as a .json file instead. The .json file format provides more flexibility than the .csv file format for advanced use cases such as aggregation and advanced analytics with multiple datasets. For example, you can use a SQL interface with an AWS service such as Amazon Athena to run queries on your reports. You can also use Amazon QuickSight to create dashboards and visualize your data. For more information, see Using other AWS services to view Trusted Advisor reports. Disable organizational view Follow this procedure to disable organizational view. You must sign in to the organization's management account or assume a role with the required permissions to disable this feature. You can't disable this feature from another account in the organization. After you disable this feature, the following happens: • Trusted Advisor is removed as a trusted service in Organizations. Disable organizational view API Version 2025-05-13 59 AWS Support User Guide • The AWSServiceRoleForTrustedAdvisorReporting service-linked role is unlocked in the organization's management account. This means you can delete it manually, if needed. • You can't create, view, or download reports for your organization. To access previously created reports, you must reenable organizational view from the Trusted Advisor console. See Enable organizational view. To disable organizational view for Trusted Advisor 1. Sign in to the organization's management account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, choose Preferences. 3. Under Organizational View, choose Disable organizational view. After you disable organizational view, Trusted Advisor no longer aggregates checks from other AWS accounts in your organization. However, the AWSServiceRoleForTrustedAdvisorReporting service-linked role remains on the organization's management account until you delete it through the IAM console, IAM API, or AWS Command Line Interface (AWS CLI). For more information, see Deleting a service-linked role in the IAM User Guide. Note You can use other AWS services to query and visualize your data for organizational view
|
support-ug-021
|
support-ug.pdf
| 21 |
account and open the AWS Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor. 2. In the navigation pane, choose Preferences. 3. Under Organizational View, choose Disable organizational view. After you disable organizational view, Trusted Advisor no longer aggregates checks from other AWS accounts in your organization. However, the AWSServiceRoleForTrustedAdvisorReporting service-linked role remains on the organization's management account until you delete it through the IAM console, IAM API, or AWS Command Line Interface (AWS CLI). For more information, see Deleting a service-linked role in the IAM User Guide. Note You can use other AWS services to query and visualize your data for organizational view reports. For more information, see the following resources: • View AWS Trusted Advisor recommendations at scale with AWS Organizations in the AWS Management & Governance Blog Disable organizational view API Version 2025-05-13 60 AWS Support User Guide • Using other AWS services to view Trusted Advisor reports Using IAM policies to allow access to organizational view You can use the following AWS Identity and Access Management (IAM) policies to allow users or roles in your account access to organizational view in AWS Trusted Advisor. Example : Full access to organizational view The following policy allows full access to the organizational view feature. A user with these permissions can do the following: • Enable and disable organizational view • Create, view, and download reports { "Version": "2012-10-17", "Statement": [ { "Sid": "ReadStatement", "Effect": "Allow", "Action": [ "organizations:ListAccountsForParent", "organizations:ListAccounts", "organizations:ListRoots", "organizations:DescribeOrganization", "organizations:ListOrganizationalUnitsForParent", "organizations:ListAWSServiceAccessForOrganization", "trustedadvisor:DescribeAccount", "trustedadvisor:DescribeChecks", "trustedadvisor:DescribeCheckSummaries", "trustedadvisor:DescribeAccountAccess", "trustedadvisor:DescribeOrganization", "trustedadvisor:DescribeReports", "trustedadvisor:DescribeServiceMetadata", "trustedadvisor:DescribeOrganizationAccounts", "trustedadvisor:ListAccountsForParent", "trustedadvisor:ListRoots", "trustedadvisor:ListOrganizationalUnitsForParent" ], Using IAM policies to allow access to organizational view API Version 2025-05-13 61 User Guide AWS Support "Resource": "*" }, { "Sid": "CreateReportStatement", "Effect": "Allow", "Action": [ "trustedadvisor:GenerateReport" ], "Resource": "*" }, { "Sid": "ManageOrganizationalViewStatement", "Effect": "Allow", "Action": [ "organizations:EnableAWSServiceAccess", "organizations:DisableAWSServiceAccess", "trustedadvisor:SetOrganizationAccess" ], "Resource": "*" }, { "Sid": "CreateServiceLinkedRoleStatement", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/ reporting.trustedadvisor.amazonaws.com/AWSServiceRoleForTrustedAdvisorReporting" } ] } Example : Read access to organizational view The following policy allows read-only access to organizational view for Trusted Advisor. A user with these permissions can only view and download existing reports. { "Version": "2012-10-17", "Statement": [ { "Sid": "ReadStatement", "Effect": "Allow", "Action": [ "organizations:ListAccountsForParent", Using IAM policies to allow access to organizational view API Version 2025-05-13 62 AWS Support User Guide "organizations:ListAccounts", "organizations:ListRoots", "organizations:DescribeOrganization", "organizations:ListOrganizationalUnitsForParent", "organizations:ListAWSServiceAccessForOrganization", "trustedadvisor:DescribeAccount", "trustedadvisor:DescribeChecks", "trustedadvisor:DescribeCheckSummaries", "trustedadvisor:DescribeAccountAccess", "trustedadvisor:DescribeOrganization", "trustedadvisor:DescribeReports", "trustedadvisor:ListAccountsForParent", "trustedadvisor:ListRoots", "trustedadvisor:ListOrganizationalUnitsForParent" ], "Resource": "*" } ] } You can also create your own IAM policy. For more information, see Creating IAM Policies in the IAM User Guide. Note If you enabled AWS CloudTrail in your account, the following roles can appear in your log entries: • AWSServiceRoleForTrustedAdvisorReporting – The service-linked role that Trusted Advisor uses to access accounts in your organization. • AWSServiceRoleForTrustedAdvisor – The service-linked role that Trusted Advisor uses to access services in your organization. For more information about service-linked roles, see Using service-linked roles for Trusted Advisor. Using IAM policies to allow access to organizational view API Version 2025-05-13 63 AWS Support User Guide Using other AWS services to view Trusted Advisor reports Follow this tutorial to upload and view your data by using other AWS services. In this topic, you create an Amazon Simple Storage Service (Amazon S3) bucket to store your report and an AWS CloudFormation template to create resources in your account. Then, you can use Amazon Athena to analyze or run queries for your report or QuickSight to visualize that data in a dashboard. For information and examples for visualizing your report data, see the View AWS Trusted Advisor recommendations at scale with AWS Organizations in the AWS Management & Governance Blog. Prerequisites Before you start this tutorial, you must meet the following requirements: • Sign in as an AWS Identity and Access Management (IAM) user with administrator permissions. • Use the US East (N. Virginia) AWS Region to quickly set up your AWS services and resources. • Create an QuickSight account. For more information, see Getting Started with Data Analysis in QuickSight in the Amazon QuickSight User Guide. Upload the report to Amazon S3 After you download your resources.json report, upload the file to Amazon S3. You must use a bucket in the US East (N. Virginia) Region. To upload the report to an Amazon S3 bucket 1. Sign in to the AWS Management Console at https://console.aws.amazon.com/. 2. Use the Region selector and choose the US East (N. Virginia) Region. 3. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 4. From the list of buckets, choose an S3 bucket, and then copy the name. You use the name in the next procedure. 5. On the bucket-name page, choose Create folder, enter the name folder1, and then choose Save. 6. Choose the folder1. 7. In folder1, choose Upload and choose the resources.json file. 8. Choose Next, keep the default options, and then choose Upload. Using other AWS services
|
support-ug-022
|
support-ug.pdf
| 22 |
bucket 1. Sign in to the AWS Management Console at https://console.aws.amazon.com/. 2. Use the Region selector and choose the US East (N. Virginia) Region. 3. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 4. From the list of buckets, choose an S3 bucket, and then copy the name. You use the name in the next procedure. 5. On the bucket-name page, choose Create folder, enter the name folder1, and then choose Save. 6. Choose the folder1. 7. In folder1, choose Upload and choose the resources.json file. 8. Choose Next, keep the default options, and then choose Upload. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 64 AWS Support Note User Guide If you upload a new report to this bucket, rename the .json files each time you upload them so that you don't override the existing reports. For example, you can add the timestamp to each file, such as resources-timestamp.json, resources- timestamp2.json, and so on. Create your resources using AWS CloudFormation After you upload your report to Amazon S3, upload the following YAML template to AWS CloudFormation. This template tells AWS CloudFormation what resources to create for your account so that other services can use the report data in the S3 bucket. The template creates resources for IAM, AWS Lambda, and AWS Glue. To create your resources with AWS CloudFormation 1. Download the trusted-advisor-reports-template.zip file. 2. Unzip the file. 3. Open the template file in a text editor. 4. For the BucketName and FolderName parameters, replace the values for your-bucket- name-here and folder1 with the bucket name and folder name in your account. 5. Save the file. 6. Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation. 7. 8. If you haven't already, in the Region selector, choose the US East (N. Virginia) Region. In the navigation pane, choose Stacks. 9. Choose Create stack and choose With new resources (standard). 10. On the Create stack page, under Specify template, choose Upload a template file, and then choose Choose file. 11. Choose the YAML file and choose Next. 12. On the Specify stack details page, enter a stack name such as Organizational-view- Trusted-Advisor-reports, and choose Next. 13. On the Configure stack options page, keep the default options, and then choose Next. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 65 AWS Support User Guide 14. On the Review Organizational-view-Trusted-Advisor-reports page, review your options. At the bottom of the page, select the check box for I acknowledge that AWS CloudFormation might create IAM resources. 15. Choose Create stack. The stack takes about 5 minutes to create. 16. After the stack creates successfully, the Resources tab appears like the following example. Query the data in Amazon Athena After you have your resources, you can view the data in Athena. Use Athena to create queries and analyze the results of the report, such as looking up specific check results for accounts in the organization. Notes • Use the US East (N. Virginia) Region. • If you're new to Athena, you must specify a query result location before you can run a query for your report. We recommend that you specify a different S3 bucket for this location. For more information, see Specifying a query result location in the Amazon Athena User Guide. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 66 AWS Support To query the data in Athena User Guide 1. Open the Athena console at https://console.aws.amazon.com/athena/. 2. If you haven't already, in the Region selector, choose the US East (N. Virginia) Region. 3. Choose Saved Queries and in search field, enter Show sample. 4. Choose the query that appears, such as Show sample entries of TA report. The query should look like the following. SELECT * FROM "athenatacfn"."folder1" limit 10 5. Choose Run query. Your query results appear. Example : Athena query The following example shows 10 sample entries from the report. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 67 AWS Support User Guide For more information, see Running SQL Queries Using Amazon Athena in the Amazon Athena User Guide. Create a dashboard in QuickSight You can also set up QuickSight so that you can view your data in a dashboard and visualize your report information. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 68 AWS Support Note You must use the US East (N. Virginia) Region. User Guide To create a dashboard in QuickSight 1. Navigate to the QuickSight console and sign in to your account. 2. Choose New analysis, New dataset, and then choose Athena. 3. In the New Athena data source dialog box, enter a data source name such as AthenaTA, and then choose Create data source. 4. In the Choose your table dialog box, choose the athenatacfn table, choose folder1,
|
support-ug-023
|
support-ug.pdf
| 23 |
in a dashboard and visualize your report information. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 68 AWS Support Note You must use the US East (N. Virginia) Region. User Guide To create a dashboard in QuickSight 1. Navigate to the QuickSight console and sign in to your account. 2. Choose New analysis, New dataset, and then choose Athena. 3. In the New Athena data source dialog box, enter a data source name such as AthenaTA, and then choose Create data source. 4. In the Choose your table dialog box, choose the athenatacfn table, choose folder1, and then choose Select. 5. In the Finish data set creation dialog box, choose Directly query your data, and then choose Visualize. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 69 AWS Support User Guide You can now create a dashboard in QuickSight. For more information, see Working with Dashboards in the Amazon QuickSight User Guide. Example : QuickSight dashboard The following example dashboard shows information about the Trusted Advisor checks, such as the following: • Affected account IDs • Summary by AWS Regions • Check categories • Check statuses • Number of entries in the report for each account Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 70 AWS Support Note User Guide If you have permission errors while creating your dashboard, make sure that QuickSight can use Athena. For more information, see I Can't Connect to Amazon Athena in the Amazon QuickSight User Guide. For more information and examples for visualizing your report data, see the View AWS Trusted Advisor recommendations at scale with AWS Organizations in the AWS Management & Governance Blog. Troubleshooting If you have issues with this tutorial, see the following troubleshooting tips. I'm not seeing the latest data in my report When you create a report, the organizational view feature doesn't automatically refresh the Trusted Advisor checks in your organization. To get the latest check results, refresh the checks for the management account and each member account in the organization. For more information, see Refresh Trusted Advisor checks. I have duplicate columns in the report The Athena console might show the following error in your table if your report has duplicate columns. HIVE_INVALID_METADATA: Hive metadata for table folder1 is invalid: Table descriptor contains duplicate columns For example, if you added a column in your report that already exists, this can cause issues when you try to view the report data in the Athena console. You can follow these steps to fix this issue. Find duplicate columns You can use the AWS Glue console to view the schema and quickly identify if you have duplicate columns in your report. To find duplicate columns 1. Open the AWS Glue console at https://console.aws.amazon.com/glue/. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 71 AWS Support User Guide 2. 3. If you haven't already, in the Region selector, choose the US East (N. Virginia) Region. In the navigation pane, choose Tables. 4. Choose your folder name, such as folder1, and then under Schema, view the values for Column name. If you have a duplicate column, you must upload a new report to your Amazon S3 bucket. See the following Upload a new report section. Upload a new report After you identify the duplicate column, we recommend that you replace the existing report with a new one. This ensures that the resources created from this tutorial use the latest report data from your organization. To upload a new report 1. If you haven't already, refresh your Trusted Advisor checks for the accounts in your organization. See Refresh Trusted Advisor checks. 2. Create and download another JSON report in the Trusted Advisor console. See Create organizational view reports. You must use a JSON file for this tutorial. 3. Sign in to the AWS Management Console and open the Amazon S3 console at https:// console.aws.amazon.com/s3/. 4. Choose your Amazon S3 bucket and choose the folder1 folder. 5. 6. 7. Select the previous resources.json reports and choose Delete. In the Delete objects page, under Permanently delete objects?, enter permanently delete, and then choose Delete objects. In your S3 bucket, choose Upload and then specify the new report. This action automatically updates your Athena table and AWS Glue crawler resources with the latest report data. It can take a few minutes to refresh your resources. 8. Enter a new query in the Athena console. See Query the data in Amazon Athena. Note If you still have issues with this tutorial, you can create a technical support case in the AWS Support Center. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 72 AWS Support User Guide View AWS Trusted Advisor checks powered by AWS Config AWS Config is a
|
support-ug-024
|
support-ug.pdf
| 24 |
and then specify the new report. This action automatically updates your Athena table and AWS Glue crawler resources with the latest report data. It can take a few minutes to refresh your resources. 8. Enter a new query in the Athena console. See Query the data in Amazon Athena. Note If you still have issues with this tutorial, you can create a technical support case in the AWS Support Center. Using other AWS services to view Trusted Advisor reports API Version 2025-05-13 72 AWS Support User Guide View AWS Trusted Advisor checks powered by AWS Config AWS Config is a service that continually assesses, audits, and evaluates your resource configurations for your desired settings. AWS Config provides managed rules, which are predefined, customizable compliance checks that AWS Config uses to evaluate if your AWS resources comply with common best practices. The AWS Config console guides you through the configuration and activation of managed rules. You can also use the AWS Command Line Interface (AWS CLI) or AWS Config API to pass the JSON code that defines your configuration of a managed rule. You can customize the behavior of a managed rule to suit your needs. You can customize the rule's parameters to define attributes that your resources must have to comply with the rule. To learn more about enabling AWS Config, see the AWS Config Developer Guide. AWS Config managed rules power a set of Trusted Advisor checks across all categories. When you enable certain managed rules, the corresponding Trusted Advisor checks are automatically enabled. To see which Trusted Advisor checks are powered by specific AWS Config managed rules, see AWS Trusted Advisor check reference. The AWS Config powered checks are available to customers with AWS Business Support, AWS Enterprise On-Ramp, and AWS Enterprise Support plans. If you enable AWS Config and you have one of these AWS Support plans, then you automatically see recommendations powered by corresponding deployed AWS Config managed rules. Note Results for these checks are automatically refreshed based on change-triggered updates to AWS Config managed rules. Refresh requests are not allowed. Currently, you can’t exclude resources from these checks. Troubleshooting If you have issues with this integration, see the following troubleshooting information. Contents • I just enabled recording and managed rules for AWS Config, but I don’t see corresponding Trusted Advisor checks. View Trusted Advisor checks powered by AWS Config API Version 2025-05-13 73 AWS Support User Guide • I deployed the same AWS Config managed rule twice, what will I see in Trusted Advisor? • I turned off recording for AWS Config in an AWS Region. What will I see in Trusted Advisor? I just enabled recording and managed rules for AWS Config, but I don’t see corresponding Trusted Advisor checks. After the AWS Config rule generates evalution results, you see the results in Trusted Advisor in near real-time. If you have issues with this feature, create a technical support case in the AWS Support Center. I deployed the same AWS Config managed rule twice, what will I see in Trusted Advisor? You see separate entries in the Trusted Advisor check results for each managed rule that you install. I turned off recording for AWS Config in an AWS Region. What will I see in Trusted Advisor? If you turned off resource recording for AWS Config in an AWS Region, then Trusted Advisor no longer receives data for corresponding managed rules and checks in that Region. Existing managed rule results remain in AWS Config and in Trusted Advisor until AWS Config expires, based on the recorder retention policy. If you delete a managed rule, then the Trusted Advisor check data usually deletes in near real-time. Viewing AWS Security Hub controls in AWS Trusted Advisor After you enable AWS Security Hub for your AWS account, you can view your security controls and their findings in the Trusted Advisor console. You can use Security Hub controls to identify security vulnerabilities in your account in the same way that you can use Trusted Advisor checks. You can view the check's status, the list of affected resources, and then follow Security Hub recommendations to address your security issues. You can use this feature to find security recommendations from Trusted Advisor and Security Hub in one convenient location. Notes • From Trusted Advisor, you can view controls in the AWS Foundational Security Best Practices security standard except for controls that have the Category: Recover > View your Security Hub controls in Trusted Advisor API Version 2025-05-13 74 AWS Support User Guide Resilience. For a list of supported controls, see AWS Foundational Security Best Practices controls in the AWS Security Hub User Guide. For more information about the Security Hub categories, see Control categories. • Trusted Advisor onboarded Security Hub controls up to September 26, 2024. Controls released after September 26,
|
support-ug-025
|
support-ug.pdf
| 25 |
Advisor and Security Hub in one convenient location. Notes • From Trusted Advisor, you can view controls in the AWS Foundational Security Best Practices security standard except for controls that have the Category: Recover > View your Security Hub controls in Trusted Advisor API Version 2025-05-13 74 AWS Support User Guide Resilience. For a list of supported controls, see AWS Foundational Security Best Practices controls in the AWS Security Hub User Guide. For more information about the Security Hub categories, see Control categories. • Trusted Advisor onboarded Security Hub controls up to September 26, 2024. Controls released after September 26, 2024 are not yet onboarded to Trusted Advisor. You can find controls released after that date in the Security Hub log. Topics • Prerequisites • View your Security Hub findings • Refresh your Security Hub findings • Disable Security Hub from Trusted Advisor • Troubleshooting Prerequisites You must meet the following requirements to enable the Security Hub integration with Trusted Advisor: • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan for this feature. You can find your support plan from the AWS Support Center or from the Support plans page. For more information, see Compare AWS Support plans. • You must enable resource recording in AWS Config for the AWS Regions that you want for your Security Hub controls. For more information, see Enabling and configuring AWS Config. • You must enable Security Hub and select the AWS Foundational Security Best Practices v1.0.0 security standard. If you haven't done so already, see Setting up AWS Security Hub in the AWS Security Hub User Guide. Note If you already completed these prerequisites, you can skip to View your Security Hub findings. Prerequisites API Version 2025-05-13 75 AWS Support User Guide About AWS Organizations accounts If you already completed the prerequisites for a management account, this integration is enabled automatically for all member accounts in your organization. Individual member accounts don't need to contact Support to enable this feature. However, member accounts in your organization must enable Security Hub if they want to see their findings in Trusted Advisor. If you want to disable this integration for a specific member account, see Disable this feature for AWS Organizations accounts. View your Security Hub findings After you enable Security Hub for your account, it can take up to 24 hours for your Security Hub findings to appear in the Security page of the Trusted Advisor console. To view your Security Hub findings in Trusted Advisor 1. Navigate to the Trusted Advisor console, and then choose the Security category. 2. In the Search by keyword field, enter the control name or description in the field. Tip For Source, you can choose AWS Security Hub to filter for Security Hub controls. 3. Choose the Security Hub control name to view the following information: • Description – Describes how this control checks your account for security vulnerabilities. • Source – Whether the check comes from AWS Trusted Advisor or AWS Security Hub. For Security Hub controls, you can find the control ID. • Alert Criteria – The status of the control. For example, if Security Hub detects an important issue, the status might be Red: Critical or High. • Recommended Action – Use the Security Hub documentation link to find the recommended steps to fix the issue. • Security Hub resources – You can find the resources in your account where Security Hub has detected an issue. View your Security Hub findings API Version 2025-05-13 76 AWS Support Notes User Guide • You must use Security Hub to exclude resources from your findings. Currently, you can't use the Trusted Advisor console to exclude items from Security Hub controls. For more information, see Setting the workflow status for findings. • The organizational view feature supports this integration with Security Hub. You can view your findings for your Security Hub controls across your organization, and then create and download reports. For more information, see Organizational view for AWS Trusted Advisor. Example Example : Security Hub control for IAM user access key should not exist The following is an example finding for a Security Hub control in the Trusted Advisor console. Refresh your Security Hub findings After you enable a security standard, it can take up to two hours for Security Hub to have findings for your resources. It can then take up to 24 hours for that data to appear in the Trusted Advisor Refresh your Security Hub findings API Version 2025-05-13 77 AWS Support User Guide console. If you recently enabled the AWS Foundational Security Best Practices v1.0.0 security standard, check the Trusted Advisor console again later. Note • The refresh schedule for each Security Hub control is periodic or change triggered. Currently, you can't use the Trusted Advisor console or the AWS Support
|
support-ug-026
|
support-ug.pdf
| 26 |
After you enable a security standard, it can take up to two hours for Security Hub to have findings for your resources. It can then take up to 24 hours for that data to appear in the Trusted Advisor Refresh your Security Hub findings API Version 2025-05-13 77 AWS Support User Guide console. If you recently enabled the AWS Foundational Security Best Practices v1.0.0 security standard, check the Trusted Advisor console again later. Note • The refresh schedule for each Security Hub control is periodic or change triggered. Currently, you can't use the Trusted Advisor console or the AWS Support API to refresh your Security Hub controls. For more information, see Schedule for running security checks. • You must use Security Hub if you want to exclude resources from your findings. Currently, you can't use the Trusted Advisor console to exclude items from Security Hub controls. For more information, see Setting the workflow status for findings. Disable Security Hub from Trusted Advisor Follow this procedure if you don't want your Security Hub information to appear in the Trusted Advisor console. This procedure only disables the Security Hub integration with Trusted Advisor. It won't affect your configurations with Security Hub. You can continue to use the Security Hub console to view your security controls, resources, and recommendations. To disable the Security Hub integration 1. Contact AWS Support and request to disable the Security Hub integration with Trusted Advisor. After AWS Support disables this feature, Security Hub no longer sends data to Trusted Advisor. Your Security Hub data will be removed from Trusted Advisor. 2. If you want to enable this integration again, contact AWS Support. Disable this feature for AWS Organizations accounts If you already completed the previous procedure for a management account, Security Hub integration is automatically removed from all member accounts in your organization. Individual member accounts in your organization don't need to contact AWS Support separately. If you're a member account in an organization, you can contact Support to remove this feature from only your account. Disable Security Hub from Trusted Advisor API Version 2025-05-13 78 AWS Support Troubleshooting User Guide If you're having issues with this integration, see the following troubleshooting information. Contents • I don't see Security Hub findings in the Trusted Advisor console • I configured Security Hub and AWS Config correctly, but my findings are still missing • I want to disable specific Security Hub controls • I want to find my excluded Security Hub resources • I want to enable or disable this feature for a member account that belongs to an AWS organization • I see multiple AWS Regions for the same affected resource for a Security Hub check • I turned off Security Hub or AWS Config in a Region • My control is archived in Security Hub, but I still see the findings in Trusted Advisor • I still can't view my Security Hub findings I don't see Security Hub findings in the Trusted Advisor console Verify that you completed the following steps: • You have a Business, Enterprise On-Ramp, or Enterprise Support plan. • You enabled resource recording in AWS Config within the same Region as Security Hub. • You enabled Security Hub and selected the AWS Foundational Security Best Practices v1.0.0 security standard. • New controls from Security Hub are added as checks in Trusted Advisor within two to four weeks. See the note. For more information, see the Prerequisites. I configured Security Hub and AWS Config correctly, but my findings are still missing It can take up to two hours for Security Hub to have findings for your resources. It can then take up to 24 hours for that data to appear in the Trusted Advisor console. Check the Trusted Advisor console again later. Troubleshooting API Version 2025-05-13 79 AWS Support Notes User Guide • Only your findings for controls in the AWS Foundational Security Best Practices security standard will appear in Trusted Advisor except for controls that have the Category: Recover > Resilience. • If there's a service issue with Security Hub or Security Hub isn't available, it can take up to 24 hours for your findings to appear in Trusted Advisor. Check the Trusted Advisor console again later. I want to disable specific Security Hub controls Security Hub sends your data to Trusted Advisor automatically. If you disable a Security Hub control or no longer have resources for that control, your findings won't appear in Trusted Advisor. You can sign in to the Security Hub console and verify if your control is enabled or disabled. If you disable a Security Hub control or disable all controls for the AWS Foundational Security Best Practices security standard, your findings are archived within the next five days. This five-day period to archive is approximate and best effort only,
|
support-ug-027
|
support-ug.pdf
| 27 |
console again later. I want to disable specific Security Hub controls Security Hub sends your data to Trusted Advisor automatically. If you disable a Security Hub control or no longer have resources for that control, your findings won't appear in Trusted Advisor. You can sign in to the Security Hub console and verify if your control is enabled or disabled. If you disable a Security Hub control or disable all controls for the AWS Foundational Security Best Practices security standard, your findings are archived within the next five days. This five-day period to archive is approximate and best effort only, and isn't guaranteed. When your findings are archived, they are removed from Trusted Advisor. For more information, see the following topics: • Disabling and enabling individual controls • Disabling or enabling a security standard I want to find my excluded Security Hub resources From the Trusted Advisor console, you can choose your Security Hub control name, and then choose the Excluded items option. This option displays all resources that are suppressed in Security Hub. If the workflow status for a resource is set to SUPPRESSED, then that resource is an excluded item in Trusted Advisor. You can't suppress Security Hub resources from the Trusted Advisor console. To do so, use the Security Hub console. For more information, see Setting the workflow status for findings. Troubleshooting API Version 2025-05-13 80 AWS Support User Guide I want to enable or disable this feature for a member account that belongs to an AWS organization By default, member accounts inherit the feature from the management account for AWS Organizations. If the management account has enabled the feature, then all accounts in the organization will also have the feature. If you have a member account and want to make specific changes for your account, you must contact AWS Support. I see multiple AWS Regions for the same affected resource for a Security Hub check Some AWS services are global and aren't specific to a Region, such as IAM and Amazon CloudFront. By default, global resources such as Amazon S3 buckets appear in the US East (N. Virginia) Region. For Security Hub checks that evaluate resources for global services, you might see more than one item for affected resources. For example, if the Hardware MFA should be enabled for the root user check identifies that your account hasn't activated this feature, then you will see multiple Regions in the table for the same resource. You can configure Security Hub and AWS Config so that multiple Regions won't appear for the same resource. For more information, see AWS Foundational Best Practices controls that you might want to disable. I turned off Security Hub or AWS Config in a Region If you stop resource recording with AWS Config or disable Security Hub in an AWS Region, Trusted Advisor no longer receives data for any controls in that Region. Trusted Advisor removes your Security Hub findings within 7-9 days. This time frame is best effort and isn't guaranteed. For more information, see Disabling Security Hub. To disable this feature for your account, see Disable Security Hub from Trusted Advisor. My control is archived in Security Hub, but I still see the findings in Trusted Advisor When the RecordState status changes to ARCHIVED for a finding, Trusted Advisor deletes the finding for that Security Hub control from your account. You might still see the finding in Trusted Advisor for up to 7-9 days before it's deleted. This time frame is best effort and isn't guaranteed. Troubleshooting API Version 2025-05-13 81 AWS Support User Guide I still can't view my Security Hub findings If you still have issues with this feature, you can create a technical support case in the AWS Support Center. Opt in AWS Compute Optimizer for Trusted Advisor checks Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS resources. This service reports whether your resources are correctly configured for efficiency and reliability. It also suggests improvements you can implement to improve workload performance. With Compute Optimizer, you view the same recommendations in your Trusted Advisor checks. You can opt in either your AWS account only, or all member accounts that are part of an organization in AWS Organizations. For more information, see Getting started in the AWS Compute Optimizer User Guide. Once you opt in for Compute Optimizer, the following checks receive data from your Lambda functions and Amazon EBS volumes. It can take up to 12 hours to generate the findings and optimization recommendations. It can then take up to 48 hours to view your results in Trusted Advisor for the following checks: Cost optimization • Amazon EBS over-provisioned volumes • AWS Lambda over-provisioned functions for memory size Performance • Amazon EBS under-provisioned volumes • AWS Lambda under-provisioned functions for memory
|
support-ug-028
|
support-ug.pdf
| 28 |
of an organization in AWS Organizations. For more information, see Getting started in the AWS Compute Optimizer User Guide. Once you opt in for Compute Optimizer, the following checks receive data from your Lambda functions and Amazon EBS volumes. It can take up to 12 hours to generate the findings and optimization recommendations. It can then take up to 48 hours to view your results in Trusted Advisor for the following checks: Cost optimization • Amazon EBS over-provisioned volumes • AWS Lambda over-provisioned functions for memory size Performance • Amazon EBS under-provisioned volumes • AWS Lambda under-provisioned functions for memory size Notes • Results for these checks are automatically refreshed several times daily. Refresh requests are not allowed. It might take a few hours for changes to appear. Currently, you can’t exclude resources from these checks. Opt in AWS Compute Optimizer for Trusted Advisor checks API Version 2025-05-13 82 AWS Support User Guide • Trusted Advisor already has the Underutilized Amazon EBS Volumes and the Overutilized Amazon EBS Magnetic Volumes checks. Once you opt in with Compute Optimizer, we recommend that you use the new Amazon EBS over-provisioned volumes and Amazon EBS under-provisioned volumes checks instead. Related information For more information, see the following topics: • Viewing Amazon EBS volume recommendations in the AWS Compute Optimizer User Guide • Viewing Lambda function recommendations in the AWS Compute Optimizer User Guide • Configuring Lambda function memory in the AWS Lambda Developer Guide • Request modifications to your Amazon EBS volumes in the Amazon EC2 User Guide Get started with AWS Trusted Advisor Priority Trusted Advisor Priority helps you secure and optimize your AWS account to follow AWS best practices. With Trusted Advisor Priority, your AWS account team can proactively monitor your account and create prioritized recommendations when they identify opportunities for you. For example, your account team can identify if your AWS account root user lacks multi-factor authentication (MFA). Your account team can create a recommendation so that you can take immediate action on a check, such as MFA on Root Account. The recommendation appears as an active prioritized recommendation on the Trusted Advisor Priority page of the Trusted Advisor console. You then follow the recommendations to resolve it. Trusted Advisor Priority recommendations come from these two sources: • AWS services – Services such as Trusted Advisor, AWS Security Hub, and AWS Well-Architected automatically create recommendations. Your account team shares these recommendations with you so that those recommendations appear in Trusted Advisor Priority. • Your account team – Your account team can create manual recommendations. Related information API Version 2025-05-13 83 AWS Support User Guide Trusted Advisor Priority helps you focus on the most important recommendations. You and your account team can monitor the recommendation lifecycle, from the point when your account team shared the recommendation, up to the point when you acknowledge, resolve, or dismiss it. You can use Trusted Advisor Priority to find recommendations for all member accounts in your organization. Topics • Prerequisites • Enable Trusted Advisor Priority • View prioritized recommendations • Acknowledge a recommendation • Dismiss a recommendation • Resolve a recommendation • Reopen a recommendation • Download recommendation details • Register delegated administrators • Deregister delegated administrators • Manage Trusted Advisor Priority notifications • Disable Trusted Advisor Priority Prerequisites You must meet the following requirements to use Trusted Advisor Priority: • You must have an Enterprise Support plan. • Your account must be part of an organization that has enabled all features in AWS Organizations. For more information, see Enabling all features in your organization in the AWS Organizations User Guide. • Your organization must have enabled trusted access to Trusted Advisor. To enable trusted access, log in as the management account. Open the Your organization page in the Trusted Advisor console. • You must be signed in to your AWS account to view Trusted Advisor Priority recommendations for your account. Prerequisites API Version 2025-05-13 84 AWS Support User Guide • You must be signed in to the organization's management account or a delegated administrator account to view aggregated recommendations across your organization. For instructions on how to register delegated administrator accounts, see Register delegated administrators. • You must have AWS Identity and Access Management (IAM) permissions to access Trusted Advisor Priority. For information on how to control access to Trusted Advisor Priority, see Manage access to AWS Trusted Advisor and AWS managed policies for AWS Trusted Advisor. Enable Trusted Advisor Priority Ask your account team to enable this feature for you. You must have an Enterprise Support plan and be the management account owner for your organization. If the Trusted Advisor Priority page in the console says that you need trusted access with AWS Organizations, then choose Enable trusted access with AWS Organizations. For more information, see the Prerequisites section. View prioritized recommendations After
|
support-ug-029
|
support-ug.pdf
| 29 |
(IAM) permissions to access Trusted Advisor Priority. For information on how to control access to Trusted Advisor Priority, see Manage access to AWS Trusted Advisor and AWS managed policies for AWS Trusted Advisor. Enable Trusted Advisor Priority Ask your account team to enable this feature for you. You must have an Enterprise Support plan and be the management account owner for your organization. If the Trusted Advisor Priority page in the console says that you need trusted access with AWS Organizations, then choose Enable trusted access with AWS Organizations. For more information, see the Prerequisites section. View prioritized recommendations After your account team enables Trusted Advisor Priority for you, you can view the latest recommendations for your AWS account. To view your prioritized recommendations 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, you can view the following items: If you're using an AWS Organizations Management or Delegated Administrator account, then switch to the My Account tab. • Actions needed – The number of recommendations that are pending a response or are in progress. • Overview – The following information: • Dismissed recommendations in the last 90 days • Resolved recommendations in the last 90 days • Recommendations without an update in over 30 days • Average time to resolve recommendations Enable Trusted Advisor Priority API Version 2025-05-13 85 AWS Support User Guide 3. On the Active tab, the Active prioritized recommendations show recommendations that your account team prioritized for you. The Closed tab shows resolved or dismissed recommendations. • To filter your results, use the following options: • Recommendation – Enter keywords to search by name. This can be a check name, or a custom name that your account team created. • Status – Whether the recommendation is pending a response, in progress, dismissed, or resolved. • Source – The origin of a prioritized recommendation. The recommendation can come from AWS services, your AWS account team, or a planned service event. • Category – The recommendation category, such as security or cost optimization. • Age – When your account team shared the recommendation with you. 4. Choose a recommendation to learn more about its details, the affected resources, and the recommended actions. You can then acknowledge or dismiss the recommendation. To view prioritized recommendations across all accounts in your AWS organization Both the management account and the Trusted Advisor Priority delegated administrators can view recommendations aggregated across your organization. Note Member accounts don't have access to aggregated recommendations. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My Organization tab. 3. To view recommendations for one account, select an account from the Select an account from your organization dropdown list. Or, you can view recommendations across all your accounts. On the My Organization tab, you can view the following items: • Actions needed: The number of recommendations across your organization that are pending a response or are in progress. View prioritized recommendations API Version 2025-05-13 86 AWS Support User Guide • Overview: Shows the following items: - Dismissed recommendations in the last 90 days. - Resolved recommendations in the last 90 days. - Recommendations without an update in over 30 days. - The average time taken to resolve recommendations. 4. Under the Active tab, the Active prioritized recommendations section shows recommendations that your account team prioritized for you. The Closed tab shows resolved or dismissed recommendations. To filter your results, use the following options: • Recommendation – Enter keywords to search by name. This can be either a check name, or a custom name that your account team created. • Status – Whether the recommendation is pending a response, in progress, dismissed, or resolved. • Source – The origin of a prioritized recommendation. The recommendation can come from AWS services, your AWS account team, or a planned service event. • Category – The recommendation category, such as security or cost optimization. • Age – When your account team shared the recommendation with you. 5. Choose a recommendation to see additional details, affected accounts and resources, and the recommended actions. You can then acknowledge or dismiss the recommendation. Example : Trusted Advisor Priority recommendations The following example shows 15 recommendations that are pending a response and 27 recommendations that are in progress under the Action needed section. The following image shows two of the recommendations that are pending response in the Active prioritized recommendation tab. View prioritized recommendations API Version 2025-05-13 87 AWS Support User Guide Acknowledge a recommendation Under the Active tab, you can learn more about the recommendation and then decide if you want to acknowledge it. To acknowledge a recommendation 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. If
|
support-ug-030
|
support-ug.pdf
| 30 |
the recommendation. Example : Trusted Advisor Priority recommendations The following example shows 15 recommendations that are pending a response and 27 recommendations that are in progress under the Action needed section. The following image shows two of the recommendations that are pending response in the Active prioritized recommendation tab. View prioritized recommendations API Version 2025-05-13 87 AWS Support User Guide Acknowledge a recommendation Under the Active tab, you can learn more about the recommendation and then decide if you want to acknowledge it. To acknowledge a recommendation 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. If you're using an AWS Organizations Management or Delegated Administrator account, then switch to the My Account tab. 3. On the Trusted Advisor Priority page, under the Active tab, choose a recommendation name. 4. In the Details section, you can review the recommended actions to resolve the recommendation. 5. In the Affected resources section, you can review the affected resources and filter by Status. 6. Choose Acknowledge. 7. In the Acknowledge recommendation dialog box, choose Acknowledge. The recommendation status changes to In progress. Recommendations in progress or pending a response appear in the Active tab on the Trusted Advisor Priority page. 8. Follow the recommended actions to resolve the recommendation. For more information, see Resolve a recommendation. Acknowledge a recommendation API Version 2025-05-13 88 AWS Support User Guide Example : Manual recommendation from Trusted Advisor Priority The following image shows the Low Utilization EC2 Instances recommendation that is pending a response. To acknowledge a recommendation for all accounts in your AWS organization The management account or the Trusted Advisor delegated administrators can acknowledge a recommendation for all of the affected accounts. Note Member accounts don't have access to aggregated recommendations. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My organization tab. 3. In the Active tab, select a recommendation name. 4. Choose Acknowledge. 5. In the Acknowledge recommendation dialog box, choose Acknowledge. The recommendation status changes to In progress. Acknowledge a recommendation API Version 2025-05-13 89 AWS Support User Guide 6. Follow the recommended actions to resolve the recommendation. For more information, see Resolve a recommendation. 7. To view the recommendation details, choose the recommendation name. In the Details section, you can review the following information about the recommendation: • An Overview of the recommendation and a Details section covering the recommendation actions to complete. A Status summary that shows recommendations across all affected accounts. • In the Affected accounts section, you can review the affected resources across all your accounts. You can filter by Account number and Status. • In the Affected resources section, you can review the affected resources across all your accounts. You can filter by Account number and Status. Example : Manual recommendation from Trusted Advisor Priority The following image shows the Low Utilization Amazon EC2 Instances recommendation that's pending a response. One affected account has acknowledged the recommendation. Another account is pending a response, making the recommendation status Pending response. Acknowledge a recommendation API Version 2025-05-13 90 AWS Support User Guide Dismiss a recommendation You can also dismiss a recommendation. This means that you acknowledge the recommendation, but you won't address it. You can dismiss a recommendation if it's not relevant to your account. For example, if you have a test AWS account that you plan to delete, you don't need to follow the recommended actions. To dismiss a recommendation 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. If you're using an AWS Organizations Management or Delegated Administrator account, then switch to the My Account tab. 3. On the Trusted Advisor Priority page, under the Active tab, choose a recommendation name. 4. On the recommendation detail page, review the information about the affected resources. 5. 6. 7. If this recommendation doesn't apply for your account, choose Dismiss. In the Dismiss recommendation dialog box, select a reason why you won't address the recommendation. (Optional) Enter a note detailing why you're dismissing the recommendation. If you choose Other, you must enter a description in the Note section. 8. Choose Dismiss. The recommendation status changes to Dismissed and appears in the Closed tab on the Trusted Advisor Priority page. To dismiss a recommendation for all the accounts in your AWS organization The management account or the delgated administrator of Trusted Advisor Priority can dismiss a recommendation for all of their accounts. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My Organization tab. 3. 4. 5. In the Active tab, select a recommendation name. If this recommendation doesn't apply for your account, then choose Dismiss. In the Dismiss recommendation dialog box, select a reason
|
support-ug-031
|
support-ug.pdf
| 31 |
in the Closed tab on the Trusted Advisor Priority page. To dismiss a recommendation for all the accounts in your AWS organization The management account or the delgated administrator of Trusted Advisor Priority can dismiss a recommendation for all of their accounts. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My Organization tab. 3. 4. 5. In the Active tab, select a recommendation name. If this recommendation doesn't apply for your account, then choose Dismiss. In the Dismiss recommendation dialog box, select a reason why you won't address the recommendation. Dismiss a recommendation API Version 2025-05-13 91 AWS Support User Guide 6. (Optional) Enter a note detailing why you're dismissing the recommendation. If you choose Other, then you must enter a description in the Note section. 7. Choose Dismiss. The recommendation status changes to Dismissed. The recommendation appears in the Closed tab on the Trusted Advisor Priority page. Note You can choose the recommendation name and choose View note to find the reason for dismissal. If your account team dismissed the recommendation for you, their email address appears next to the note. Trusted Advisor Priority also notifies your account team that you dismissed the recommendation. Example : Dismiss a recommendation from Trusted Advisor Priority The following example shows how you can dismiss a recommendation. Dismiss a recommendation API Version 2025-05-13 92 AWS Support User Guide Resolve a recommendation After you acknowledge the recommendation and complete the recommended actions, you can resolve the recommendation. Tip After you resolve a recommendation, you can't reopen it. If you want to revisit the recommendation again later, see Dismiss a recommendation. To resolve a recommendation 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My Organization tab. 3. On the Trusted Advisor Priority page, select the recommendation, and then choose Resolve. 4. In the Resolve recommendation dialog box, choose Resolve. Resolved recommendations appear under the Closed tab on the Trusted Advisor Priority page. Trusted Advisor Priority notifies your account team that you resolved the recommendation. To resolve a recommendation for all accounts in your AWS organization The management account or the Trusted Advisor Priority delegated administrators can resolve a recommendation for all their accounts. Note Member accounts don't have access to aggregated recommendations. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. If you're using an AWS Organizations Management or Delegated Administrator account, switch to the My Account tab. 3. In the Active tab, select a recommendation name. Resolve a recommendation API Version 2025-05-13 93 AWS Support User Guide 4. 5. If the recommendation doesn't apply for your account, choose Resolve. In the Resolve recommendation dialog box, choose Resolve. Resolved recommendations appear under the Closed tab on the Trusted Advisor Priority page. Trusted Advisor Priority notifies your account team that you resolved the recommendation. Example : Manual recommendation from Trusted Advisor Priority The following example shows a resolved Low Utilization Amazon EC2 Instances recommendation. Reopen a recommendation After you dismiss a recommendation, you or your account team can reopen the recommendation. To reopen a recommendation 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. If you're using an AWS Organizations Management or Delegated Administrator account, then switch to the My Account tab. 3. On the Trusted Advisor Priority page, choose the Closed tab. 4. Under Closed recommendations, select a recommendation that was Dismissed, and then choose Reopen. 5. In the Reopen recommendation dialog box, describe why you're reopening the recommendation. 6. Choose Reopen. The recommendation status changes to In progress and appears under the Active tab. Reopen a recommendation API Version 2025-05-13 94 AWS Support Tip User Guide You can choose the recommendation name and then choose View note to find the reason for reopening. If your account team reopened the recommendation for you, their name appears next to the note. 7. Follow the steps in the recommendation details. To reopen a recommendation for all accounts in your AWS organization The management account or the Trusted Advisor Priority delegated administrators can reopen a recommendation for all of their accounts. Note Member accounts don't have access to aggregated recommendations. 1. Sign in to the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/ home. 2. On the Trusted Advisor Priority page, make sure that you're on the My Organization tab. 3. Under Closed recommendations, select a recommendation that was Dismissed, and then choose Reopen. 4. In the Reopen recommendation dialog box, describe why you're reopening the recommendation. 5. Choose Reopen. The recommendation status changes to In progress and appears under the Active tab. Tip You can choose the recommendation name and choose View note to find the reason for reopening. If your account
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.